File: ordering.xml

package info (click to toggle)
datatables.js 1.11.5%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 22,848 kB
  • sloc: javascript: 65,075; xml: 10,712; php: 4,741; sh: 544; makefile: 18
file content (30 lines) | stat: -rw-r--r-- 1,296 bytes parent folder | download | duplicates (6)
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
<?xml version="1.0" encoding="UTF-8" ?>
<dt-option group="feature">
	<name>ordering</name>
	<summary>Feature control ordering (sorting) abilities in DataTables.</summary>
	<since>1.10</since>

	<type type="boolean" />
	<default>true</default>

	<description>
		Enable or disable ordering of columns - it is as simple as that! DataTables, by default, allows end users to click on the header cell for each column, ordering the table by the data in that column. The ability to order data can be disabled using this option.

		Note that the ability to add or remove sorting of individual columns can be disabled by the `dt-init columns.orderable` option for each column. This parameter is a global option - when disabled, there are no sorting actions applied by DataTables at all.
	</description>

	<example title="Disable ordering in the table"><![CDATA[
$('#example').dataTable( {
  "ordering": false
} );
]]></example>

	<related type="option">columns.orderable</related>
	<related type="option">order</related>
	<related type="option">orderFixed</related>
	<related type="option">orderMulti</related>
	<related type="option">orderClasses</related>
	<related type="api">order()</related>
	<related type="api">column().order()</related>
	<related type="api">columns().order()</related>
</dt-option>