Column_RowSorting

Defined in: features/row-sorting/rowSortingFeature.types.ts:160

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Properties#

clearSorting#

clearSorting: () => void;

Defined in: features/row-sorting/rowSortingFeature.types.ts:167

Removes this column from the table's sorting state

Returns#

void

getAutoSortDir#

getAutoSortDir: () => SortDirection;

Defined in: features/row-sorting/rowSortingFeature.types.ts:171

Returns a sort direction automatically inferred based on the columns values.

Returns#

SortDirection

getAutoSortFn#

getAutoSortFn: () => SortFn<TFeatures, TData>;

Defined in: features/row-sorting/rowSortingFeature.types.ts:175

Returns a sorting function automatically inferred based on the columns values.

Returns#

SortFn<TFeatures, TData>

getCanMultiSort#

getCanMultiSort: () => boolean;

Defined in: features/row-sorting/rowSortingFeature.types.ts:179

Returns whether this column can be multi-sorted.

Returns#

boolean

getCanSort#

getCanSort: () => boolean;

Defined in: features/row-sorting/rowSortingFeature.types.ts:183

Returns whether this column can be sorted.

Returns#

boolean

getFirstSortDir#

getFirstSortDir: () => SortDirection;

Defined in: features/row-sorting/rowSortingFeature.types.ts:187

Returns the first direction that should be used when sorting this column.

Returns#

SortDirection

getIsSorted#

getIsSorted: () => false | SortDirection;

Defined in: features/row-sorting/rowSortingFeature.types.ts:191

Reads this column's current sort direction, or false when unsorted.

Returns#

false | SortDirection

getNextSortingOrder#

getNextSortingOrder: (multi?) => false | SortDirection;

Defined in: features/row-sorting/rowSortingFeature.types.ts:197

Returns the next sorting order. Pass multi to resolve the order for a multi-sort toggle, where enableMultiRemove governs whether the cycle can remove the sort.

Parameters#

multi?#

boolean

Returns#

false | SortDirection

getSortFn#

getSortFn: () => SortFn<TFeatures, TData>;

Defined in: features/row-sorting/rowSortingFeature.types.ts:205

Returns the resolved sorting function to be used for this column

Returns#

SortFn<TFeatures, TData>

getSortIndex#

getSortIndex: () => number;

Defined in: features/row-sorting/rowSortingFeature.types.ts:201

Finds this column's position in the ordered sorting state.

Returns#

number

getToggleSortingHandler#

getToggleSortingHandler: () => ((event) => void) | undefined;

Defined in: features/row-sorting/rowSortingFeature.types.ts:209

Creates a header/control handler that toggles this column's sorting state.

Returns#

((event) => void) | undefined

toggleSorting#

toggleSorting: (desc?, isMulti?) => void;

Defined in: features/row-sorting/rowSortingFeature.types.ts:213

Toggles this column's sorting state. If desc is provided, it will force the sort direction to that value. If isMulti is provided, it will additively multi-sort the column (or toggle it if it is already sorted).

Parameters#

desc?#

boolean

isMulti?#

boolean

Returns#

void