React Tree Grid Sorting

The Ignite UI for React Data Sorting feature in React Tree Grid is enabled on a per-column level, meaning that the IgrTreeGrid can have a mix of sortable and non-sortable columns. Performing React sort actions enables you to change the display order of the records based on specified criteria.

React Tree Grid Sorting Overview Example

This is done via the sortable input. With the IgrTreeGrid sorting, you can also set the sortingIgnoreCase property to perform case sensitive sorting:

<IgrColumn field="ProductName" header="Product Name" dataType="string" sortable={true}></IgrColumn>

Sorting Indicators

Tener una cierta cantidad de columnas ordenadas puede resultar realmente confuso si no hay ninguna indicación del orden de clasificación.

The IgrTreeGrid provides a solution for this problem by indicating the index of each sorted column.

Sorting through the API

You can sort any column or a combination of columns through the IgrTreeGrid API using the IgrTreeGrid sort method:

import { SortingDirection } from "igniteui-react-grids";

// Perform a case insensitive ascending sort on the Category column.
treeGridRef.current.sort([{ fieldName: 'Category', dir: SortingDirection.Asc, ignoreCase: true }]);

// Perform sorting on both the Category and Price columns.
treeGridRef.current.sort([
    { fieldName: 'Category', dir: SortingDirection.Asc, ignoreCase: true },
    { fieldName: 'Price', dir: SortingDirection.Desc }
]);

[!Note] Sorting is performed using our DefaultSortingStrategy algorithm. Any IgrColumn or ISortingExpression can use a custom implementation of the ISortingStrategy as a substitute algorithm. This is useful when custom sorting needs to be defined for complex template columns, or image columns, for example.

As with the filtering behavior, you can clear the sorting state by using the clearSort method:

// Removes the sorting state from the Category column
treeGridRef.current.clearSort('Category');

// Removes the sorting state from every column in the Tree Grid
treeGridRef.current.clearSort();

[!Note] The sortStrategy of the IgrTreeGrid is of different type compared to the sortStrategy of the IgrColumn, since they work in different scopes and expose different parameters.

[!Note] The sorting operation DOES NOT change the underlying data source of the IgrTreeGrid.

Initial Sorting State

It is possible to set the initial sorting state of the IgrTreeGrid by passing an array of sorting expressions to the sortingExpressions property of the IgrTreeGrid.

const sortingExpressions: IgrSortingExpression[] = [
    { fieldName: 'Category', dir: SortingDirection.Asc, ignoreCase: true },
    { fieldName: 'Price', dir: SortingDirection.Desc }
];

<IgrTreeGrid
    data={productSales}
    sortingExpressions={sortingExpressions}>
</IgrTreeGrid>

[!Note] If values of type string are used by a column of dataType Date, the IgrTreeGrid won't parse them to Date objects and using IgrTreeGrid Sorting won't work as expected. If you want to use string objects, additional logic should be implemented on an application level, in order to parse the values to Date objects.

Sorting Indicators Templates

El icono del indicador de clasificación en el encabezado de la columna se puede personalizar mediante una plantilla. Las siguientes propiedades están disponibles para crear plantillas del indicador de clasificación para cualquier estado de clasificación (ascendente, descendente, ninguno):

sortHeaderIconTemplate – re-templates the sorting icon when no sorting is applied.

const sortHeaderIconTemplate = (ctx: IgrGridHeaderTemplateContext) => {
    return (
        <>
            <IgrIcon name='unfold_more'></IgrIcon>
        </>
    );
}

<IgrTreeGrid sortHeaderIconTemplate={sortHeaderIconTemplate}></IgrTreeGrid>

sortAscendingHeaderIconTemplate – re-templates the sorting icon when the column is sorted in ascending order.

const sortAscendingHeaderIconTemplate = (ctx: IgrGridHeaderTemplateContext) => {
    return (
        <>
            <IgrIcon name='expand_less'></IgrIcon>
        </>
    );
}

<IgrTreeGrid sortAscendingHeaderIconTemplate={sortAscendingHeaderIconTemplate}></IgrTreeGrid>

sortDescendingHeaderIconTemplate – re-templates the sorting icon when the column is sorted in descending order.

const sortDescendingHeaderIconTemplate = (ctx: IgrGridHeaderTemplateContext) => {
    return (
        <>
            <IgrIcon name='expand_more'></IgrIcon>
        </>
    );
}

<IgrTreeGrid sortDescendingHeaderIconTemplate={sortDescendingHeaderIconTemplate}></IgrTreeGrid>

Styling

Además de los temas predefinidos, la cuadrícula se puede personalizar aún más configurando algunas de las propiedades CSS disponibles. En caso de que desee cambiar algunos de los colores, primero debe establecer una clase para la cuadrícula:

<IgrTreeGrid className="grid">
</IgrTreeGrid>

Luego establezca las propiedades CSS relacionadas con esta clase:

.grid {
    --ig-grid-sorted-header-icon-color: #ffb06a;
    --ig-grid-sortable-header-icon-hover-color: black;
}

React Tree Grid Sorting