File: search.xml

package info (click to toggle)
datatables.js 1.10.13%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 6,232 kB
  • ctags: 1,329
  • sloc: xml: 10,249; php: 4,387; sh: 492; makefile: 21
file content (39 lines) | stat: -rw-r--r-- 1,333 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
31
32
33
34
35
36
37
38
39
<?xml version="1.0" encoding="UTF-8" ?>
<dt-option group="option">
	<name>search</name>
	<summary>Set an initial filter in DataTables and / or filtering options.</summary>
	<since>1.10</since>

	<type type="object" />

	<description>
		The `dt-init search` option allows the way DataTables performs filtering to be set during the initialisation, and to set an initial global filter.

		The options that control how the filtering is performs are:

		* `dt-init search.caseInsensitive` - Indicate is case-insensitive sorting should be performed.
		* `dt-init search.regex` - Treat the search as a regular expression or not
		* `dt-init search.smart` - Use DataTables' smart filtering or not

		Additionally, to set an initial filter:

		* `dt-init search.search` - Set an initial global filter.
	</description>

	<example title="Set an initial filter"><![CDATA[
$('#example').dataTable( {
  "search": {
    "search": "Fred"
  }
} );
]]></example>

	<related type="option">search</related>
	<related type="option">searchCols</related>
	<related type="option">search.search</related>
	<related type="option">search.caseInsensitive</related>
	<related type="option">search.regex</related>
	<related type="option">search.smart</related>
	<related type="api">search()</related>
	<related type="api">columns().search()</related>
</dt-option>