Interface DataTable

Hierarchy

DataTable

Index

Properties

Properties

columns

columns: Array<Column>

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

data

data: Array<Array<DataValue>>

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

isSummaryData

isSummaryData: boolean

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

isTotalRowCountLimited

isTotalRowCountLimited: boolean

returns: True if the rows returned have been limited to the maximum number of retrievable rows for getUnderlyingDataAsync. (This value is currently set to 10,000.) A value of true indicates that the caller requested more rows than the current limit and the underlying data source contains more rows than can be returned. Note that if maxRows is unspecified (maxRows = 0), the call to getUnderlyingDataAsync requests all rows in the data source. The limit on the maximum number of rows returned does not apply to getSummaryDataAsync.

Optional marksInfo

marksInfo: Array<MarkInfo>

notimplemented
returns: An array of information about marks. Each mark in the array corresponds to a row in the data of this DataTable.

name

name: string

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

totalRowCount

totalRowCount: number

returns: The number of rows in the returned data.