File: row%28%29.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 (29 lines) | stat: -rw-r--r-- 1,717 bytes parent folder | download | duplicates (4)
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="rows">
	<name>row()</name>
	<summary>Select a single row from a table.</summary>
	<since>1.10</since>

	<type type="function">
		<signature>row( rowSelector [, modifier ] )</signature>
		<description>Select a row found by a row selector</description>
		<parameter type="row-selector" name="rowSelector">
			Row selector.
		</parameter>
		<parameter type="selector-modifier" name="modifier" default="">
			Option used to specify how the rows should be ordered, and if paging or search options in the table should be taken into account.
		</parameter>
		<returns type="DataTables.Api">DataTables API instance with selected row in the result set</returns>
	</type>

	<description>
		Working with rows is a fundamental part of DataTables, and you want to be able to easily select the rows that you want from the table. This method is the row counterpart to the `dt-api columns()` and `dt-api cells()` methods for working with columns and cells in the table, respectively. Using a selector and the `dt-type selector-modifier` option the rows at the table can be obtained with this method's own chained methods providing the ability to get the data from the rows, the row nodes and to invalidate the data, among other actions.

		Note that if the selector used matches multiple rows, this method will truncate the result to contain just one row, the first matched one. If you require to work with multiple rows at the same time for group manipulation, please use this method's plural counterpart `dt-api rows()` which can select and manipulate multiple rows. 
	</description>

	<example title=""><![CDATA[
]]></example>

	<related type="api">rows()</related>
</dt-api>