File: orderMulti.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,445 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="option">
	<name>orderMulti</name>
	<summary>Multiple column ordering ability control.</summary>
	<since>1.10</since>

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

	<description>
		When ordering is enabled (`dt-init ordering`), by default DataTables allows users to sort multiple columns by shift clicking upon the header cell for each column. Although this can be quite useful for users, it can also increase the complexity of the order, potentiality increasing the processing time of ordering the data. Therefore, this option is provided to allow this shift-click multiple column ability.

		Note that disabling this ability does not impede your ability as a developer to do multiple column ordering using `dt-init columns.orderData`, `dt-init order` or `dt-api order()`, it just disallows the user from performing their own multi-column order.
	</description>

	<example title="Disable multiple column ordering ability"><![CDATA[
$('#example').dataTable( {
  "orderMulti": false
} );
]]></example>

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