In Ignite UI for Angular Hierarchical Grid, data sorting is enabled on a per-column level, meaning that the igx-hierarchical-grid can have a mix of sortable and non-sortable columns. Performing angular sort actions enables you to change the display order of the records based on specified criteria.
Up until now, grouping/sorting worked in conjunction with each other. In 13.2 version, a new behavior which decouples grouping from sorting is introduced. For example - clearing the grouping will not clear sorting expressions in the grid or vice versa. Still, if a column is both sorted and grouped, grouped expressions take precedence.
Angular Hierarchical Grid Sorting Overview Example
Additionally there is a custom context menu added for sorting using igx-hierarchical-grid's contextMenu Output.
This is done via the sortable input. With the Hierarchical Grid sorting, you can also set the sortingIgnoreCase property to perform case sensitive sorting:
Having a certain amount of sorted columns could be really confusing if there is no indication of the sorted order.
The IgxHierarchicalGrid 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 Hierarchical Grid API using the Hierarchical Grid sort method:
import { SortingDirection } from'igniteui-angular';
// import { SortingDirection } from '@infragistics/igniteui-angular'; for licensed package// Perform a case insensitive ascending sort on the ProductName column.this.hierarchicalGrid.sort({ fieldName: 'ProductName', dir: SortingDirection.Asc, ignoreCase: true });
// Perform sorting on both the ProductName and Price columns.this.hierarchicalGrid.sort([
{ fieldName: 'ProductName', dir: SortingDirection.Asc, ignoreCase: true },
{ fieldName: 'Price', dir: SortingDirection.Desc }
]);
typescript
Sorting is performed using our DefaultSortingStrategy algorithm. Any IgxColumnComponent 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 ProductName columnthis.hierarchicalGrid.clearSort('ProductName');
// Removes the sorting state from every column in the Hierarchical Gridthis.hierarchicalGrid.clearSort();
typescript
The sortStrategy of the Hierarchical Grid is of different type compared to the sortStrategy of the column, since they work in different scopes and expose different parameters.
The sorting operation DOES NOT change the underlying data source of the Hierarchical Grid.
Initial sorting state
It is possible to set the initial sorting state of the Hierarchical Grid by passing an array of sorting expressions to the sortingExpressions property of the Hierarchical Grid.
If values of type string are used by a column of dataTypeDate, the Hierarchical Grid won't parse them to Date objects and using Hierarchical Grid 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
The sorting indicator icon in the column header can be customized using a template. The following directives are available for templating the sorting indicator for any sorting state (ascending, descending, none):
IgxSortHeaderIconDirective – re-templates the sorting icon when no sorting is applied.
To get started with styling the sorting behavior, we need to import the index file, where all the theme functions and component mixins live:
@use"igniteui-angular/theming" as *;
// IMPORTANT: Prior to Ignite UI for Angular version 13 use:// @import '~igniteui-angular/lib/core/styles/themes/index';scss
Following the simplest approach, we create a new theme that extends the grid-theme and accepts the $sorted-header-icon-color and sortable-header-icon-hover-color parameters.
$custom-theme: grid-theme(
$sorted-header-icon-color: #ffb06a,
$sortable-header-icon-hover-color: black
);
scss
Instead of hardcoding the color values like we just did, we can achieve greater flexibility in terms of colors by using the palette and color functions. Please refer to Palettes topic for detailed guidance on how to use them.