Edit

Share via

Excel.Interfaces.TableUpdateData interface

  • Reference
Package:
excel

An interface for updating data on the Table object, for use in table.set({ ... }).

Properties

highlightFirstColumn

Specifies if the first column contains special formatting.
highlightLastColumn

Specifies if the last column contains special formatting.
name

Name of the table.

The set name of the table must follow the guidelines specified in the Rename an Excel table article.
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.
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.
tableStyle

The style applied to the table.

Property Details

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 ]

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 ]

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 ]

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 ]

tableStyle

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The style applied to the table.

tableStyle?: Excel.Interfaces.TableStyleUpdateData;

Property Value

Excel.Interfaces.TableStyleUpdateData

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]