File: column%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,550 bytes parent folder | download | duplicates (2)
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="columns">
	<name>column()</name>
	<summary>Select a single column from a table.</summary>
	<since>1.10</since>

	<type type="function">
		<signature>column( columnSelector [, modifier ] )</signature>
		<description>Select the column found by a the column selector</description>
		<parameter type="column-selector" name="columnSelector">
			Column selector.
		</parameter>
		<parameter type="selector-modifier" name="modifier" default="">
			Option used to specify how the content's of the selected columns should be ordered, and if paging or filtering in the table should be taken into account. This is only useful for operations which involve rows, such as `dt-api column().nodes()` and `dt-api column().data()`.
		</parameter>
		<returns type="DataTables.Api">DataTables API instance with selected column in the result set.</returns>
	</type>

	<description>
		Select an individual column to work with from a DataTable, with its chained methods providing the ability to get work with the column, taking actions such as toggling its visibility or obtaining the data from the column.

		Note that this method selects a single column. If the selector provided resolves to multiple columns, the result will be truncated to just a single columns - the first one found. If you need to work with multiple columns, the `dt-api columns()` method is available with the same selection options.
	</description>

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

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