File: unique%28%29.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 (29 lines) | stat: -rw-r--r-- 1,280 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
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="utility">
	<name>unique()</name>
	<summary>Create a new API instance containing only the unique items from a the elements in an instance's result set.</summary>
	<since>1.10</since>

	<type type="function">
		<signature>unique()</signature>
		<description>Create a new API instance containing only the unique items from a the elements in an instance's result set.</description>
		<returns type="DataTables.Api">New Api instance which contains the unique items from the original instance's result set, in its own result set.</returns>
	</type>

	<description>
		It is often useful to know what data is available in a result set, with duplicate items removed (for example creating a `dt-tag select` list for use as a search input). Although unique items can be found quite trivially with a loop, this utility function provides that ability for you in one simple method.

		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.
	</description>

	<example title="Get the unique data from a column"><![CDATA[
var table = $('#example').DataTable();

table
	.column( 0 )
	.data()
	.unique();

]]></example>

</dt-api>