Excel.Interfaces.TableUpdateData interface
An interface for updating data on the Table object, for use in table.set({ ... }).
Properties
| alt |
Specifies the alternative text for accessibility. |
| alt |
Specifies a summary for the table, such as one used by screen readers. |
| comment | Specifies a comment associated with the table. |
| highlight |
Specifies if the first column contains special formatting. |
| highlight |
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. |
| show |
Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier. |
| show |
Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier. |
| show |
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. |
| show |
Specifies if the header row is visible. This value can be set to show or remove the header row. |
| show |
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. |
| table |
The style applied to the table. |
Property Details
altTextDescription
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.
Specifies the alternative text for accessibility.
altTextDescription?: string;
Property Value
string
Remarks
altTextTitle
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.
Specifies a summary for the table, such as one used by screen readers.
altTextTitle?: string;
Property Value
string
Remarks
comment
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.
Specifies a comment associated with the table.
comment?: string;
Property Value
string
Remarks
highlightFirstColumn
Specifies if the first column contains special formatting.
highlightFirstColumn?: boolean;
Property Value
boolean
Remarks
highlightLastColumn
Specifies if the last column contains special formatting.
highlightLastColumn?: boolean;
Property Value
boolean
Remarks
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
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
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
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
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
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
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
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;