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 36 37 38 39 40 41 42
|
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="columns">
<name>columns()</name>
<summary>Select multiple columns from a table.</summary>
<since>1.10</since>
<type type="function">
<signature>columns( [ modifier ] )</signature>
<description>Select all columns</description>
<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 columns().nodes()` and `dt-api columns().data()`.
</parameter>
<returns type="DataTables.Api">DataTables API instance with selected columns in the result set.</returns>
</type>
<type type="function">
<signature>columns( columnSelector [, modifier ] )</signature>
<description>Select columns found by a 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 columns().nodes()` and `dt-api columns().data()`.
</parameter>
<returns type="DataTables.Api">DataTables API instance with selected columns</returns>
</type>
<description>
Often you will wish to work with one or more columns in a DataTables - this method provides the ability to select multiple columns from tables, with its chained methods providing the ability to get work with the column, such as getting its data or toggling its visibility.
While `dt-api column()` provides access to a single column, this `dt-api columns()` method is used to allow multiple columns to be manipulated or modified at the same time.
The method has two forms, reflecting the fact the columns can be selected in multiple different ways as your implementation demands:
* All columns (no parameters, or just a `dt-type selector-modifier` option)
* Columns selector (and optional `dt-type selector-modifier`)
</description>
<example title=""><![CDATA[
]]></example>
<related type="api">column()</related>
</dt-api>
|