Excel.Interfaces.TableLoadOptions interface
Represents an Excel table. To learn more about the table object model, read Work with tables using the Excel JavaScript API.
Remarks
Properties
| $all | Specifying |
| columns | Represents a collection of all the columns in the table. |
| 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. |
| 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. |
| 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. |
| 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. |
| worksheet | The worksheet containing the current table. |
Property Details
$all
Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
$all?: boolean;Property Value
boolean
columns
Represents a collection of all the columns in the table.
columns?: Excel.Interfaces.TableColumnCollectionLoadOptions;Property Value
Remarks
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?: 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?: boolean;Property Value
boolean
Remarks
rows
Represents a collection of all the rows in the table.
rows?: Excel.Interfaces.TableRowCollectionLoadOptions;Property Value
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
sort
Represents the sorting for the table.
sort?: Excel.Interfaces.TableSortLoadOptions;Property Value
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?: boolean;Property Value
boolean
Remarks
worksheet
The worksheet containing the current table.
worksheet?: Excel.Interfaces.WorksheetLoadOptions;