Interface IAutoFilter

Capabilities for applying and managing filters.

AutoFilters enable dynamic filtering of data based on criteria specified per column, allowing users to quickly focus on relevant information.

Key features include:

Applying filters to specific columns within a range.
Defining filter criteria using various operators (e.g., equals, greater than, contains).
Hiding rows that don't match the filter criteria.
Clearing or modifying filters.

interface IAutoFilter {
    apply(fields: IndexedField[]): IAutoFilter;
    clear(): IAutoFilter;
    delete(): void;
    getCoords(): IRange.Coords;
    getFieldAt(offset: number): Field;
    getShowFilterButton(): boolean;
    getSort(): IAutoSort;
    insertSort(): IAutoSort;
    reapply(): IAutoFilter;
    setFieldAt(offset: number, field: Field): IAutoFilter;
    setShowFilterButton(show: boolean): IAutoFilter;
    toJSON(): JSON;
}

Index

Methods

apply clear delete getCoords getFieldAt getShowFilterButton getSort insertSort reapply setFieldAt setShowFilterButton toJSON

Methods

apply

apply(fields: IndexedField[]): IAutoFilter
Set all field fields.
Parameters
- fields: IndexedField[]
Returns IAutoFilter

clear

clear(): IAutoFilter
Remove both the filer and sort criteria but leave the range in place.

Returns IAutoFilter

delete

delete(): void
Delete this filter.

Returns void

getCoords

getCoords(): IRange.Coords
Returns the coords that filter is applied to.

Returns IRange.Coords
Remarks
Returns null if not enabled.

getFieldAt

getFieldAt(offset: number): Field
The criteria for the filer
Parameters
- offset: number
Returns Field

getShowFilterButton

getShowFilterButton(): boolean
Returns true unless any Field has hiddenButton set to true.

Returns boolean

getSort

getSort(): IAutoSort
Returns a sort for the filter. If the filter does not support sorting this should return null.

Returns IAutoSort

insertSort

insertSort(): IAutoSort
Only one sort per table is supported so this will return the same instance if it has already been created.

Returns IAutoSort

reapply

reapply(): IAutoFilter
Reapply criteria and sort to the range.

Returns IAutoFilter

setFieldAt

setFieldAt(offset: number, field: Field): IAutoFilter
Set the criteria at the given offset.
Parameters
- offset: number
- field: Field
Returns IAutoFilter
Remarks
Changing the filter will reapply.

setShowFilterButton

setShowFilterButton(show: boolean): IAutoFilter
If false sets all filterColumns to have a hiddenButton of true If true set hidden button to false
Parameters
- show: boolean
Returns IAutoFilter

toJSON

toJSON(): JSON
Save a persistable version of AutoFilter

Returns JSON