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

TFeatures extends TableFeatures

TData extends RowData

clearSorting: () => void;

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

Removes this column from the table's sorting state

void

getAutoSortDir: () => SortDirection;

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

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

SortDirection

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

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

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

SortFn<TFeatures, TData>

getCanMultiSort: () => boolean;

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

Returns whether this column can be multi-sorted.

boolean

getCanSort: () => boolean;

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

Returns whether this column can be sorted.

boolean

getFirstSortDir: () => SortDirection;

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

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

SortDirection

getIsSorted: () => false | SortDirection;

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

Returns the current sort direction of this column.

false | SortDirection

getNextSortingOrder: () => false | SortDirection;

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

Returns the next sorting order.

false | SortDirection

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

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

Returns the resolved sorting function to be used for this column

SortFn<TFeatures, TData>

getSortIndex: () => number;

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

Returns the index position of this column's sorting within the sorting state

number

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

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

Returns a function that can be used to toggle this column's sorting state. This is useful for attaching a click handler to the column header.

(event) => void | undefined

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

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

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

boolean

boolean

void