SortApi

Provides API functions for interacting with grid sorts.

Properties

Name
disableSortOnMultipleColumns
Type
() => void
Description
Disables sorting on multiple columns in the grid.
Name
enableSortOnMultipleColumns
Type
() => void
Description
Enables sorting on multiple columns in the grid.
Name
getPivotColumnSortModel
Type
() => ColumnSort[]
Description
Returns the current pivot column sort model applied.
Name
getSortModel
Type
() => ColumnSort[]
Description
Returns the current sort model applied to the grid.
Name
isSortOnMultipleColumnsEnabled
Type
() => boolean
Description
Returns true if sorting on multiple columns is enabled.
Name
setPivotColumnSortModel
Type
(newModel: ColumnSort[]) => void
Description
Applies a new sort model for pivot columns. This model is used when pivot mode is on. These values must satisfy two constraints:
- The columnId must correspond to a pivot column known to the grid.
- The ColumnDefinition must have a valid value set for the ColumnDefinition.sortComparator property.
Any values that do not meet these criteria are filtered out before applying the sort model.
Name
setSortModel
Type
(newModel: ColumnSort[]) => void
Description
Applies a new sort model to the grid. The sort model is an array of ColumnSort values. These values must satisfy two constraints:
- The columnId must correspond to a column known to the grid.
- The ColumnDefinition must have a valid value set for the ColumnDefinition.sortComparator property.
Any values that do not meet these criteria are filtered out before applying the sort model.
Name
toggleSortOnMultipleColumns
Type
() => void
Description
Toggles sorting on multiple columns in the grid. If true, sets it to false, and vice versa.