Tableau Embedding API
    Preparing search index...

    Interface GetSummaryDataOptions

    Options argument for the Worksheet.GetSummaryDataAsync API

    interface GetSummaryDataOptions {
        applyWorksheetFormatting?: boolean;
        columnsToIncludeById?: string[];
        ignoreAliases?: boolean;
        ignoreSelection?: boolean;
        includeDataValuesOption?: IncludeDataValuesOption;
        maxRows?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    applyWorksheetFormatting? columnsToIncludeById? ignoreAliases? ignoreSelection? includeDataValuesOption? maxRows?

    Properties

    applyWorksheetFormatting?: boolean

    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

    columnsToIncludeById?: 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.

    ignoreAliases?: boolean

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

    ignoreSelection?: boolean

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

    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.

    maxRows?: 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.

    Settings

    Member Visibility

    On This Page

    Properties