TableOptions_RowSorting

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

Properties#

autoResetSorting?#

optional autoResetSorting?: boolean;

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

Resets sorting to its initial state when the data option changes.

This is disabled by default. autoResetAll overrides this option when it is explicitly set.

enableMultiRemove?#

optional enableMultiRemove?: boolean;

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

Allows multi-sort toggles to remove a column from sorting state.

enableMultiSort?#

optional enableMultiSort?: boolean;

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

Enables/Disables multi-sorting for the table.

enableSorting?#

optional enableSorting?: boolean;

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

Enables/Disables sorting for the table.

enableSortingRemoval?#

optional enableSortingRemoval?: boolean;

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

Enables/Disables the ability to remove sorting for the table.

• If true then changing sort order will cycle like: 'none' -> 'desc' -> 'asc' -> 'none' -> ...
• If false then changing sort order will cycle like: 'none' -> 'desc' -> 'asc' -> 'desc' -> 'asc' -> ...

isMultiSortEvent?#

optional isMultiSortEvent?: (e) => boolean;

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

Pass a custom function that will be used to determine if a multi-sort event should be triggered. It is passed the event from the sort toggle handler and should return true if the event should trigger a multi-sort.

Parameters#

e#

unknown

Returns#

boolean

manualSorting?#

optional manualSorting?: boolean;

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

Enables manual sorting for the table. If this is true, you will be expected to sort your data before it is passed to the table. This is useful if you are doing server-side sorting.

maxMultiSortColCount?#

optional maxMultiSortColCount?: number;

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

Set a maximum number of columns that can be multi-sorted.

onSortingChange?#

optional onSortingChange?: OnChangeFn<SortingState>;

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

Called with an updater when sorting state changes. Pair this with state.sorting when using external state; external atoms can own the slice without this callback.

sortDescFirst?#

optional sortDescFirst?: boolean;

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

If true, all sorts will default to descending as their first toggle state.