Edit

Share via

Excel.TableFilteredEventArgs interface

  • Reference
Package:
excel

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.

Provides information about the table that raised the filter applied event.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

tableId

Gets the ID of the table in which the filter is applied.
type

Gets the type of the event. See Excel.EventType for details.
worksheetId

Gets the ID of the worksheet which contains the table.

Property Details

tableId

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.

Gets the ID of the table in which the filter is applied.

tableId: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

type

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.

Gets the type of the event. See Excel.EventType for details.

type: "TableFiltered";

Property Value

"TableFiltered"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

worksheetId

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.

Gets the ID of the worksheet which contains the table.

worksheetId: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]