Interface Filter

An abstract base class for all of the filter types.

interface Filter {
    fieldId: string;
    fieldName: string;
    filterType: FilterType;
    worksheetName: string;
    getAppliedWorksheetsAsync(): Promise<string[]>;
    getFieldAsync(): Promise<Field>;
    setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
}

Hierarchy (View Summary)

Filter

Index

Methods

getAppliedWorksheetsAsync getFieldAsync setAppliedWorksheetsAsync

Properties

fieldId fieldName filterType worksheetName

Methods

getAppliedWorksheetsAsync

getAppliedWorksheetsAsync(): Promise<string[]>
Returns Promise<string[]>
the list of worksheet names that have the filter applied.
- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:49

getFieldAsync

getFieldAsync(): Promise<Field>
Returns Promise<Field>
a promise containing the field for the filter.
- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:43

setAppliedWorksheetsAsync

setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>
Applies the filter to the specified list of worksheets. If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.
Parameters
- applyToWorksheets: string[]
  list of worksheets to apply the filter on
Returns Promise<string[]>
the list of worksheet names that have the filter applied
- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:59

Properties

`Readonly`fieldId

fieldId: string

Returns

The id of the field being filtered.

`Readonly`fieldName

fieldName: string

Returns

The name of the field being filtered. Note that this is the caption as shown in the UI, and not the actual database field name.

`Readonly`filterType

filterType: FilterType

Returns

The type of the filter.

`Readonly`worksheetName

worksheetName: string

Returns

The parent worksheet.