Excel.Table class

Represents the AutoFilter object of the table.

readonly autoFilter: Excel.AutoFilter;

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

Represents a collection of all the columns in the table.

readonly columns: Excel.TableColumnCollection;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Specifies if the first column contains special formatting.

highlightFirstColumn: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.3 ]

Specifies if the last column contains special formatting.

highlightLastColumn: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.3 ]

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.

readonly id: string;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

Returns a numeric ID.

readonly legacyId: string;

Property Value

Remarks

[ API set: ExcelApi 1.8 ]

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

Remarks

[ API set: ExcelApi 1.1 ]

Represents a collection of all the rows in the table.

readonly rows: Excel.TableRowCollection;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

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

Remarks

[ API set: ExcelApi 1.3 ]

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

Remarks

[ API set: ExcelApi 1.3 ]

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

Remarks

[ API set: ExcelApi 1.3 ]

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

showHeaders: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

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

showTotals: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

Represents the sorting for the table.

readonly sort: Excel.TableSort;

Property Value

Remarks

[ API set: ExcelApi 1.2 ]

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

Remarks

[ API set: ExcelApi 1.1 ]

Examples

// Set table style.
await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.name = 'Table1-Renamed';
    table.showTotals = false;
    table.style = 'TableStyleMedium2';
    table.load('tableStyle');
    await context.sync();
    
    console.log(table.style);
});

The worksheet containing the current table.

readonly worksheet: Excel.Worksheet;

Property Value

Remarks

[ API set: ExcelApi 1.2 ]

Clears all the filters currently applied on the table.

clearFilters(): void;

Returns

Remarks

[ API set: ExcelApi 1.2 ]

Converts the table into a normal range of cells. All data is preserved.

convertToRange(): Excel.Range;

Returns

Remarks

[ API set: ExcelApi 1.2 ]

Examples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.convertToRange();
    await context.sync(); 
});

Deletes the table.

delete(): void;

Returns

Remarks

[ API set: ExcelApi 1.1 ]

Examples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.delete();
    await context.sync(); 
});

Gets the range object associated with the data body of the table.

getDataBodyRange(): Excel.Range;

Returns

Remarks

[ API set: ExcelApi 1.1 ]

Examples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableDataRange = table.getDataBodyRange();
    tableDataRange.load('address')
    await context.sync();
    
    console.log(tableDataRange.address);
});

Gets the range object associated with the header row of the table.

getHeaderRowRange(): Excel.Range;

Returns

Remarks

[ API set: ExcelApi 1.1 ]

Examples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableHeaderRange = table.getHeaderRowRange();
    tableHeaderRange.load('address');
    await context.sync();

    console.log(tableHeaderRange.address);
});

Gets the range object associated with the entire table.

getRange(): Excel.Range;

Returns

Remarks

[ API set: ExcelApi 1.1 ]

Examples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableRange = table.getRange();
    tableRange.load('address');    
    await context.sync();
    
    console.log(tableRange.address);
});

Gets the range object associated with the totals row of the table.

getTotalRowRange(): Excel.Range;

Returns

Remarks

[ API set: ExcelApi 1.1 ]

Examples

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableTotalsRange = table.getTotalRowRange();
    tableTotalsRange.load('address');    
    await context.sync();
    
    console.log(tableTotalsRange.address);
});

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Excel.Interfaces.TableLoadOptions): Excel.Table;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.Table;

Parameters

Returns

Examples

// Get a table by name.
await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.load('id')
    await context.sync();
    
    console.log(table.id);
});

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Table;

Parameters

Returns

Reapplies all the filters currently on the table.

reapplyFilters(): void;

Returns

Remarks

[ API set: ExcelApi 1.2 ]

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Table): void;

Parameters

Returns

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Table object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TableData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.TableData;

Returns

Occurs when data in cells changes on a specific table.

readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;

Event Type

Remarks

[ API set: ExcelApi 1.7 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml

await Excel.run(async (context) => {
    let table = context.workbook.tables.getItemAt(0);
    table.onChanged.add(onChange);

    await context.sync();
    console.log("A handler has been registered for the onChanged event");
});

Occurs when the selection changes on a specific table.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.TableSelectionChangedEventArgs>;

Event Type

Remarks

[ API set: ExcelApi 1.7 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml

await Excel.run(async (context) => {
    let table = context.workbook.tables.getItemAt(0);
    table.onSelectionChanged.add(onSelectionChange);

    await context.sync();
    console.log("A handler has been registered for table onSelectionChanged event");
});