Interface IAutoSort

Capabilities for applying and managing sorting on a range.

AutoSort enables dynamic sorting of data based on criteria specified per column, allowing users to organize and arrange information effectively.

Key features include:

Sorting one or more columns within a range.
Specifying sort order (ascending or descending) for each column.
Applying custom sort options (e.g., case sensitivity).
Clearing or modifying sort.

interface IAutoSort {
    apply(fields: Field[]): IAutoSort;
    clear(): IAutoSort;
    delete(): void;
    getFieldAt(offset: number): Criteria;
    getRange(): IRange.Coords;
    reapply(): IAutoSort;
    setFieldAt(offset: number, field: Criteria): IAutoSort;
    toJSON(): JSON;
}

Index

Methods

apply clear delete getFieldAt getRange reapply setFieldAt toJSON

Methods

apply

apply(fields: Field[]): IAutoSort
Set all field fields.
Parameters
- fields: Field[]
Returns IAutoSort

clear

clear(): IAutoSort
Remove the current sort.

Returns IAutoSort
Remarks
This is a convenience methods that does the same thing that setFields with an empty array does.

delete

delete(): void
Delete this sort.

Returns void

getFieldAt

getFieldAt(offset: number): Criteria
Returns the current fields or an empty array if nothing is sorted.
Parameters
- offset: number
Returns Criteria

getRange

getRange(): IRange.Coords
Returns the range that filter is applied to.

Returns IRange.Coords

reapply

reapply(): IAutoSort
Reapply sort to the fields.

Returns IAutoSort

setFieldAt

setFieldAt(offset: number, field: Criteria): IAutoSort
Updates the current sort fields.
Parameters
- offset: number
  Offset relative to the sort.
- field: Criteria
  The field to sort.
Returns IAutoSort

toJSON

toJSON(): JSON
Returns persistable state.

Returns JSON