---
schema_version: "1"
id: 38afd4d58382a39aaadba8f1433345ec238613ea5db492929d4683ab11d369ca
title: DataTable | Tableau Embedding API
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/api/embedding_api/reference/interfaces/DataTable.md
canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/DataTable.html
source_site: help.tableau.com
content_type: documentation
content_hash: b1cf45e556d44c826ea651f0ace3e35fd9d1770746e8904ea79d69d706107941
description: Documentation for Tableau Embedding API
---
- DataTable

# Interface DataTable

interface DataTable {  
    [columns](#columns): [Column](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Column.html)\[\];  
    [data](#data): [DataValue](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/DataValue.html)\[\]\[\];  
    [isSummaryData](#issummarydata)?: boolean;  
    [isTotalRowCountLimited](#istotalrowcountlimited)?: boolean;  
    [marksInfo](#marksinfo)?: [MarkInfo](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/MarkInfo.html)\[\];  
    [name](#name): string;  
    [totalRowCount](#totalrowcount): number;  
}

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

##### Index

### Properties

[columns](#columns) [data](#data) [isSummaryData?](#issummarydata) [isTotalRowCountLimited?](#istotalrowcountlimited) [marksInfo?](#marksinfo) [name](#name) [totalRowCount](#totalrowcount)

## Properties

### `Readonly`columns[](#columns)

columns: [Column](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Column.html)\[\]

#### Returns[](#returns)

The column information, including the name, data type, and index..

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

### `Readonly`data[](#data)

data: [DataValue](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/DataValue.html)\[\]\[\]

#### Returns[](#returns-1)

A two-dimensional array of data without the sheet or column metadata. The first array index is the row index and the second array index is the column index.

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

### `Optional` `Readonly`isSummaryData[](#issummarydata)

isSummaryData?: boolean

#### Returns[](#returns-2)

Whether the data is summary data or underlying data. Returns true for summary data.

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

### `Optional` `Readonly`isTotalRowCountLimited[](#istotalrowcountlimited)

isTotalRowCountLimited?: boolean

#### Returns[](#returns-3)

True if the rows returned have been limited to the maximum number of retrievable rows. A value of true indicates that the caller requested more rows than the limit and the underlying data source contains more rows than can be returned. isTotalRowCountLimited can be true in the case of ... `getAllPagesAsync` with more than 4,000,000 rows in the summary or underlying data. `getLogicalTableDataAsync` or `getUnderlyingTableDataAsync` with more than 10,000 rows in the data. In all these cases, limits can be avoided by processing the data in page sized chunks with `DataTableReader`. isTotalRowCountLimited is always false in the results of DataTableReader.getPageAsync().

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

### `Optional` `Readonly`marksInfo[](#marksinfo)

marksInfo?: [MarkInfo](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/MarkInfo.html)\[\]

#### Returns[](#returns-4)

An array of information about marks. Each mark in the array corresponds to a row in the data of this DataTable. MarkInfo is currently only partially available within results from getSelectedMarksAsync / getMarksAsync.

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

### `Readonly`name[](#name)

name: string

#### Returns[](#returns-5)

Either "Underlying Data Table" or "Summary Data Table".

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

### `Readonly`totalRowCount[](#totalrowcount)

totalRowCount: number

#### Returns[](#returns-6)

The number of rows in the returned data.

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

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

[columns](#columns)[data](#data)[isSummaryData](#issummarydata)[isTotalRowCountLimited](#istotalrowcountlimited)[marksInfo](#marksinfo)[name](#name)[totalRowCount](#totalrowcount)