File: toJQuery%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 (30 lines) | stat: -rw-r--r-- 1,334 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
30
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="utility">
	<name>toJQuery()</name>
	<summary>Convert the API instance to a jQuery object, with the objects from the instance's result set in the jQuery result set.</summary>
	<since>1.10</since>

	<type type="function">
		<signature>toJQuery()</signature>
		<description>Create a jQuery object from an API instance.</description>
		<returns type="jQuery">jQuery object which contains the values from the API instance's result set.</returns>
	</type>

	<description>
		This method will create a jQuery object from the contents of the API instance's result set. This is primarily of use when working with the `nodes()` functions of the API such as `dt-api rows().nodes()`, `dt-api column().nodes()` and  `dt-api cells().nodes()`, where it can be useful to easily convert the API instance into an jQuery object, working with the nodes using the chaining methods provided by jQuery.

		Please note that `dt-api to$()` and `dt-api toJQuery()` are identical in functionality. Both methods are provided to cater for the two common forms of how jQuery is used.
	</description>

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

table
	.column( 0 )
	.nodes()
	.toJQuery()
	.addClass( 'ready' );

]]></example>

</dt-api>