File: tables%28%29.containers%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 (32 lines) | stat: -rw-r--r-- 1,187 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
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="tables">
	<name>tables().containers()</name>
	<summary>Get the `-tag div` container nodes for the tables in the API's context</summary>
	<since>1.10.1</since>

	<type type="function">
		<signature>tables().containers()</signature>
		<description>Get the `-tag div` container nodes</description>
		<returns type="DataTables.Api">DataTables API instance with the container nodes from the selected tables in the result set.</returns>
	</type>

	<description>
		DataTables places the main table and all of the various component display controls for the table inside a container element, a `-tag div` element with a class of `-string dataTables_wrapper` (by default).

		This method provides the ability to obtain that node for all tables in the API instance's context, which can be used by plug-in authors to add additional controls to the table.
	</description>

	<example title="Add a class to the container nodes"><![CDATA[
var tables = $('.dataTable').DataTable( {
	scrollX: "100%"
} );

tables
	.tables()
	.containers()
	.to$()
	.addClass( 'selectable' );
]]></example>

	<related type="api">table().container()</related>
</dt-api>