Interface FilterChangedEvent

An event which is related to a particular Worksheet in the workbook.

interface FilterChangedEvent {
    fieldName: string;
    sheet: Sheet;
    worksheet: Worksheet;
    getFilterAsync(): Promise<Filter>;
}

Hierarchy (View Summary)

TableauWorksheetEvent
- FilterChangedEvent

Index

Methods

Properties

fieldName sheet worksheet

Methods

getFilterAsync

getFilterAsync(): Promise<Filter>
Returns Promise<Filter>
The Filter object associated with the event.
- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/EventInterfaces.ts:93

Properties

`Readonly`fieldName

fieldName: string

Returns

The name of the field being filtered.

`Readonly`sheet

sheet: Sheet

Returns

The sheet which was the source of this event.

`Readonly`worksheet

worksheet: Worksheet

Returns

The worksheet which was the source of this event.