Interface GetUnderlyingDataOptions
applyWorksheetFormatting?: boolean;
columnsToIncludeById?: string[];
ignoreAliases?: boolean;
ignoreSelection?: boolean;
includeAllColumns?: boolean;
includeDataValuesOption?: IncludeDataValuesOption;
maxRows?: number;
}
Hierarchy (View Summary)
- GetSummaryDataOptions
- GetUnderlyingDataOptions
Properties
OptionalapplyWorksheetFormatting
Specifies whether to apply worksheet level formatting to numbers and dates Note that this is different from the global field formatting degined in the Schema Viewer
OptionalcolumnsToIncludeById
The columns to return specified by field id, returns all by default. Since 1.5.0, fieldId is a property of the Column object.
OptionalignoreAliases
Do not use aliases specified in the data source in Tableau. Default is false.
OptionalignoreSelection
Only return data for the currently selected marks. Default is false.
OptionalincludeAllColumns
Return all the columns for the data source. Default is false.
OptionalincludeDataValuesOption
Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues.
All properties not requested will be undefined in the DataValue results.
This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.
OptionalmaxRows
The number of rows of data that you want to return. A value of 0 will attempt to return all rows.
0 is the default if maxRows is not specified.
getUnderlyingTableDataAsync - maximum number of rows returned is capped at 10,000 regardless of maxRows.
getSummaryDataAsync - maximum number of rows returned is not capped, but performance may suffer with large row counts.
Options argument for the Worksheet.getUnderlyingTableDataAsync API.