sort

sorts rows in DataTable

void sort(string by, [string dir,string as] );

Parameters

bystringthe name(s) of property(-ies) by which data will be sorted
dirstringthe sorting direction, "asc" by default
asstringthe type of data, "string" by default

Example

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

Related samples

Details

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");

The property name should be included into hashes.

Instead of default sorting types, you can define your own method (can be used for complex data types):

function sort_by_length(data1, data2){
    return data1.length > data2.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){
    //a, b - data objects
    return a.Version > b.Version ? 1 : -1;
}
data.sort(my_sorting, "desc"); //3rd parameter will be ignored

Alternative syntax

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

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

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.
See also
Back to top
If you have not checked yet, be sure to visit site of our main product Webix ui library and page of javascript data grid product.