Worksheet.getSummaryDataReaderAsync() returns incorrect columns.order metadata
Summary
When using Worksheet.getSummaryDataReaderAsync() in Tableau Embedding API v3, the columns object includes an order property intended to represent the column sequence. However, this property does not match the actual column order in the worksheet or the order returned by getSummaryDataAsync. This leads to misleading metadata for consumers expecting accurate column positioning.
Environment
API: Tableau Embedding API v3 (@tableau/embedding-api
Server: Tableau Server/Cloud
Methods:Worksheet.getSummaryDataReaderAsync() → DataTableReader
Steps to Reproduce
- Embed a view with a known column order (e.g., Category, Sales, Profit).
Call
const reader = await sheet.getSummaryDataReaderAsync();
const page = await reader.getPageAsync(0);
console.log(page.columns);
Compare columns.order values with:
- The actual column sequence in the worksheet
- The order returned by getSummaryDataAsync()
Observe mismatch
columns.order does not reflect the real column order.Expectedcolumns.order should accurately represent the column sequence as displayed in the worksheet or documented as undefined.
Actual
columns.order is incorrect and misleading.
Worksheet.getSummaryDataReaderAsync() returns incorrect columns.order metadata
Summary
When using Worksheet.getSummaryDataReaderAsync() in Tableau Embedding API v3, the columns object includes an order property intended to represent the column sequence. However, this property does not match the actual column order in the worksheet or the order returned by getSummaryDataAsync. This leads to misleading metadata for consumers expecting accurate column positioning.
Environment
API: Tableau Embedding API v3 (@tableau/embedding-api
Server: Tableau Server/Cloud
Methods:Worksheet.getSummaryDataReaderAsync() → DataTableReader
Steps to Reproduce
Call
Compare columns.order values with:
Observe mismatch
columns.order does not reflect the real column order.Expectedcolumns.order should accurately represent the column sequence as displayed in the worksheet or documented as undefined.
Actual
columns.order is incorrect and misleading.