1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="utility">
<name>sort()</name>
<summary>Sort the elements of the API instance's result set.</summary>
<since>1.10</since>
<type type="function">
<signature>sort( [ fn ] )</signature>
<description>Sort the elements of the API instance's result set.</description>
<parameter type="function" name="fn" default="">
This is a standard Javascript sort comparison function. It accepts two parameters:
* Value 1 to compare
* Value 2 to compare
And expects a return which indicated the sorted position of the two values. Less that 0 indicates that the first value comes before the second, greater than 0 indicates that the first value comes after the second and a return of 0 indicates that they are identical.
</parameter>
<returns type="DataTables.Api">The original API instance with the result set sorted as defined by the sorting conditions used.</returns>
</type>
<description>
The `dt-api sort()` method provides a way of sorted the data in an API instance's result set, which can be particularly useful if you then want to use that data for displaying to the end user - for example as a `dt-tag select` list for a search input. This method should not be confused with `dt-api order()` which is used to order for records in the DataTable.
This method makes use of the fact that DataTables API objects are "array like", in that they inherent a lot of the abilities and methods of the Javascript `Array` type.
In this case, this method is a proxy for the Javascript `Array.prototype.sort` method and is provided as a utility method for the DataTables API. For more information about the original method, please refer to the [Mozilla MDN documentation for `sort`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort).
</description>
<example title="Sort the data from a column"><![CDATA[
var table = $('#example').DataTable();
var data = table
.column( 0 )
.data()
.sort();
]]></example>
</dt-api>
|
