Edit

Share via

Excel.Interfaces.TableData interface

  • Reference
Package:
excel

An interface describing the data returned by calling table.toJSON().

Properties

columns

Represents a collection of all the columns in the table.
highlightFirstColumn

Specifies if the first column contains special formatting.
highlightLastColumn

Specifies if the last column contains special formatting.
id

Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed.
legacyId

Returns a numeric ID.
name

Name of the table.

The set name of the table must follow the guidelines specified in the Rename an Excel table article.
rows

Represents a collection of all the rows in the table.
showBandedColumns

Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.
showBandedRows

Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.
showFilterButton

Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row.
showHeaders

Specifies if the header row is visible. This value can be set to show or remove the header row.
showTotals

Specifies if the total row is visible. This value can be set to show or remove the total row.
sort

Represents the sorting for the table.
style

Constant value that represents the table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified.

Property Details

columns

Represents a collection of all the columns in the table.

columns?: Excel.Interfaces.TableColumnData[];

Property Value

Excel.Interfaces.TableColumnData[]

Remarks

[ API set: ExcelApi 1.1 ]

highlightFirstColumn

Specifies if the first column contains special formatting.

highlightFirstColumn?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

highlightLastColumn

Specifies if the last column contains special formatting.

highlightLastColumn?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

id

Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed.

id?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.1 ]

legacyId

Returns a numeric ID.

legacyId?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.8 ]

name

Name of the table.

The set name of the table must follow the guidelines specified in the Rename an Excel table article.

name?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.1 ]

rows

Represents a collection of all the rows in the table.

rows?: Excel.Interfaces.TableRowData[];

Property Value

Excel.Interfaces.TableRowData[]

Remarks

[ API set: ExcelApi 1.1 ]

showBandedColumns

Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.

showBandedColumns?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

showBandedRows

Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.

showBandedRows?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

showFilterButton

Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row.

showFilterButton?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

showHeaders

Specifies if the header row is visible. This value can be set to show or remove the header row.

showHeaders?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

showTotals

Specifies if the total row is visible. This value can be set to show or remove the total row.

showTotals?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

sort

Represents the sorting for the table.

sort?: Excel.Interfaces.TableSortData;

Property Value

Excel.Interfaces.TableSortData

Remarks

[ API set: ExcelApi 1.2 ]

style

Constant value that represents the table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified.

style?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.1 ]