---
schema_version: "1"
id: 26a4d5ceeb46262f14e422ca1bf69f286b2b8d8d8e12cd5e2d20aaf8967400d4
title: GetUnderlyingDataOptions | 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/GetUnderlyingDataOptions.md
canonical_url: https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetUnderlyingDataOptions.html
source_site: help.tableau.com
content_type: documentation
content_hash: 73101b7998caf05f956c7a8460c5b20ab9f4040413938008eb846a3bc2a8f9b9
description: Documentation for Tableau Embedding API
---
- GetUnderlyingDataOptions

# Interface GetUnderlyingDataOptions

Options argument for the Worksheet.getUnderlyingTableDataAsync API.

interface GetUnderlyingDataOptions {  
    [applyWorksheetFormatting](#applyworksheetformatting)?: boolean;  
    [columnsToIncludeById](#columnstoincludebyid)?: string\[\];  
    [ignoreAliases](#ignorealiases)?: boolean;  
    [ignoreSelection](#ignoreselection)?: boolean;  
    [includeAllColumns](#includeallcolumns)?: 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#GetUnderlyingDataOptions))

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

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

##### Index

### Properties

[applyWorksheetFormatting?](#applyworksheetformatting) [columnsToIncludeById?](#columnstoincludebyid) [ignoreAliases?](#ignorealiases) [ignoreSelection?](#ignoreselection) [includeAllColumns?](#includeallcolumns) [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

Inherited from [GetSummaryDataOptions](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html).[applyWorksheetFormatting](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html#applyworksheetformatting)

- 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.

Inherited from [GetSummaryDataOptions](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html).[columnsToIncludeById](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html#columnstoincludebyid)

- 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.

Inherited from [GetSummaryDataOptions](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html).[ignoreAliases](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html#ignorealiases)

- 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.

Inherited from [GetSummaryDataOptions](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html).[ignoreSelection](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html#ignoreselection)

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

### `Optional`includeAllColumns[](#includeallcolumns)

includeAllColumns?: boolean

Return all the columns for the data source. Default is false.

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

### `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.

Inherited from [GetSummaryDataOptions](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html).[includeDataValuesOption](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html#includedatavaluesoption)

- 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.

Inherited from [GetSummaryDataOptions](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html).[maxRows](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/GetSummaryDataOptions.html#maxrows)

- 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)[includeAllColumns](#includeallcolumns)[includeDataValuesOption](#includedatavaluesoption)[maxRows](#maxrows)