File: column%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 (35 lines) | stat: -rw-r--r-- 1,697 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="columns">
	<name>column().nodes()</name>
	<summary>Get the cell nodes for the selected column.</summary>
	<since>1.10</since>

	<type type="function">
		<signature>column().nodes()</signature>
		<description>Obtain the `dt-tag th` / `dt-tag td` nodes for the selected column</description>
		<returns type="DataTables.Api">DataTables API instance with each cell's node from the selected columns in the result set. This is a 1D array with each entry being the node for the cells from the selected column.</returns>
	</type>

	<description>
		This method is used to get the nodes of the table body cells (`dt-tag th` / `dt-tag td` elements) in the column 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.

		Additionally, if the selector used in `dt-api column()` matches more than one column, the result set will be truncated to a single column - the first one in the result set.
	</description>

	<example title="Add a class to the right most column in the table"><![CDATA[
var table = $('#example').DataTable();

table
	.column( -1 )
	.nodes()
	.to$()      // Convert to a jQuery object
	.addClass( 'ready' );
);
]]></example>

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