DataTables provides two APIs for sorting information in a table:
- Type based sorting
- Custom data source sorting
By far the most commonly used of these two types is "type based sorting" and is the one you are most likely to want to use if just starting out with DataTables.
Type based sorting
The main DataTables package includes sorting functions for strings, dates, numeric and currency data, but you may very well wish to order data in some other manner, for example date formats not built in. The sorting functions below provide a wealth of different sorting methods that can be used with DataTables.
It is also worth noting that sorting function go hand-in-hand with type detection plug-ins, and many of the sorting plug-ins below has a corresponding type detection function to make installation very easy.
How to use
columns.typeDT parameter for the column you want to have this sorting type applied to, set it to the value needed for the plug-in (this isn't needed if you use a type detection plug-ins for the sorting type.
|alt-string||Use the `alt` attribute of an image tag as the data to sort upon.|
|anti-the||Sort with the prefixed word `dt-string The` removed, if present|
|chinese-string||Sort Chinese characters|
|currency||Sort data numerically when it has a leading currency symbol.|
|date-dd-MMM-yyyy||Sort dates in the format `dd-mmm-yyyy`|
|date-de||Sort date / time in the format `dd.mm.YYYY HH:mm`.|
|date-eu||Sort dates in the format `dd/mm/YY[YY]` (with optional spaces)|
|date-euro||Sort date / time in the format `dd/mm/YYY hh:ii:ss`|
|date-uk||Sort dates in the format `dd/mm/YY`|
|enum||Sort an enumerated list of options|
|file-size||Sort abbreviated file sizes correctly (8MB, 4KB etc)|
|formatted-numbers||Sort numbers which are displayed with thousand separators|
|ip-address||Sort IP addresses numerically|
|monthYear||This sorting plug-in will sort, in calendar order, data whichis in the format "MM YY".|
|natural||Sort data with a mix of numbers and letters _naturally_.|
|num-html||Sort data which is a mix of HTML and numeric data.|
|numeric-comma||Sort numbers correctly which use a common as the decimal place.|
|percent||Sort numeric data with a postfixed percentage symbol|
|persian||Sort Persian strings alphabetically|
|scientific||Sort data which is written in exponential notation.|
|signed-num||Sort data numerically with a leading `+` symbol (as well as `-`).|
|title-numeric||Sort data numerically based on an attribute on an empty element.|
|title-string||Sort data as a string based on an attribute on an empty element.|
Custom data source sorting
Custom data source sorting plug-ins allow complete control of the data that is to be sorted. Typically this is used to retrieve data live from the DOM just prior to the table being sorted, to perform sorting on data that can be updated by the end-user or by some other script.
You can also use type based sorting in-combination with custom data source sorting as the data returned by the custom data source sorting plug-in is processed in exactly the same way as automatically retrieved data.
Please note that custom data source sorting plug-ins will often query the DOM for information which can degrade performance. Thus, if it is possible for you to use type based sorting (above) or orthogonal data, it is recommended that you do so.
How to use
columns.orderDataTypeDT parameter for the column, to tell it which plug-in function to use.
The custom data source functions are used to update the cached data in DataTables, so sorting can occur on columns with user input information.
|dom-checkbox||Sort based on the checked state of checkboxes in a column|
|dom-select||Sort based on the value of the `dt-tag select` options in a column|
|dom-text||Sorting based on the values of `dt-tag input` elements in a column.|