Sorting

User Interaction

With the TreeList widget, a user can sort by single and multiple columns. Use the sorting | mode option to specify the current sorting mode.

JavaScript
$(function() {
    $("#treeListContainer").dxTreeList({
        sorting: {
            mode: "single" // or "multiple" | "none"
        }
    });
});

In the single mode, a user selects a sort order from the context menu or clicks a column header to apply sorting. Subsequent clicks on the same header reverse the sort order. Applying sorting to another column clears the previous column's sorting settings. In the multiple mode, sorting settings applied to other columns remain intact when a user selects a sort order from another column's context menu. Note that rows are sorted within their hierarchical level.

DevExtreme HTML5 JavaScript jQuery Angular Knockout Widget TreeList Sorting

The context menu can also be used to clear a column's sorting settings.

DevExtreme HTML5 JavaScript jQuery Angular Knockout Widget TreeList Sorting

To disable sorting in the whole widget, set the sorting | mode option to "none"; to disable sorting only in a specific column, use its allowSorting option.

JavaScript
$(function() {
    $("#treeListContainer").dxTreeList({
        columns: [{
            // ...
            allowSorting: false
        }]
    });
});

API

Initial and Runtime Sorting

Rows are sorted according to the data source by default. Set the sortOrder option to sort rows in the required order. Specify the sortIndex option as well to sort by multiple columns. Otherwise, each sorted column gets a sort index according to its position in the columns array. For example, the following code sorts rows first by the "Surname", then by the "Name" column:

JavaScript
$(function() {
    $("#treeListContainer").dxTreeList({
        // ...
        columns: [
            { dataField: "Name",    sortIndex: 1, sortOrder: "asc" },
            { dataField: "Surname", sortIndex: 0, sortOrder: "asc" },
            // ...
        ]
    });
});

Change the sortOrder and sortIndex options using the columnOption method to sort at runtime.

JavaScript
var treeList = $("#treeListContainer").dxTreeList("instance");
treeList.columnOption("Surname", {
    sortOrder: "desc",
    sortIndex: 2
});

Custom Sorting

Implement a custom sorting routine using the calculateSortValue option if standard sorting does not meet your requirements. It accepts the name of the data source field that provides values to be used in sorting...

JavaScript
$(function() {
    $("#treeListContainer").dxTreeList({
        columns: [{
            dataField: "Position", // provides values for the column
            calculateSortValue: "isOnVacation" // provides values to be used in sorting 
        }]
    });
});

...or a function that returns such a value.

JavaScript
$(function() {
    var treeList = $("#treeListContainer").dxTreeList({
        columns: [{
            dataField: 'Position',
            calculateSortValue: function (rowData) {
                if (rowData.Position == "CEO")
                    return treeList.option('Position', 'sortOrder') == 'asc' ? 0 : data.length; // CEOs must go first
                else
                    return rowData.Position; // Others are sorted as usual
            }
        }]
    }).dxTreeList("instance");
});

Clear Sorting Settings

You can clear sorting settings for all columns by calling the clearSorting() method, or for a specific column - by setting its sortIndex option to undefined using the columnOption method.

JavaScript
var treeList = $("#treeListContainer").dxTreeList("instance");
treeList.columnOption("Name", "sortIndex", undefined);
treeList.clearSorting();