---
schema_version: "1"
id: c945d03fed53e9bd37d5b1ba9f8ca39fa019804210cbd8d25b26f5cb72107ddd
title: GetSummaryDataOptions | Tableau Embedding API
collection: tableau
version: next
locale: en-us
portal_url: https://docs.salesforce.com/tableau/next/en-us/api/embedding_api/reference/interfaces/GetSummaryDataOptions.md
canonical_url: https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html
source_site: help.tableau.com
content_type: documentation
content_hash: efd06c2bd42c9c5bae405ae6668159fd74fb83902a8f6d04c1511310a778b2bd
description: Documentation for Tableau Embedding API
---
- GetSummaryDataOptions

# Interface GetSummaryDataOptions

Options argument for the Worksheet.GetSummaryDataAsync API

interface GetSummaryDataOptions {  
    [applyWorksheetFormatting](#applyworksheetformatting)?: boolean;  
    [columnsToIncludeById](#columnstoincludebyid)?: string\[\];  
    [ignoreAliases](#ignorealiases)?: boolean;  
    [ignoreSelection](#ignoreselection)?: boolean;  
    [includeDataValuesOption](#includedatavaluesoption)?: [IncludeDataValuesOption](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/IncludeDataValuesOption.html);  
    [maxRows](#maxrows)?: number;  
}

#### Hierarchy ([View Summary](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/hierarchy.html#GetSummaryDataOptions))

- GetSummaryDataOptions
    - [GetUnderlyingDataOptions](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetUnderlyingDataOptions.html)

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:132

##### Index

### Properties

[applyWorksheetFormatting?](#applyworksheetformatting) [columnsToIncludeById?](#columnstoincludebyid) [ignoreAliases?](#ignorealiases) [ignoreSelection?](#ignoreselection) [includeDataValuesOption?](#includedatavaluesoption) [maxRows?](#maxrows)

## Properties

### `Optional`applyWorksheetFormatting[](#applyworksheetformatting)

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

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:177

### `Optional`columnsToIncludeById[](#columnstoincludebyid)

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.

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:149

### `Optional`ignoreAliases[](#ignorealiases)

ignoreAliases?: boolean

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

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:136

### `Optional`ignoreSelection[](#ignoreselection)

ignoreSelection?: boolean

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

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:141

### `Optional`includeDataValuesOption[](#includedatavaluesoption)

includeDataValuesOption?: [IncludeDataValuesOption](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/IncludeDataValuesOption.html)

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.

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:169

### `Optional`maxRows[](#maxrows)

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.

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataTableInterfaces.ts:160

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

[applyWorksheetFormatting](#applyworksheetformatting)[columnsToIncludeById](#columnstoincludebyid)[ignoreAliases](#ignorealiases)[ignoreSelection](#ignoreselection)[includeDataValuesOption](#includedatavaluesoption)[maxRows](#maxrows)