Hierarchical Grid Sorting Overview

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.


Additionally there is a custom contextmenu added for sorting using igx-hierarchical-grid's onContextMenu 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:

<igx-column field="ProductName" header="Product Name" [dataType]="'string'" sortable="true"></igx-column>

Sorting Indicators

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';

// 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.
    { fieldName: 'ProductName', dir: SortingDirection.Asc, ignoreCase: true },
    { fieldName: 'Price', dir: SortingDirection.Desc }

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 column

// Removes the sorting state from every column in the Hierarchical Grid

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.

public ngOnInit() {
    this.hierarchicalGrid.sortingExpressions = [
        { fieldName: 'ProductName', dir: SortingDirection.Asc, ignoreCase: true },
        { fieldName: 'Price', dir: SortingDirection.Desc }

If values of type string are used by a column of dataType Date, 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.


To get started with styling the sorting behavior, we need to import the index file, where all the theme functions and component mixins live:

@import '~igniteui-angular/lib/core/styles/themes/index';

Following the simplest approach, we create a new theme that extends the igx-grid-theme and accepts the $sorted-header-icon-color and sortable-header-icon-hover-color parameters.

$custom-theme: igx-grid-theme(
    $sorted-header-icon-color: #ffb06a,
    $sortable-header-icon-hover-color: black

The last step is to include the component mixins:

 @include igx-grid($custom-theme);

If the component is using an Emulated ViewEncapsulation, it is necessary to penetrate this encapsulation using ::ng-deep:

:host {
   ::ng-deep {
       @include igx-grid($custom-theme);

Defining a color palette

Instead of hardcoding the color values like we just did, we can achieve greater flexibility in terms of colors by using the igx-palette and igx-color functions.

igx-palette generates a color palette based on the primary and secondary colors that are passed:

$black-color: black;
$orange-color: #ffb06a;

$custom-palette: igx-palette($primary: $black-color, $secondary: $orange-color);

And then with igx-color we can easily retrieve color from the palette.

$custom-theme: igx-grid-theme(
    $sorted-header-icon-color: igx-color($custom-palette, "secondary", 500),
    $sortable-header-icon-hover-color: igx-color($custom-palette, "primary", 500)

The igx-color and igx-palette are powerful functions for generating and retrieving colors. Please refer to Palettes topic for detailed guidance on how to use them.

Using Schemas

Going further with the theming engine, you can build a robust and flexible structure that benefits from schemas. A schema is a recipe of a theme.

Extend one of the two predefined schemas, that are provided for every component, in this case - _light-grid:

// Extending the light grid schema
$custom-grid-schema: extend($_light-grid,
        sorted-header-icon-color: (igx-color:('secondary', 500)),
        sortable-header-icon-hover-color: (igx-color:('primary', 500))

In order to apply our custom schema we have to extend one of the globals (light or dark), which is basically pointing out the components with a custom schema, and after that add it to the respective component themes:

// Extending the global light-schema
$my-custom-schema: extend($light-schema, 
        igx-grid: $custom-grid-schema

// Defining our custom theme with the custom schema
$custom-theme: igx-grid-theme(
  $palette: $custom-palette,
  $schema: $my-custom-schema

Don't forget to include the themes in the same way as it was demonstrated above.


API References

Additional Resources

Our community is active and always welcoming to new ideas.