Check documentation for the latest version of dhtmlxSuite Sorting DHTMLX Docs

Sorting

There are 3 ways to implement server-side sorting:

The sort() method

It's the easiest way to implement the server-side sorting. All you need to do is to call the method sort().

$grid->sort("item_nm ASC");
$grid->sort("item_cd", "DESC");
$grid->render_table("grid50","item_id","item_nm,item_cd");

URL manipulation

APPLICABLE TO:Grid, TreeGrid, Tree, Combo, Scheduler, DataView, Chart, Form, DataStore, DHTMXL Touch components

You can control how data will be sorted inside of a column by specifying additional parameters in URL.

Check the article Extending functionality for full url parameters description.

//ORDER by field_2 ASC
grid.load("some.php?connector=true&dhx_sort[2]=asc");
//ORDER by field_2 ASC, field_3 DESC
grid.load("some.php?connector=true&dhx_sort[2]=asc&dhx_sort[3]esc");

The sorting type 'connector'

APPLICABLE TO:Grid, TreeGrid

To sort grid/treegrid content with connectors you need to use 'connector' as a sorting type during the grid initialization.

grid.setColSorting("connector,str,na");

In the above code snippet the first column will be sorted on the server side with connectors, the second one as a string on the client side, the third column will be non-sortable.

By assigning to sorting type 'connector' you just 'say' that sorting will be implemented on the server side.

To define the way, 'behaviour' of sorting, you should use the beforeSort event.

This event doesn't allow writing a custom sorting logic, but you can affect SORT BY clause of the generated SQL request.

Default sorting by one field

function custom_sort($sorted_by){
    //SORT BY some_field ASC
    if (!sizeof($sorted_by->rules)) 
        $sorted_by->add("some_field","ASC");
}
$conn->event->attach("beforeSort","custom_sort");

Default sorting by multiple fields

function custom_sort($sorted_by){
    //SORT BY some_field ASC, some_other ASC
    if (!sizeof($sorted_by->rules)){
        $sorted_by->add("some_field","ASC");
        $sorted_by->add("some_other","ASC");
    }
}
 
$conn->event->attach("beforeSort","custom_sort");

Custom sorting rule

function custom_sort($sorted_by){
    // SORT BY LENGTH(some_field)
    $sorted_by->rules[0]["name"]="LENGTH(some_field)";
}
 
$conn->event->attach("beforeSort","custom_sort");
Back to top