Function: column_getIsSorted()#

function column_getIsSorted<TFeatures, TData, TValue>(column): false | SortDirection;

function column_getIsSorted<TFeatures, TData, TValue>(column): false | SortDirection;

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

Reads this column's current sort direction.

The result is false when the column is not sorted, otherwise 'asc' or 'desc' based on the column's entry in state.sorting.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TValue#

TValue extends unknown = unknown

Parameters#

column#

Column_Internal<TFeatures, TData, TValue>

Returns#

false | SortDirection

Example#

const direction = column_getIsSorted(column)

const direction = column_getIsSorted(column)