File: row%28%29.child%28%29.hide%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 (41 lines) | stat: -rw-r--r-- 1,976 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
36
37
38
39
40
41
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="rows">
	<name>row().child().hide()</name>
	<summary>Hide child rows after creating new child rows</summary>
	<since>1.10</since>

	<type type="function">
		<signature>row().child().hide()</signature>
		<description>Hide the child row(s) of a parent row</description>
		<returns type="DataTables.Api">DataTables API instance.</returns>
	</type>

	<description>
		This method can be used to make the child rows of a parent row hidden at any time. When child row(s) are set as hidden they are not detached from the parent row, but rather simply not drawn on the page. This method provides a way of hiding a row at any required time.

		Please note that this method is only available when `dt-api row().child()` is called with a parameter set. This is because `dt-api row().child()` will return the child rows if called with no parameters, which is either a `-type jQuery` object or `-type undefined`. When called with a parameter `dt-api row().child()` returns a `-type DataTables.Api` instance. If you need to hide a child row without any parameters being set use `dt-api row().child.hide()`.

		It is worth saying that this method is probably of limited use, but it is included in the API for completeness!

		Unlike many of the other methods which manipulate the DataTable, this method does not require `dt-api draw()` to be called for the resulting change to be displayed. The child row(s) are inserted into the table without requiring that DataTables redraw.
	</description>

	<example title="Hide a child row immediately after setting its value"><![CDATA[
var table = $('#example').DataTable();

// Show an initial child row
table
	.row( ':eq(0)' )
	.child( 'Extra information...' )
	.show();

// Change the information and hide - without the hide() call the changed
// information would be visible due to the show() above.
table
	.row( ':eq(0)' )
	.child( 'Different information' )
	.hide()

]]></example>

</dt-api>