Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetSummaryDataOptions

Options argument for the Worksheet.GetSummaryData API

Hierarchy

Index

Properties

Optional columnsToIncludeById

columnsToIncludeById: Array<string>

The columns to return specified by field id, returns all by default. Since 1.5.0, fieldId is a property of the Column object.

since

1.5.0

Optional ignoreAliases

ignoreAliases: undefined | false | true

Do not use aliases specified in the data source in Tableau. Default is false.

Optional ignoreSelection

ignoreSelection: undefined | false | true

Only return data for the currently selected marks. Default is false.

Optional includeDataValuesOption

includeDataValuesOption: IncludeDataValuesOption

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.

since

1.5.0

Optional maxRows

maxRows: undefined | number

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.

since

1.5.0 maxRows is now supported in both GetSummaryDataOptions and GetUnderlyingDataOptions.