Type alias: SortProvidedProps

type SortProvidedProps: object;

Provides initial sort properties to apply to the grid. The sortModel must satisfy two constraints:

The columnId must be known to the grid.
The ColumnDefinition must have a value set for the ColumnDefinition.sortComparator property.

Any sort model values that do not satisfy these constraints will be filtered out before applying the measure model to the grid state.

Type declaration

Member Type Description

Member	Type	Description
`pivotColumnSortModel`	`ColumnSort`[]	The initial pivot column sort model to apply to the grid. This model is used for sorting pivot columns and takes effect when pivot mode is on. Each sort item must have a `columnId` known to the grid, and the corresponding column must have a ColumnDefinition.sortComparator value. Caution Pivot column definitions may be fetched asynchronously. In such cases, validation of the pivotColumnSortModel is delayed until pivot column definitions resolve. The grid will safely render sorted columns correctly, but users reading this value should be cautious if pivot columns are loaded asynchronously.
`sortModel`	`ColumnSort`[]	The initial sort model to apply to the grid. Each sort item must have a `columnId` that is known to the grid, and the corresponding column must have a ColumnDefinition.sortComparator value.
`sortMultipleColumnsEnabled`	`boolean`	Indicates if sorting on multiple columns simultaneously within the grid is enabled. Defaults to false.

pivotColumnSortModel

ColumnSort[]

The initial pivot column sort model to apply to the grid. This model is used for sorting pivot columns and takes effect when pivot mode is on. Each sort item must have a columnId known to the grid, and the corresponding column must have a ColumnDefinition.sortComparator value.

Caution

Pivot column definitions may be fetched asynchronously. In such cases, validation of the pivotColumnSortModel is delayed until pivot column definitions resolve. The grid will safely render sorted columns correctly, but users reading this value should be cautious if pivot columns are loaded asynchronously.

sortModel ColumnSort[] The initial sort model to apply to the grid. Each sort item must have a columnId that is known to the grid, and the corresponding column must have a ColumnDefinition.sortComparator value.

sortMultipleColumnsEnabled boolean Indicates if sorting on multiple columns simultaneously within the grid is enabled. Defaults to false.