File: columns%28%29.nodes%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 (34 lines) | stat: -rw-r--r-- 1,596 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
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="columns">
	<name>columns().nodes()</name>
	<summary>Get the cell nodes for the selected columns.</summary>
	<since>1.10</since>

	<type type="function">
		<signature>columns().nodes()</signature>
		<description>Obtain the `dt-tag th` / `dt-tag td` nodes for the selected columns</description>
		<returns type="DataTables.Api">DataTables API instance with each cell's node from the selected columns in the result set. This is a 2D array with the top level array entries for each column matched by the `dt-api columns()` selector.</returns>
	</type>

	<description>
		This method is used to get the nodes of for the cells (`dt-tag th` / `dt-tag td` elements) in the columns matched by the selector.

		Please note that the order of the nodes in the returned array and which rows the nodes are obtained from (searched rows, visible rows etc) is controlled by the `dt-type selector-modifier` option of the `dt-api columns()` selector used to get the selected columns.

		Furthermore, please be aware that using `dt-init deferRender` will cause some nodes to be created only when they are required for display, so they might not be immediately available when this method is called.
	</description>

	<example title="Add a class to all cells in the columns matched by a class"><![CDATA[
var table = $('#example').DataTable();

table
	.columns( '.ready' )
	.nodes()
	.flatten()  // Reduce to a 1D array
	.to$()      // Convert to a jQuery object
	.addClass( 'highlight' );
);
]]></example>

	<related type="api">column().nodes()</related>
</dt-api>