File: rows%28%29.ids%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 (26 lines) | stat: -rw-r--r-- 1,325 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
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="rows">
	<name>rows().ids()</name>
	<summary>Get the ids of the selected rows.</summary>
	<since>1.10.8</since>

	<type type="function">
		<signature>rows().ids( [ hash ] )</signature>
		<description>Get the ids of the selected rows.</description>
		<parameter name="hash" type="boolean" default="false">
			* `true` - Append a hash (`#`) to the start of each row id. This can be useful for then using the ids as selectors
			* `false` - Do not modify the id value.
		</parameter>
		<returns type="DataTables.Api">Api instance with the selected rows in its result set. If a row does not have an id available `-type undefined` will be returned as the value.</returns>
	</type>

	<description>
		This method can be used to get the id's of the rows selected by the `dt-api rows()` method, as specified by the row's data and the `dt-init rowId` option. Optionally it can also prepend a hash (`#`) to the ids allowing them to then easily be used as selectors.

		**Important** This method does not read the DOM id for the `-tag tr` elements, but rather gets the row id from the row's data source (location specified by `dt-init rowId`).
	</description>

	<related>dt-init rowId</related>
	<related>dt-api row().id()</related>
	<related>dt-api rows().ids()</related>
</dt-api>