annotate DataTables-1.9.4/docs/DataTable.html @ 7:0f2b740536fb draft

Uploaded
author saskia-hiltemann
date Mon, 21 Aug 2017 09:16:07 -0400
parents ac5f9272033b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
2 <html>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
3 <head>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
4 <meta http-equiv="Content-type" content="text/html; charset=utf-8">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
5 <title>Class: DataTable - documentation</title>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
6
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
7 <style type="text/css" media="screen">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
8 @import "media/css/doc.css";
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
9 @import "media/css/shCore.css";
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
10 @import "media/css/shThemeDataTables.css";
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
11 </style>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
12
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
13 <script type="text/javascript" src="media/js/shCore.js"></script>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
14 <script type="text/javascript" src="media/js/shBrushJScript.js"></script>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
15 <script type="text/javascript" src="media/js/jquery.js"></script>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
16 <script type="text/javascript" src="media/js/doc.js"></script>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
17 </head>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
18 <body>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
19 <div class="fw_container">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
20
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
21 <a name="top"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
22 <div class="fw_header">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
23 <h1 class="page-title">Class: DataTable</h1>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
24
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
25 <div class="page-info">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
26 DataTables v1.9.4 documentation
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
27 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
28 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
29
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
30
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
31
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
32 <div class="fw_nav">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
33 <h2>Navigation</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
34 <ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
35 <li><a href="#top">Overview</a></li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
36 <li><a href="#summary">Summary</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Classes (0)</td><td><a href="#summary_namespaces">Namespaces (4)</a></td></tr><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (1)</a></td></tr><tr><td><a href="#summary_methods">Methods (22)</a></td><td><a href="#summary_methods_static">Static methods (3)</a></td></tr><tr><td><a href="#summary_events">Events (11)</a></td><td></td></tr></tbody></table></div></li><li><a href="#details">Details</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (1)</a></td></tr><tr><td><a href="#summary_methods">Methods (22)</a></td><td><a href="#summary_methods_static">Static methods (3)</a></td></tr><tr><td><a href="#summary_events">Events (11)</a></td><td></td></tr></tbody></table></div></li></ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
37 <div style="margin-top: 10px;">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
38 <input type="hidden" name="show_private" value="0">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
39 <span id="private_label">Hiding</span> private elements
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
40 (<a id="private_toggle" href="">toggle</a>)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
41 </span>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
42 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
43 <div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
44 <input type="hidden" name="show_extended" value="1">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
45 <span id="extended_label">Showing</span> extended elements
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
46 (<a id="extended_toggle" href="">toggle</a>)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
47 </span>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
48 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
49 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
50
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
51 <div class="fw_content">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
52 <a name="overview"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
53 <div class="doc_overview">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
54 <div class="nav_blocker"></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
55 <dl><dt id="DataTable" class=" even"><a name="DataTable"></a><a name="DataTable_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>new DataTable</a></span><span class="type-sig"><span class="signature">(<span class="optional">oInit</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>DataTables is a plug-in for the jQuery Javascript library. It is a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
56 highly flexible tool, based upon the foundations of progressive
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
57 enhancement, which will add advanced interaction controls to any
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
58 HTML table. For a full list of features please refer to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
59 <a href="http://datatables.net">DataTables.net</a>.</p>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
60
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
61 <p>Note that the <i>DataTable</i> object is not a global variable but is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
62 aliased to <i>jQuery.fn.DataTable</i> and <i>jQuery.fn.dataTable</i> through which
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
63 it may be accessed.</p><div class="collapse_details"><h3>Constructor</h3><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
64
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
65 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
66 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
67
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
68 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
69 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
70 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
71 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
72 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
73 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
74 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
75 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
76 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
77 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
78 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
79
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
80 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
81 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oInit</td><td class="type type-param">object</td><td class="attributes">Optional</td><td class="default">{}</td><td class="description last"><p>Configuration object for DataTables. Options
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
82 are defined by <a href="DataTable.defaults.html">DataTable.defaults</a></p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
83 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
84 </table><h5>Examples:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
85 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
86 <pre class="brush: js"> // Basic initialisation
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
87 $(document).ready( function {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
88 $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
89 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
90
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
91 </pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
92 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
93
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
94 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
95 <pre class="brush: js"> // Initialisation with configuration options - in this case, disable
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
96 // pagination and sorting.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
97 $(document).ready( function {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
98 $('#example').dataTable( {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
99 "bPaginate": false,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
100 "bSort": false
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
101 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
102 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
103 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
104 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
105 </dl><h3 class="subsection-title">Requires</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
106 <ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
107 <li>module:jQuery</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
108 </ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
109
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
110 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
111
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
112
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
113 <div class="doc_summary">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
114 <a name="summary"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
115 <h2>Summary</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
116
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
117 <div class="doc_group"><a name="summary_namespaces"></a><h3 class="subsection-title">Namespaces</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
118 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
119 <dt class="even"><span class="type-name"><a href="DataTable.defaults.html">defaults</a></span></dt><dd class="even"><p>Initialisation options that can be given to DataTables at initialisation
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
120 time.</p></dd><dt class="odd"><span class="type-name"><a href="DataTable.ext.html">ext</a></span></dt><dd class="odd"><p>Extension object for DataTables that is used to provide all extension options. [<a href="DataTable.ext.html">...</a>] </p></dd><dt class="even"><span class="type-name"><a href="DataTable.models.html">models</a></span></dt><dd class="even"><p>Object models container, for the various models that DataTables has available
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
121 to it. These models define the objects that are used to hold the active state
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
122 and configuration of the table.</p></dd><dt class="odd"><span class="type-name"><a href="34cdb56b2c.html">oApi</a></span></dt><dd class="odd"><p>Reference to internal functions for use by plug-in developers. Note that these
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
123 methods are references to internal functions and are considered to be private.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
124 If you use these methods, be aware that they are liable to change between versions
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
125 (check the upgrade notes).</p></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
126 </dl></div><div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
127
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
128 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
129 <dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#version">version</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Version string for plug-ins to check compatibility. Allowed format is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
130 a.b.c.d.e where: a:int, b:int, c:int, d:string(dev|beta), e:int. d and
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
131 e are optional</p></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
132 </dl></div><div class="doc_group"><a name="summary_methods"></a><h3 class="subsection-title">Methods - instance</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
133
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
134 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
135 <dt class=" even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#$">$</a></span><span class="type-sig"><span class="signature">(sSelector, <span class="optional">oOpts</span>)</span><span class="type-signature"> &rarr; {object}</span></span></dt><dd class=" even"><p>Perform a jQuery selector action on the table's TR elements (from the tbody) and
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
136 return the resulting jQuery object.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_">_</a></span><span class="type-sig"><span class="signature">(sSelector, <span class="optional">oOpts</span>)</span><span class="type-signature"> &rarr; {array}</span></span></dt><dd class=" odd"><p>Almost identical to $ in operation, but in this case returns the data for the matched
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
137 rows - as such, the jQuery selector used should match TR row nodes or TD/TH cell nodes
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
138 rather than any descendants, so the data can be obtained for the row/cell. If matching
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
139 rows are found, the data returned is the original data array/object that was used to <br />
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
140 create the row (or a generated array if from a DOM source). [<a href-"#_">...</a>] </p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnAddData">fnAddData</a></span><span class="type-sig"><span class="signature">(mData, <span class="optional">bRedraw</span>)</span><span class="type-signature"> &rarr; {array}</span></span></dt><dd class=" even"><p>Add a single new row or multiple rows of data to the table. Please note
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
141 that this is suitable for client-side processing only - if you are using
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
142 server-side processing (i.e. "bServerSide": true), then to add data, you
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
143 must add it to the data source, i.e. the server-side, through an Ajax call.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnAdjustColumnSizing">fnAdjustColumnSizing</a></span><span class="type-sig"><span class="signature">(<span class="optional">bRedraw</span>)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>This function will make DataTables recalculate the column sizes, based on the data
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
144 contained in the table and the sizes applied to the columns (in the DOM, CSS or
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
145 through the sWidth parameter). This can be useful when the width of the table's
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
146 parent element changes (for example a window resize).</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnClearTable">fnClearTable</a></span><span class="type-sig"><span class="signature">(<span class="optional">bRedraw</span>)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Quickly and simply clear a table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnClose">fnClose</a></span><span class="type-sig"><span class="signature">(nTr)</span><span class="type-signature"> &rarr; {int}</span></span></dt><dd class=" odd"><p>The exact opposite of 'opening' a row, this function will close any rows which
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
147 are currently 'open'.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnDeleteRow">fnDeleteRow</a></span><span class="type-sig"><span class="signature">(mTarget, <span class="optional">fnCallBack</span>, <span class="optional">bRedraw</span>)</span><span class="type-signature"> &rarr; {array}</span></span></dt><dd class=" even"><p>Remove a row for the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnDestroy">fnDestroy</a></span><span class="type-sig"><span class="signature">(<span class="optional">bRemove</span>)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Restore the table to it's original state in the DOM by removing all of DataTables
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
148 enhancements, alterations to the DOM structure of the table and event listeners.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnDraw">fnDraw</a></span><span class="type-sig"><span class="signature">(<span class="optional">bComplete</span>)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Redraw the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnFilter">fnFilter</a></span><span class="type-sig"><span class="signature">(sInput, <span class="optional">iColumn</span>, <span class="optional">bRegex</span>, <span class="optional">bSmart</span>, <span class="optional">bShowGlobal</span>, <span class="optional">bCaseInsensitive</span>)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Filter the input based on data</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnGetData">fnGetData</a></span><span class="type-sig"><span class="signature">(<span class="optional">mRow</span>, <span class="optional">iCol</span>)</span><span class="type-signature"> &rarr; {array|object|string}</span></span></dt><dd class=" even"><p>Get the data for the whole table, an individual row or an individual cell based on the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
149 provided parameters.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnGetNodes">fnGetNodes</a></span><span class="type-sig"><span class="signature">(<span class="optional">iRow</span>)</span><span class="type-signature"> &rarr; {array|node}</span></span></dt><dd class=" odd"><p>Get an array of the TR nodes that are used in the table's body. Note that you will
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
150 typically want to use the '$' API method in preference to this as it is more
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
151 flexible.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnGetPosition">fnGetPosition</a></span><span class="type-sig"><span class="signature">(nNode)</span><span class="type-signature"> &rarr; {int}</span></span></dt><dd class=" even"><p>Get the array indexes of a particular cell from it's DOM element
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
152 and column index including hidden columns</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnIsOpen">fnIsOpen</a></span><span class="type-sig"><span class="signature">(nTr)</span><span class="type-signature"> &rarr; {boolean}</span></span></dt><dd class=" odd"><p>Check to see if a row is 'open' or not.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnOpen">fnOpen</a></span><span class="type-sig"><span class="signature">(nTr, mHtml, sClass)</span><span class="type-signature"> &rarr; {node}</span></span></dt><dd class=" even"><p>This function will place a new row directly after a row which is currently
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
153 on display on the page, with the HTML contents that is passed into the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
154 function. This can be used, for example, to ask for confirmation that a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
155 particular record should be deleted.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnPageChange">fnPageChange</a></span><span class="type-sig"><span class="signature">(mAction, <span class="optional">bRedraw</span>)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Change the pagination - provides the internal logic for pagination in a simple API
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
156 function. With this function you can have a DataTables table go to the next,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
157 previous, first or last pages.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnSetColumnVis">fnSetColumnVis</a></span><span class="type-sig"><span class="signature">(iCol, bShow, <span class="optional">bRedraw</span>)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Show a particular column</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnSettings">fnSettings</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></span></dt><dd class=" odd"><p>Get the settings for a particular table for external manipulation</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnSort">fnSort</a></span><span class="type-sig"><span class="signature">(iCol)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Sort the table by a particular column</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnSortListener">fnSortListener</a></span><span class="type-sig"><span class="signature">(nNode, iColumn, <span class="optional">fnCallback</span>)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Attach a sort listener to an element for a given column</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnUpdate">fnUpdate</a></span><span class="type-sig"><span class="signature">(mData, mRow, <span class="optional">iColumn</span>, <span class="optional">bRedraw</span>, <span class="optional">bAction</span>)</span><span class="type-signature"> &rarr; {int}</span></span></dt><dd class=" even"><p>Update a table cell or row - this method will accept either a single value to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
158 update the cell with, an array of values with one element for each column or
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
159 an object in the same format as the original data source. The function is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
160 self-referencing in order to make the multi column updates easier.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnVersionCheck">fnVersionCheck</a></span><span class="type-sig"><span class="signature">(sVersion)</span><span class="type-signature"> &rarr; {boolean}</span></span></dt><dd class=" odd"><p>Provide a common method for plug-ins to check the version of DataTables being used, in order
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
161 to ensure compatibility.</p></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
162 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
163 </div><div class="doc_group"><a name="summary_methods_static"></a><h3 class="subsection-title">Methods - static</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
164
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
165 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
166 <dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#fnIsDataTable">fnIsDataTable</a></span><span class="type-sig"><span class="signature">(nTable)</span><span class="type-signature"> &rarr; {boolean}</span></span></dt><dd class=" even"><p>Check if a TABLE node is a DataTable table already or not.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#fnTables">fnTables</a></span><span class="type-sig"><span class="signature">(<span class="optional">bVisible</span>)</span><span class="type-signature"> &rarr; {array}</span></span></dt><dd class=" odd"><p>Get all DataTable tables that have been initialised - optionally you can select to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
167 get only currently visible tables.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#fnVersionCheck">fnVersionCheck</a></span><span class="type-sig"><span class="signature">(sVersion)</span><span class="type-signature"> &rarr; {boolean}</span></span></dt><dd class=" even"><p>Provide a common method for plug-ins to check the version of DataTables being used, in order
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
168 to ensure compatibility.</p></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
169 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
170 </div><div class="doc_group"><a name="summary_events"></a><h3 class="subsection-title">Events</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
171 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
172 <dt class=" even"><span class="type-attr"></span><span class="type-name"><a href="#destroy">destroy</a></span><span class="type-sig"></span></dt><dd class=" even"><p>Destroy event, fired when the DataTable is destroyed by calling fnDestroy or passing
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
173 the bDestroy:true parameter in the initialisation object. This can be used to remove
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
174 bound events, added DOM nodes, etc.</p></dd><dt class=" odd"><span class="type-attr"></span><span class="type-name"><a href="#draw">draw</a></span><span class="type-sig"></span></dt><dd class=" odd"><p>Draw event, fired whenever the table is redrawn on the page, at the same point as
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
175 fnDrawCallback. This may be useful for binding events or performing calculations when
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
176 the table is altered at all.</p></dd><dt class=" even"><span class="type-attr"></span><span class="type-name"><a href="#filter">filter</a></span><span class="type-sig"></span></dt><dd class=" even"><p>Filter event, fired when the filtering applied to the table (using the build in global
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
177 global filter, or column filters) is altered.</p></dd><dt class=" odd"><span class="type-attr"></span><span class="type-name"><a href="#init">init</a></span><span class="type-sig"></span></dt><dd class=" odd"><p>DataTables initialisation complete event, fired when the table is fully drawn,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
178 including Ajax data loaded, if Ajax data is required.</p></dd><dt class=" even"><span class="type-attr"></span><span class="type-name"><a href="#page">page</a></span><span class="type-sig"></span></dt><dd class=" even"><p>Page change event, fired when the paging of the table is altered.</p></dd><dt class=" odd"><span class="type-attr"></span><span class="type-name"><a href="#processing">processing</a></span><span class="type-sig"></span></dt><dd class=" odd"><p>Processing event, fired when DataTables is doing some kind of processing (be it,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
179 sort, filter or anything else). Can be used to indicate to the end user that
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
180 there is something happening, or that something has finished.</p></dd><dt class=" even"><span class="type-attr"></span><span class="type-name"><a href="#sort">sort</a></span><span class="type-sig"></span></dt><dd class=" even"><p>Sort event, fired when the sorting applied to the table is altered.</p></dd><dt class=" odd"><span class="type-attr"></span><span class="type-name"><a href="#stateLoaded">stateLoaded</a></span><span class="type-sig"></span></dt><dd class=" odd"><p>State loaded event, fired when state has been loaded from stored data and the settings
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
181 object has been modified by the loaded data.</p></dd><dt class=" even"><span class="type-attr"></span><span class="type-name"><a href="#stateLoadParams">stateLoadParams</a></span><span class="type-sig"></span></dt><dd class=" even"><p>State load event, fired when the table is loading state from the stored data, but
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
182 prior to the settings object being modified by the saved state - allowing modification
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
183 of the saved state is required or loading of state for a plug-in.</p></dd><dt class=" odd"><span class="type-attr"></span><span class="type-name"><a href="#stateSaveParams">stateSaveParams</a></span><span class="type-sig"></span></dt><dd class=" odd"><p>State save event, fired when the table has changed state a new state save is required.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
184 This method allows modification of the state saving object prior to actually doing the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
185 save, including addition or other state properties (for plug-ins) or modification
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
186 of a DataTables core property.</p></dd><dt class=" even"><span class="type-attr"></span><span class="type-name"><a href="#xhr">xhr</a></span><span class="type-sig"></span></dt><dd class=" even"><p>Ajax (XHR) event, fired whenever an Ajax request is completed from a request to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
187 made to the server for new data (note that this trigger is called in fnServerData,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
188 if you override fnServerData and which to use this event, you need to trigger it in
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
189 you success function).</p></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
190 </dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
191 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
192 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
193
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
194
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
195
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
196
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
197 <div class="doc_details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
198 <a name="details"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
199 <h2>Details</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
200 <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
201 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
202 <dt class=" even"><a name="version"></a><a name="version_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#version">version</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Version string for plug-ins to check compatibility. Allowed format is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
203 a.b.c.d.e where: a:int, b:int, c:int, d:string(dev|beta), e:int. d and
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
204 e are optional</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
205
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
206 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
207 </div></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
208 </dl></div><div class="doc_group"><a name="details_methods"></a><h3 class="subsection-title">Methods - instance</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
209 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
210 <dt id="DataTable#$" class=" even"><a name="$"></a><a name="$_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>$</a></span><span class="type-sig"><span class="signature">(sSelector, <span class="optional">oOpts</span>)</span><span class="type-signature"> &rarr; {object}</span></span></span></dt><dd class=" even"><p>Perform a jQuery selector action on the table's TR elements (from the tbody) and
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
211 return the resulting jQuery object.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
212
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
213 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
214 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
215
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
216 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
217 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
218 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
219 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
220 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
221 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
222 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
223 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
224 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
225 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
226 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
227
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
228 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
229 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sSelector</td><td class="type type-param">string | node | jQuery</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery selector or node collection to act on</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oOpts</td><td class="type type-param">object</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>Optional parameters for modifying the rows to be included</p></td></tr><tr><td class="number right_border"></td><td class="name">oOpts.filter</td><td class="type type-param">string</td><td class="attributes">&lt;optional><br></td><td class="default">none</td><td class="description last"><p>Select TR elements that meet the current filter
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
230 criterion ("applied") or all TR elements (i.e. no filter).</p></td></tr><tr><td class="number right_border"></td><td class="name">oOpts.order</td><td class="type type-param">string</td><td class="attributes">&lt;optional><br></td><td class="default">current</td><td class="description last"><p>Order of the TR elements in the processed array.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
231 Can be either 'current', whereby the current sorting of the table is used, or
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
232 'original' whereby the original order the data was read into the table is used.</p></td></tr><tr><td class="number right_border"></td><td class="name">oOpts.page</td><td class="type type-param">string</td><td class="attributes">&lt;optional><br></td><td class="default">all</td><td class="description last"><p>Limit the selection to the currently displayed page
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
233 ("current") or not ("all"). If 'current' is given, then order is assumed to be
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
234 'current' and filter is 'applied', regardless of what they might be given as.</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
235 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
236 </table><h5>Returns:</h5><p class="returns"><p>jQuery object, filtered by the given selector.</p></p><h5>Examples:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
237 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
238 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
239 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
240
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
241 // Highlight every second row
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
242 oTable.$('tr:odd').css('backgroundColor', 'blue');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
243 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
244
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
245 </pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
246 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
247
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
248 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
249 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
250 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
251
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
252 // Filter to rows with 'Webkit' in them, add a background colour and then
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
253 // remove the filter, thus highlighting the 'Webkit' rows only.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
254 oTable.fnFilter('Webkit');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
255 oTable.$('tr', {"filter": "applied"}).css('backgroundColor', 'blue');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
256 oTable.fnFilter('');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
257 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
258 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
259 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
260 <dt id="DataTable#_" class=" odd"><a name="_"></a><a name="__details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_</a></span><span class="type-sig"><span class="signature">(sSelector, <span class="optional">oOpts</span>)</span><span class="type-signature"> &rarr; {array}</span></span></span></dt><dd class=" odd"><p>Almost identical to $ in operation, but in this case returns the data for the matched
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
261 rows - as such, the jQuery selector used should match TR row nodes or TD/TH cell nodes
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
262 rather than any descendants, so the data can be obtained for the row/cell. If matching
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
263 rows are found, the data returned is the original data array/object that was used to <br />
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
264 create the row (or a generated array if from a DOM source).</p>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
265
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
266 <p>This method is often useful in-combination with $ where both functions are given the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
267 same parameters and the array indexes will match identically.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
268
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
269 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
270 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
271
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
272 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
273 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
274 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
275 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
276 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
277 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
278 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
279 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
280 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
281 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
282 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
283
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
284 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
285 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sSelector</td><td class="type type-param">string | node | jQuery</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery selector or node collection to act on</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oOpts</td><td class="type type-param">object</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>Optional parameters for modifying the rows to be included</p></td></tr><tr><td class="number right_border"></td><td class="name">oOpts.filter</td><td class="type type-param">string</td><td class="attributes">&lt;optional><br></td><td class="default">none</td><td class="description last"><p>Select elements that meet the current filter
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
286 criterion ("applied") or all elements (i.e. no filter).</p></td></tr><tr><td class="number right_border"></td><td class="name">oOpts.order</td><td class="type type-param">string</td><td class="attributes">&lt;optional><br></td><td class="default">current</td><td class="description last"><p>Order of the data in the processed array.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
287 Can be either 'current', whereby the current sorting of the table is used, or
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
288 'original' whereby the original order the data was read into the table is used.</p></td></tr><tr><td class="number right_border"></td><td class="name">oOpts.page</td><td class="type type-param">string</td><td class="attributes">&lt;optional><br></td><td class="default">all</td><td class="description last"><p>Limit the selection to the currently displayed page
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
289 ("current") or not ("all"). If 'current' is given, then order is assumed to be
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
290 'current' and filter is 'applied', regardless of what they might be given as.</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
291 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
292 </table><h5>Returns:</h5><p class="returns"><p>Data for the matched elements. If any elements, as a result of the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
293 selector, were not TR, TD or TH elements in the DataTable, they will have a null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
294 entry in the array.</p></p><h5>Examples:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
295 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
296 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
297 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
298
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
299 // Get the data from the first row in the table
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
300 var data = oTable._('tr:first');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
301
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
302 // Do something useful with the data
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
303 alert( "First cell is: "+data[0] );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
304 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
305
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
306 </pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
307 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
308
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
309 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
310 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
311 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
312
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
313 // Filter to 'Webkit' and get all data for
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
314 oTable.fnFilter('Webkit');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
315 var data = oTable._('tr', {"filter": "applied"});
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
316
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
317 // Do something with the data
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
318 alert( data.length+" rows matched the filter" );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
319 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
320 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
321 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
322 <dt id="DataTable#fnAddData" class=" even"><a name="fnAddData"></a><a name="fnAddData_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnAddData</a></span><span class="type-sig"><span class="signature">(mData, <span class="optional">bRedraw</span>)</span><span class="type-signature"> &rarr; {array}</span></span></span></dt><dd class=" even"><p>Add a single new row or multiple rows of data to the table. Please note
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
323 that this is suitable for client-side processing only - if you are using
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
324 server-side processing (i.e. "bServerSide": true), then to add data, you
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
325 must add it to the data source, i.e. the server-side, through an Ajax call.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
326
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
327 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
328 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
329
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
330 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
331 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
332 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
333 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
334 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
335 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
336 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
337 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
338 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
339 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
340 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
341
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
342 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
343 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">mData</td><td class="type type-param">array | object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data to be added to the table. This can be:
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
344 <ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
345 <li>1D array of data - add a single row with the data provided</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
346 <li>2D array of arrays - add multiple rows in a single call</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
347 <li>object - data object when using <i>mData</i></li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
348 <li>array of objects - multiple data objects when using <i>mData</i></li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
349 </ul></p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">bRedraw</td><td class="type type-param">bool</td><td class="attributes">Optional</td><td class="default">true</td><td class="description last"><p>redraw the table or not</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
350 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
351 </table><h5>Returns:</h5><p class="returns"><p>An array of integers, representing the list of indexes in
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
352 <i>aoData</i> (<a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a>) that have been added to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
353 the table.</p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
354 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
355 <pre class="brush: js"> // Global var for counter
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
356 var giCount = 2;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
357
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
358 $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
359 $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
360 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
361
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
362 function fnClickAddRow() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
363 $('#example').dataTable().fnAddData( [
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
364 giCount+".1",
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
365 giCount+".2",
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
366 giCount+".3",
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
367 giCount+".4" ]
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
368 );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
369
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
370 giCount++;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
371 }</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
372 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
373 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
374 <dt id="DataTable#fnAdjustColumnSizing" class=" odd"><a name="fnAdjustColumnSizing"></a><a name="fnAdjustColumnSizing_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnAdjustColumnSizing</a></span><span class="type-sig"><span class="signature">(<span class="optional">bRedraw</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>This function will make DataTables recalculate the column sizes, based on the data
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
375 contained in the table and the sizes applied to the columns (in the DOM, CSS or
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
376 through the sWidth parameter). This can be useful when the width of the table's
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
377 parent element changes (for example a window resize).</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
378
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
379 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
380 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
381
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
382 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
383 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
384 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
385 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
386 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
387 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
388 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
389 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
390 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
391 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
392 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
393
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
394 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
395 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">bRedraw</td><td class="type type-param">boolean</td><td class="attributes">Optional</td><td class="default">true</td><td class="description last"><p>Redraw the table or not, you will typically want to</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
396 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
397 </table><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
398 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
399 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
400 var oTable = $('#example').dataTable( {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
401 "sScrollY": "200px",
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
402 "bPaginate": false
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
403 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
404
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
405 $(window).bind('resize', function () {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
406 oTable.fnAdjustColumnSizing();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
407 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
408 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
409 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
410 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
411 <dt id="DataTable#fnClearTable" class=" even"><a name="fnClearTable"></a><a name="fnClearTable_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnClearTable</a></span><span class="type-sig"><span class="signature">(<span class="optional">bRedraw</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Quickly and simply clear a table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
412
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
413 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
414 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
415
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
416 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
417 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
418 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
419 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
420 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
421 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
422 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
423 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
424 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
425 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
426 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
427
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
428 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
429 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">bRedraw</td><td class="type type-param">bool</td><td class="attributes">Optional</td><td class="default">true</td><td class="description last"><p>redraw the table or not</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
430 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
431 </table><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
432 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
433 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
434 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
435
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
436 // Immediately 'nuke' the current rows (perhaps waiting for an Ajax callback...)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
437 oTable.fnClearTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
438 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
439 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
440 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
441 <dt id="DataTable#fnClose" class=" odd"><a name="fnClose"></a><a name="fnClose_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnClose</a></span><span class="type-sig"><span class="signature">(nTr)</span><span class="type-signature"> &rarr; {int}</span></span></span></dt><dd class=" odd"><p>The exact opposite of 'opening' a row, this function will close any rows which
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
442 are currently 'open'.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
443
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
444 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
445 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
446
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
447 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
448 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
449 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
450 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
451 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
452 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
453 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
454 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
455 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
456 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
457 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
458
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
459 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
460 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nTr</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>the table row to 'close'</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
461 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
462 </table><h5>Returns:</h5><p class="returns"><p>0 on success, or 1 if failed (can't find the row)</p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
463 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
464 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
465 var oTable;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
466
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
467 // 'open' an information row when a row is clicked on
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
468 $('#example tbody tr').click( function () {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
469 if ( oTable.fnIsOpen(this) ) {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
470 oTable.fnClose( this );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
471 } else {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
472 oTable.fnOpen( this, "Temporary row opened", "info_row" );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
473 }
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
474 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
475
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
476 oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
477 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
478 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
479 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
480 <dt id="DataTable#fnDeleteRow" class=" even"><a name="fnDeleteRow"></a><a name="fnDeleteRow_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnDeleteRow</a></span><span class="type-sig"><span class="signature">(mTarget, <span class="optional">fnCallBack</span>, <span class="optional">bRedraw</span>)</span><span class="type-signature"> &rarr; {array}</span></span></span></dt><dd class=" even"><p>Remove a row for the table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
481
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
482 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
483 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
484
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
485 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
486 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
487 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
488 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
489 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
490 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
491 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
492 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
493 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
494 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
495 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
496
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
497 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
498 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">mTarget</td><td class="type type-param">mixed</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The index of the row from aoData to be deleted, or
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
499 the TR element you want to delete</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">fnCallBack</td><td class="type type-param">function | null</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>Callback function</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">bRedraw</td><td class="type type-param">bool</td><td class="attributes">Optional</td><td class="default">true</td><td class="description last"><p>Redraw the table or not</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
500 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
501 </table><h5>Returns:</h5><p class="returns"><p>The row that was deleted</p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
502 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
503 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
504 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
505
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
506 // Immediately remove the first row
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
507 oTable.fnDeleteRow( 0 );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
508 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
509 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
510 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
511 <dt id="DataTable#fnDestroy" class=" odd"><a name="fnDestroy"></a><a name="fnDestroy_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnDestroy</a></span><span class="type-sig"><span class="signature">(<span class="optional">bRemove</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Restore the table to it's original state in the DOM by removing all of DataTables
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
512 enhancements, alterations to the DOM structure of the table and event listeners.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
513
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
514 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
515 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
516
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
517 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
518 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
519 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
520 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
521 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
522 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
523 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
524 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
525 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
526 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
527 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
528
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
529 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
530 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">bRemove</td><td class="type type-param">boolean</td><td class="attributes">Optional</td><td class="default">false</td><td class="description last"><p>Completely remove the table from the DOM</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
531 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
532 </table><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
533 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
534 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
535 // This example is fairly pointless in reality, but shows how fnDestroy can be used
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
536 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
537 oTable.fnDestroy();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
538 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
539 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
540 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
541 <dt id="DataTable#fnDraw" class=" even"><a name="fnDraw"></a><a name="fnDraw_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnDraw</a></span><span class="type-sig"><span class="signature">(<span class="optional">bComplete</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Redraw the table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
542
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
543 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
544 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
545
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
546 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
547 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
548 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
549 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
550 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
551 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
552 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
553 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
554 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
555 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
556 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
557
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
558 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
559 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">bComplete</td><td class="type type-param">bool</td><td class="attributes">Optional</td><td class="default">true</td><td class="description last"><p>Re-filter and resort (if enabled) the table before the draw.</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
560 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
561 </table><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
562 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
563 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
564 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
565
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
566 // Re-draw the table - you wouldn't want to do it here, but it's an example :-)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
567 oTable.fnDraw();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
568 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
569 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
570 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
571 <dt id="DataTable#fnFilter" class=" odd"><a name="fnFilter"></a><a name="fnFilter_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnFilter</a></span><span class="type-sig"><span class="signature">(sInput, <span class="optional">iColumn</span>, <span class="optional">bRegex</span>, <span class="optional">bSmart</span>, <span class="optional">bShowGlobal</span>, <span class="optional">bCaseInsensitive</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Filter the input based on data</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
572
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
573 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
574 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
575
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
576 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
577 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
578 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
579 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
580 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
581 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
582 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
583 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
584 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
585 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
586 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
587
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
588 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
589 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sInput</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>String to filter the table on</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iColumn</td><td class="type type-param">int | null</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>Column to limit filtering to</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">bRegex</td><td class="type type-param">bool</td><td class="attributes">Optional</td><td class="default">false</td><td class="description last"><p>Treat as regular expression or not</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">bSmart</td><td class="type type-param">bool</td><td class="attributes">Optional</td><td class="default">true</td><td class="description last"><p>Perform smart filtering or not</p></td></tr><tr class="even"><td class="number right_border"><div>5</div></td><td class="name">bShowGlobal</td><td class="type type-param">bool</td><td class="attributes">Optional</td><td class="default">true</td><td class="description last"><p>Show the input global filter in it's input box(es)</p></td></tr><tr class="odd"><td class="number right_border"><div>6</div></td><td class="name">bCaseInsensitive</td><td class="type type-param">bool</td><td class="attributes">Optional</td><td class="default">true</td><td class="description last"><p>Do case-insensitive matching (true) or not (false)</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
590 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
591 </table><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
592 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
593 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
594 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
595
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
596 // Sometime later - filter...
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
597 oTable.fnFilter( 'test string' );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
598 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
599 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
600 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
601 <dt id="DataTable#fnGetData" class=" even"><a name="fnGetData"></a><a name="fnGetData_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnGetData</a></span><span class="type-sig"><span class="signature">(<span class="optional">mRow</span>, <span class="optional">iCol</span>)</span><span class="type-signature"> &rarr; {array|object|string}</span></span></span></dt><dd class=" even"><p>Get the data for the whole table, an individual row or an individual cell based on the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
602 provided parameters.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
603
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
604 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
605 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
606
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
607 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
608 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
609 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
610 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
611 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
612 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
613 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
614 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
615 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
616 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
617 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
618
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
619 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
620 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">mRow</td><td class="type type-param">int | node</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>A TR row node, TD/TH cell node or an integer. If given as
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
621 a TR node then the data source for the whole row will be returned. If given as a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
622 TD/TH cell node then iCol will be automatically calculated and the data for the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
623 cell returned. If given as an integer, then this is treated as the aoData internal
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
624 data index for the row (see fnGetPosition) and the data for that row used.</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iCol</td><td class="type type-param">int</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>Optional column index that you want the data of.</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
625 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
626 </table><h5>Returns:</h5><p class="returns"><p>If mRow is undefined, then the data for all rows is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
627 returned. If mRow is defined, just data for that row, and is iCol is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
628 defined, only data for the designated cell is returned.</p></p><h5>Examples:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
629 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
630 <pre class="brush: js"> // Row data
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
631 $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
632 oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
633
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
634 oTable.$('tr').click( function () {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
635 var data = oTable.fnGetData( this );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
636 // ... do something with the array / object of data for the row
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
637 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
638 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
639
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
640 </pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
641 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
642
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
643 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
644 <pre class="brush: js"> // Individual cell data
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
645 $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
646 oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
647
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
648 oTable.$('td').click( function () {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
649 var sData = oTable.fnGetData( this );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
650 alert( 'The cell clicked on had the value of '+sData );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
651 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
652 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
653 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
654 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
655 <dt id="DataTable#fnGetNodes" class=" odd"><a name="fnGetNodes"></a><a name="fnGetNodes_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnGetNodes</a></span><span class="type-sig"><span class="signature">(<span class="optional">iRow</span>)</span><span class="type-signature"> &rarr; {array|node}</span></span></span></dt><dd class=" odd"><p>Get an array of the TR nodes that are used in the table's body. Note that you will
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
656 typically want to use the '$' API method in preference to this as it is more
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
657 flexible.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
658
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
659 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
660 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
661
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
662 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
663 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
664 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
665 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
666 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
667 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
668 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
669 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
670 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
671 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
672 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
673
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
674 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
675 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>Optional row index for the TR element you want</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
676 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
677 </table><h5>Returns:</h5><p class="returns"><p>If iRow is undefined, returns an array of all TR elements
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
678 in the table's body, or iRow is defined, just the TR element requested.</p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
679 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
680 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
681 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
682
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
683 // Get the nodes from the table
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
684 var nNodes = oTable.fnGetNodes( );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
685 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
686 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
687 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
688 <dt id="DataTable#fnGetPosition" class=" even"><a name="fnGetPosition"></a><a name="fnGetPosition_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnGetPosition</a></span><span class="type-sig"><span class="signature">(nNode)</span><span class="type-signature"> &rarr; {int}</span></span></span></dt><dd class=" even"><p>Get the array indexes of a particular cell from it's DOM element
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
689 and column index including hidden columns</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
690
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
691 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
692 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
693
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
694 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
695 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
696 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
697 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
698 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
699 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
700 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
701 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
702 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
703 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
704 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
705
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
706 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
707 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nNode</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>this can either be a TR, TD or TH in the table's body</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
708 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
709 </table><h5>Returns:</h5><p class="returns"><p>If nNode is given as a TR, then a single index is returned, or
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
710 if given as a cell, an array of [row index, column index (visible),
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
711 column index (all)] is given.</p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
712 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
713 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
714 $('#example tbody td').click( function () {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
715 // Get the position of the current data from the node
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
716 var aPos = oTable.fnGetPosition( this );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
717
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
718 // Get the data array for this row
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
719 var aData = oTable.fnGetData( aPos[0] );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
720
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
721 // Update the data array and return the value
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
722 aData[ aPos[1] ] = 'clicked';
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
723 this.innerHTML = 'clicked';
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
724 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
725
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
726 // Init DataTables
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
727 oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
728 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
729 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
730 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
731 <dt id="DataTable#fnIsOpen" class=" odd"><a name="fnIsOpen"></a><a name="fnIsOpen_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnIsOpen</a></span><span class="type-sig"><span class="signature">(nTr)</span><span class="type-signature"> &rarr; {boolean}</span></span></span></dt><dd class=" odd"><p>Check to see if a row is 'open' or not.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
732
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
733 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
734 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
735
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
736 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
737 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
738 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
739 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
740 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
741 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
742 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
743 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
744 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
745 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
746 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
747
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
748 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
749 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nTr</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>the table row to check</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
750 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
751 </table><h5>Returns:</h5><p class="returns"><p>true if the row is currently open, false otherwise</p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
752 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
753 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
754 var oTable;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
755
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
756 // 'open' an information row when a row is clicked on
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
757 $('#example tbody tr').click( function () {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
758 if ( oTable.fnIsOpen(this) ) {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
759 oTable.fnClose( this );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
760 } else {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
761 oTable.fnOpen( this, "Temporary row opened", "info_row" );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
762 }
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
763 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
764
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
765 oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
766 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
767 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
768 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
769 <dt id="DataTable#fnOpen" class=" even"><a name="fnOpen"></a><a name="fnOpen_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnOpen</a></span><span class="type-sig"><span class="signature">(nTr, mHtml, sClass)</span><span class="type-signature"> &rarr; {node}</span></span></span></dt><dd class=" even"><p>This function will place a new row directly after a row which is currently
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
770 on display on the page, with the HTML contents that is passed into the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
771 function. This can be used, for example, to ask for confirmation that a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
772 particular record should be deleted.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
773
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
774 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
775 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
776
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
777 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
778 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
779 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
780 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
781 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
782 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
783 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
784 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
785 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
786 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
787 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
788
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
789 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
790 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nTr</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The table row to 'open'</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">mHtml</td><td class="type type-param">string | node | jQuery</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The HTML to put into the row</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">sClass</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Class to give the new TD cell</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
791 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
792 </table><h5>Returns:</h5><p class="returns"><p>The row opened. Note that if the table row passed in as the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
793 first parameter, is not found in the table, this method will silently
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
794 return.</p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
795 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
796 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
797 var oTable;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
798
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
799 // 'open' an information row when a row is clicked on
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
800 $('#example tbody tr').click( function () {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
801 if ( oTable.fnIsOpen(this) ) {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
802 oTable.fnClose( this );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
803 } else {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
804 oTable.fnOpen( this, "Temporary row opened", "info_row" );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
805 }
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
806 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
807
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
808 oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
809 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
810 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
811 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
812 <dt id="DataTable#fnPageChange" class=" odd"><a name="fnPageChange"></a><a name="fnPageChange_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnPageChange</a></span><span class="type-sig"><span class="signature">(mAction, <span class="optional">bRedraw</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Change the pagination - provides the internal logic for pagination in a simple API
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
813 function. With this function you can have a DataTables table go to the next,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
814 previous, first or last pages.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
815
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
816 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
817 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
818
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
819 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
820 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
821 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
822 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
823 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
824 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
825 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
826 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
827 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
828 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
829 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
830
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
831 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
832 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">mAction</td><td class="type type-param">string | int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Paging action to take: "first", "previous", "next" or "last"
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
833 or page number to jump to (integer), note that page 0 is the first page.</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">bRedraw</td><td class="type type-param">bool</td><td class="attributes">Optional</td><td class="default">true</td><td class="description last"><p>Redraw the table or not</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
834 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
835 </table><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
836 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
837 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
838 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
839 oTable.fnPageChange( 'next' );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
840 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
841 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
842 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
843 <dt id="DataTable#fnSetColumnVis" class=" even"><a name="fnSetColumnVis"></a><a name="fnSetColumnVis_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnSetColumnVis</a></span><span class="type-sig"><span class="signature">(iCol, bShow, <span class="optional">bRedraw</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Show a particular column</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
844
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
845 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
846 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
847
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
848 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
849 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
850 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
851 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
852 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
853 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
854 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
855 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
856 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
857 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
858 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
859
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
860 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
861 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">iCol</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The column whose display should be changed</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">bShow</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Show (true) or hide (false) the column</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">bRedraw</td><td class="type type-param">bool</td><td class="attributes">Optional</td><td class="default">true</td><td class="description last"><p>Redraw the table or not</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
862 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
863 </table><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
864 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
865 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
866 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
867
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
868 // Hide the second column after initialisation
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
869 oTable.fnSetColumnVis( 1, false );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
870 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
871 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
872 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
873 <dt id="DataTable#fnSettings" class=" odd"><a name="fnSettings"></a><a name="fnSettings_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnSettings</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></span></span></dt><dd class=" odd"><p>Get the settings for a particular table for external manipulation</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
874
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
875 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
876 <h5>Returns:</h5><p class="returns"><p>DataTables settings object. See
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
877 <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a></p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
878 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
879 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
880 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
881 var oSettings = oTable.fnSettings();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
882
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
883 // Show an example parameter from the settings
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
884 alert( oSettings._iDisplayStart );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
885 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
886 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
887 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
888 <dt id="DataTable#fnSort" class=" even"><a name="fnSort"></a><a name="fnSort_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnSort</a></span><span class="type-sig"><span class="signature">(iCol)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Sort the table by a particular column</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
889
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
890 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
891 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
892
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
893 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
894 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
895 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
896 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
897 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
898 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
899 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
900 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
901 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
902 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
903 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
904
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
905 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
906 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">iCol</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>the data index to sort on. Note that this will not match the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
907 'display index' if you have hidden data entries</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
908 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
909 </table><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
910 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
911 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
912 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
913
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
914 // Sort immediately with columns 0 and 1
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
915 oTable.fnSort( [ [0,'asc'], [1,'asc'] ] );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
916 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
917 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
918 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
919 <dt id="DataTable#fnSortListener" class=" odd"><a name="fnSortListener"></a><a name="fnSortListener_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnSortListener</a></span><span class="type-sig"><span class="signature">(nNode, iColumn, <span class="optional">fnCallback</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Attach a sort listener to an element for a given column</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
920
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
921 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
922 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
923
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
924 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
925 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
926 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
927 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
928 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
929 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
930 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
931 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
932 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
933 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
934 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
935
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
936 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
937 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nNode</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>the element to attach the sort listener to</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iColumn</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>the column that a click on this node will sort on</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">fnCallback</td><td class="type type-param">function</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>callback function when sort is run</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
938 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
939 </table><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
940 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
941 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
942 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
943
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
944 // Sort on column 1, when 'sorter' is clicked on
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
945 oTable.fnSortListener( document.getElementById('sorter'), 1 );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
946 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
947 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
948 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
949 <dt id="DataTable#fnUpdate" class=" even"><a name="fnUpdate"></a><a name="fnUpdate_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnUpdate</a></span><span class="type-sig"><span class="signature">(mData, mRow, <span class="optional">iColumn</span>, <span class="optional">bRedraw</span>, <span class="optional">bAction</span>)</span><span class="type-signature"> &rarr; {int}</span></span></span></dt><dd class=" even"><p>Update a table cell or row - this method will accept either a single value to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
950 update the cell with, an array of values with one element for each column or
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
951 an object in the same format as the original data source. The function is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
952 self-referencing in order to make the multi column updates easier.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
953
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
954 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
955 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
956
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
957 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
958 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
959 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
960 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
961 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
962 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
963 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
964 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
965 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
966 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
967 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
968
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
969 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
970 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">mData</td><td class="type type-param">object | array | string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Data to update the cell/row with</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">mRow</td><td class="type type-param">node | int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>TR element you want to update or the aoData index</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iColumn</td><td class="type type-param">int</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>The column to update (not used of mData is an array or object)</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">bRedraw</td><td class="type type-param">bool</td><td class="attributes">Optional</td><td class="default">true</td><td class="description last"><p>Redraw the table or not</p></td></tr><tr class="even"><td class="number right_border"><div>5</div></td><td class="name">bAction</td><td class="type type-param">bool</td><td class="attributes">Optional</td><td class="default">true</td><td class="description last"><p>Perform pre-draw actions or not</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
971 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
972 </table><h5>Returns:</h5><p class="returns"><p>0 on success, 1 on error</p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
973 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
974 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
975 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
976 oTable.fnUpdate( 'Example update', 0, 0 ); // Single cell
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
977 oTable.fnUpdate( ['a', 'b', 'c', 'd', 'e'], 1, 0 ); // Row
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
978 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
979 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
980 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
981 <dt id="DataTable#fnVersionCheck" class=" odd"><a name="fnVersionCheck"></a><a name="fnVersionCheck_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnVersionCheck</a></span><span class="type-sig"><span class="signature">(sVersion)</span><span class="type-signature"> &rarr; {boolean}</span></span></span></dt><dd class=" odd"><p>Provide a common method for plug-ins to check the version of DataTables being used, in order
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
982 to ensure compatibility.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
983
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
984 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
985 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
986
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
987 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
988 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
989 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
990 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
991 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
992 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
993 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
994 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
995 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
996 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
997 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
998
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
999 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1000 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sVersion</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Version string to check for, in the format "X.Y.Z". Note that the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1001 formats "X" and "X.Y" are also acceptable.</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1002 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1003 </table><h5>Returns:</h5><p class="returns"><p>true if this version of DataTables is greater or equal to the required
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1004 version, or false if this version of DataTales is not suitable</p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1005 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1006 <pre class="brush: js"> $(document).ready(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1007 var oTable = $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1008 alert( oTable.fnVersionCheck( '1.9.0' ) );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1009 } );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1010 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1011 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1012
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1013 </dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1014 </div><div class="doc_group"><a name="details_methods"></a><h3 class="subsection-title">Methods - static</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1015 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1016 <dt id="DataTable.fnIsDataTable" class=" even"><a name="fnIsDataTable"></a><a name="fnIsDataTable_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>fnIsDataTable</a></span><span class="type-sig"><span class="signature">(nTable)</span><span class="type-signature"> &rarr; {boolean}</span></span></span></dt><dd class=" even"><p>Check if a TABLE node is a DataTable table already or not.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1017
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1018 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1019 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1020
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1021 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1022 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1023 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1024 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1025 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1026 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1027 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1028 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1029 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1030 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1031 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1032
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1033 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1034 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nTable</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The TABLE node to check if it is a DataTable or not (note that other
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1035 node types can be passed in, but will always return false).</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1036 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1037 </table><h5>Returns:</h5><p class="returns"><p>true the table given is a DataTable, or false otherwise</p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1038 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1039 <pre class="brush: js"> var ex = document.getElementById('example');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1040 if ( ! $.fn.DataTable.fnIsDataTable( ex ) ) {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1041 $(ex).dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1042 }</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1043 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1044 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1045 <dt id="DataTable.fnTables" class=" odd"><a name="fnTables"></a><a name="fnTables_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>fnTables</a></span><span class="type-sig"><span class="signature">(<span class="optional">bVisible</span>)</span><span class="type-signature"> &rarr; {array}</span></span></span></dt><dd class=" odd"><p>Get all DataTable tables that have been initialised - optionally you can select to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1046 get only currently visible tables.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1047
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1048 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1049 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1050
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1051 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1052 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1053 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1054 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1055 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1056 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1057 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1058 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1059 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1060 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1061 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1062
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1063 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1064 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">bVisible</td><td class="type type-param">boolean</td><td class="attributes">Optional</td><td class="default">false</td><td class="description last"><p>Flag to indicate if you want all (default) or
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1065 visible tables only.</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1066 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1067 </table><h5>Returns:</h5><p class="returns"><p>Array of TABLE nodes (not DataTable instances) which are DataTables</p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1068 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1069 <pre class="brush: js"> var table = $.fn.dataTable.fnTables(true);
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1070 if ( table.length > 0 ) {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1071 $(table).dataTable().fnAdjustColumnSizing();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1072 }</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1073 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1074 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1075 <dt id="DataTable.fnVersionCheck" class=" even"><a name="fnVersionCheck"></a><a name="fnVersionCheck_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>fnVersionCheck</a></span><span class="type-sig"><span class="signature">(sVersion)</span><span class="type-signature"> &rarr; {boolean}</span></span></span></dt><dd class=" even"><p>Provide a common method for plug-ins to check the version of DataTables being used, in order
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1076 to ensure compatibility.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1077
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1078 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1079 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1080
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1081 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1082 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1083 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1084 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1085 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1086 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1087 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1088 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1089 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1090 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1091 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1092
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1093 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1094 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sVersion</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Version string to check for, in the format "X.Y.Z". Note that the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1095 formats "X" and "X.Y" are also acceptable.</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1096 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1097 </table><h5>Returns:</h5><p class="returns"><p>true if this version of DataTables is greater or equal to the required
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1098 version, or false if this version of DataTales is not suitable</p></p><h5>Example:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1099 <div class="example-code">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1100 <pre class="brush: js"> alert( $.fn.dataTable.fnVersionCheck( '1.9.0' ) );</pre>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1101 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1102 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1103
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1104 </dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1105 </div><div class="doc_group"><a name="details_events"></a><h3 class="subsection-title">Events</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1106 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1107 <dt id="DataTable#event:destroy" class=" even"><a name="destroy"></a><a name="destroy_details"></a><span class="type-attr"></span><span class="type-name"><a>destroy</a></span><span class="type-sig"></span></span></dt><dd class=" even"><p>Destroy event, fired when the DataTable is destroyed by calling fnDestroy or passing
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1108 the bDestroy:true parameter in the initialisation object. This can be used to remove
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1109 bound events, added DOM nodes, etc.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1110
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1111 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1112 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1113
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1114 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1115 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1116 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1117 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1118 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1119 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1120 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1121 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1122 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1123 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1124 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1125
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1126 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1127 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">event</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery event object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">o</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables settings object <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a></p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1128 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1129 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1130 <dt id="DataTable#event:draw" class=" odd"><a name="draw"></a><a name="draw_details"></a><span class="type-attr"></span><span class="type-name"><a>draw</a></span><span class="type-sig"></span></span></dt><dd class=" odd"><p>Draw event, fired whenever the table is redrawn on the page, at the same point as
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1131 fnDrawCallback. This may be useful for binding events or performing calculations when
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1132 the table is altered at all.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1133
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1134 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1135 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1136
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1137 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1138 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1139 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1140 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1141 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1142 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1143 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1144 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1145 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1146 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1147 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1148
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1149 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1150 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">event</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery event object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">o</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables settings object <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a></p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1151 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1152 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1153 <dt id="DataTable#event:filter" class=" even"><a name="filter"></a><a name="filter_details"></a><span class="type-attr"></span><span class="type-name"><a>filter</a></span><span class="type-sig"></span></span></dt><dd class=" even"><p>Filter event, fired when the filtering applied to the table (using the build in global
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1154 global filter, or column filters) is altered.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1155
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1156 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1157 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1158
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1159 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1160 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1161 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1162 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1163 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1164 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1165 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1166 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1167 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1168 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1169 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1170
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1171 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1172 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">event</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery event object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">o</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables settings object <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a></p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1173 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1174 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1175 <dt id="DataTable#event:init" class=" odd"><a name="init"></a><a name="init_details"></a><span class="type-attr"></span><span class="type-name"><a>init</a></span><span class="type-sig"></span></span></dt><dd class=" odd"><p>DataTables initialisation complete event, fired when the table is fully drawn,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1176 including Ajax data loaded, if Ajax data is required.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1177
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1178 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1179 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1180
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1181 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1182 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1183 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1184 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1185 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1186 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1187 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1188 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1189 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1190 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1191 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1192
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1193 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1194 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">event</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery event object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables settings object</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">json</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The JSON object request from the server - only
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1195 present if client-side Ajax sourced data is used</li></ol></p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1196 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1197 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1198 <dt id="DataTable#event:page" class=" even"><a name="page"></a><a name="page_details"></a><span class="type-attr"></span><span class="type-name"><a>page</a></span><span class="type-sig"></span></span></dt><dd class=" even"><p>Page change event, fired when the paging of the table is altered.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1199
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1200 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1201 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1202
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1203 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1204 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1205 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1206 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1207 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1208 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1209 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1210 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1211 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1212 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1213 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1214
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1215 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1216 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">event</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery event object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">o</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables settings object <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a></p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1217 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1218 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1219 <dt id="DataTable#event:processing" class=" odd"><a name="processing"></a><a name="processing_details"></a><span class="type-attr"></span><span class="type-name"><a>processing</a></span><span class="type-sig"></span></span></dt><dd class=" odd"><p>Processing event, fired when DataTables is doing some kind of processing (be it,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1220 sort, filter or anything else). Can be used to indicate to the end user that
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1221 there is something happening, or that something has finished.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1222
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1223 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1224 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1225
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1226 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1227 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1228 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1229 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1230 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1231 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1232 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1233 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1234 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1235 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1236 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1237
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1238 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1239 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">event</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery event object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables settings object</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">bShow</td><td class="type type-param">boolean</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Flag for if DataTables is doing processing or not</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1240 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1241 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1242 <dt id="DataTable#event:sort" class=" even"><a name="sort"></a><a name="sort_details"></a><span class="type-attr"></span><span class="type-name"><a>sort</a></span><span class="type-sig"></span></span></dt><dd class=" even"><p>Sort event, fired when the sorting applied to the table is altered.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1243
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1244 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1245 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1246
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1247 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1248 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1249 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1250 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1251 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1252 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1253 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1254 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1255 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1256 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1257 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1258
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1259 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1260 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">event</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery event object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">o</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables settings object <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a></p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1261 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1262 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1263 <dt id="DataTable#event:stateLoaded" class=" odd"><a name="stateLoaded"></a><a name="stateLoaded_details"></a><span class="type-attr"></span><span class="type-name"><a>stateLoaded</a></span><span class="type-sig"></span></span></dt><dd class=" odd"><p>State loaded event, fired when state has been loaded from stored data and the settings
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1264 object has been modified by the loaded data.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1265
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1266 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1267 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1268
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1269 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1270 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1271 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1272 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1273 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1274 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1275 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1276 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1277 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1278 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1279 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1280
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1281 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1282 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">event</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery event object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables settings object</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">json</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The saved state information</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1283 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1284 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1285 <dt id="DataTable#event:stateLoadParams" class=" even"><a name="stateLoadParams"></a><a name="stateLoadParams_details"></a><span class="type-attr"></span><span class="type-name"><a>stateLoadParams</a></span><span class="type-sig"></span></span></dt><dd class=" even"><p>State load event, fired when the table is loading state from the stored data, but
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1286 prior to the settings object being modified by the saved state - allowing modification
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1287 of the saved state is required or loading of state for a plug-in.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1288
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1289 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1290 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1291
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1292 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1293 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1294 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1295 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1296 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1297 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1298 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1299 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1300 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1301 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1302 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1303
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1304 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1305 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">event</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery event object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables settings object</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">json</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The saved state information</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1306 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1307 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1308 <dt id="DataTable#event:stateSaveParams" class=" odd"><a name="stateSaveParams"></a><a name="stateSaveParams_details"></a><span class="type-attr"></span><span class="type-name"><a>stateSaveParams</a></span><span class="type-sig"></span></span></dt><dd class=" odd"><p>State save event, fired when the table has changed state a new state save is required.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1309 This method allows modification of the state saving object prior to actually doing the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1310 save, including addition or other state properties (for plug-ins) or modification
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1311 of a DataTables core property.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1312
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1313 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1314 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1315
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1316 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1317 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1318 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1319 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1320 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1321 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1322 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1323 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1324 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1325 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1326 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1327
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1328 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1329 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">event</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery event object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables settings object</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">json</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The state information to be saved</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1330 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1331 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1332 <dt id="DataTable#event:xhr" class=" even"><a name="xhr"></a><a name="xhr_details"></a><span class="type-attr"></span><span class="type-name"><a>xhr</a></span><span class="type-sig"></span></span></dt><dd class=" even"><p>Ajax (XHR) event, fired whenever an Ajax request is completed from a request to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1333 made to the server for new data (note that this trigger is called in fnServerData,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1334 if you override fnServerData and which to use this event, you need to trigger it in
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1335 you success function).</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1336
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1337 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1338 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1339
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1340 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1341 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1342 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1343 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1344 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1345 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1346 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1347 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1348 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1349 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1350 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1351
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1352 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1353 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">event</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>jQuery event object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">o</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables settings object <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a></p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">json</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>JSON returned from the server</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1354 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1355 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1356
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1357 </dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1358 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1359 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1360
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1361 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1362
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1363 <div class="fw_footer">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1364 DataTables: Copyright 2008-2012 Allan Jardine, all rights reserved<br>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1365
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1366 Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1367 23th Sep 2012 - 14:27
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1368 with the <a href="http://datatables.net/">DataTables</a> template.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1369 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1370 </body>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1371 </html>