column_toggleSorting

function column_toggleSorting<TFeatures, TData, TValue>(
   column,
   desc?,
   multi?): void;

Defined in: features/row-sorting/rowSortingFeature.utils.ts:254

Applies the next sorting state for this column.

The toggle can add, replace, flip, or remove this column's sort entry. Multi sorting respects enableMultiSort, enableMultiRemove, maxMultiSortColCount, and the multi argument.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue extends unknown = unknown

Parameters

column

Column_Internal<TFeatures, TData, TValue>

desc?

boolean

multi?

boolean

Returns

void

Example

column_toggleSorting(column, undefined, true)