Sorting

There are 2 ways to implement server-side sorting:

URL manipulation

APPLICABLE TO:Grid, TreeGrid, Tree, Combo, Scheduler, DataView, Chart, Form

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

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

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.

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

In the code snippet above, 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

<cffunction name="custom_sort">
    <cfargument name="sorted_by">
        <!--- SORT BY some_field ASC --->
    <cfif NOT ArrayLen(ARGUMENTS.sorted_by.rules)>
        <cfset ARGUMENTS.sorted_by.add("some_field","ASC")>
    </cfif>
</cffunction>
<cfset conn.event.attach("beforeSort",custom_sort)>

Default sorting by multiple fields

<cffunction name="custom_sort">
    <cfargument name="sorted_by">
        <!--- SORT BY some_field ASC, some_other ASC --->
    <cfif ArrayLen(ARGUMENTS.sorted_by.rules)>
        <cfset ARGUMENTS.sorted_by.add("some_field","ASC")>
                <cfset ARGUMENTS.sorted_by.add("some_other","ASC")>
    </cfif>
</cffunction>
<cfset conn.event.attach("beforeSort",custom_sort)>

Custom sorting rule

<cffunction name="custom_sort">
    <cfargument name="sorted_by">
        <!--- SORT BY LENGTH(some_field) --->
         <cfset ARGUMENTS.sorted_by.add("LENGTH(taskName)")>
</cffunction>
<cfset conn.event.attach("beforeSort",custom_sort)>
Back to top