sort

sorts rows in DataTable

by	string|object	the name(s) of property(-ies) by which data will be sorted
dir	string	the sorting direction, "asc" by default
as	string	the type of data, "string" by default

Example

data.sort("price", "asc");

Related samples

Usage examples

The method sort can be used with different parameters.

Most commonly, you would use the sort method to sort by the column value in the descending or ascending direction. For example:

// by name value; ascending; sort values as strings
data.sort("#name#","asc","string");
// by price value; descending; sort values as numbers
data.sort("#price#","desc","int");

Instead of default sorting types, you can use your own function ( can be used for complex data types ). The parameters of this function are the following:

• a (object) - the first data item
• b (object) - the second data item
• prop(string) - the name of the field that you want to sort by.

function sort_by_length(data1, data2, prop){
    return data1[prop].length > data2[prop].length ? 1 : -1;
}
 
data.sort("#name#", "asc", sort_by_length);

Possible return values of this function are 0,1,-1.

• 1 means that the first object is greater than the second object;
• -1 means that the first object is less than the second object;
• 0 means that 2 objects are equal.

If you need to access multiple properties of an object during sorting or you need to have some complex sorting logic, use a function as the first parameter.

function my_sorting(a, b, id){
    //a, b - data objects, id - id of the column, from which the sorting was invoked
    return a.Version > b.Version ? 1 : -1;
}
data.sort(my_sorting, "desc"); //3rd parameter will be ignored

Alternative syntax

You can use a object with sorting settings as the first parameter of the sort method:

data.sort({
    as:"string",
    dir:"desc",
    by:"package"
});

Multi-column sorting

In the case of sorting by multiple columns programmatically, the sort method can receive an array with sorting configs:

data.sort([
  { by:"some", dir:"asc:" },
  { by:"other", dir:"des" }
]);

Related sample:  DataTable: Sorting By Multiple Columns

Sorting directions

Possible values for the second parameter of the sort method is string which represents sorting direction:

• "asc" - for ascending sorting
• "desc" - for descending sorting

Sorting types

The third parameter of the sort method is a string which represents the desired sorting mode:

• int - compares numeric values;
• date - compares dates;
• string - compares string values;
• string_strict - case-sensitive "string";
• text - compares visible item text (including template);
• server - issues a server side request for a sorted dataset;
• raw - basic sorter with simple comparison (a>b and vice versa);
• or, you can set a custom sorting type.

Back to top