annotate DataTables-1.9.4/docs/34cdb56b2c.html @ 3:4a6ebda2a3ae draft

fixed tool dependency issue
author saskia-hiltemann
date Tue, 30 Sep 2014 09:56:12 -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>Namespace: oApi - 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">Namespace: oApi</h1>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
24 <h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a>#</span> ยป oApi</h2>
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>Namespaces (0)</td></tr><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (1)</a></td></tr><tr><td>Methods (0)</td><td><a href="#summary_methods_static">Static methods (85)</a></td></tr><tr><td>Events (0)</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>Methods (0)</td><td><a href="#summary_methods_static">Static methods (85)</a></td></tr><tr><td>Events (0)</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 <p>Reference to internal functions for use by plug-in developers. Note that these
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
56 methods are references to internal functions and are considered to be private.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
57 If you use these methods, be aware that they are liable to change between versions
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
58 (check the upgrade notes).</p><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
59
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
60 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
61
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
62 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
63
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
64
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
65 <div class="doc_summary">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
66 <a name="summary"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
67 <h2>Summary</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
68
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
69 <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
70
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
71 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
72 <dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnJsonString">_fnJsonString</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" even"><p>JSON stringify. If JSON.stringify it provided by the browser, json2.js or any other
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
73 library, then we use that as it is fast, safe and accurate. If the function isn't
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
74 available then we need to built it ourselves - the inspiration for this function comes
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
75 from Craig Buckler ( <a href='http://www.sitepoint.com/javascript-json-serialization/'>http://www.sitepoint.com/javascript-json-serialization/</a> ). It is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
76 not perfect and absolutely should not be used as a replacement to json2.js - but it does
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
77 do what we need, without requiring a dependency for DataTables.</p></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
78 </dl></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
79
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
80 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
81 <dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnAddColumn">_fnAddColumn</a></span><span class="type-sig"><span class="signature">(oSettings, nTh)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Add a column to the list used for the table with default values</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnAddData">_fnAddData</a></span><span class="type-sig"><span class="signature">(oSettings, aData)</span><span class="type-signature"> &rarr; {int}</span></span></dt><dd class=" odd"><p>Add a data array to the table, creating DOM node etc. This is the parallel to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
82 _fnGatherData, but for adding rows from a Javascript source, rather than a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
83 DOM source.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnAddOptionsHtml">_fnAddOptionsHtml</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Add the options to the page HTML for the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnAdjustColumnSizing">_fnAdjustColumnSizing</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Adjust the table column widths for new data. Note: you would probably want to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
84 do a redraw after calling this function!</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnAjaxParameters">_fnAjaxParameters</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {bool}</span></span></dt><dd class=" even"><p>Build up the parameters in an object needed for a server-side processing request</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnAjaxUpdate">_fnAjaxUpdate</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {boolean}</span></span></dt><dd class=" odd"><p>Update the table using an Ajax call</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnAjaxUpdateDraw">_fnAjaxUpdateDraw</a></span><span class="type-sig"><span class="signature">(oSettings, json)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Data the data from the server (nuking the old) and redraw the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnApplyColumnDefs">_fnApplyColumnDefs</a></span><span class="type-sig"><span class="signature">(oSettings, aoColDefs, aoCols, fn)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Take the column definitions and static columns arrays and calculate how
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
85 they relate to column indexes. The callback function will then apply the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
86 definition found for a column to a suitable configuration object.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnApplyToChildren">_fnApplyToChildren</a></span><span class="type-sig"><span class="signature">(fn, array, array)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Apply a given function to the display child nodes of an element array (typically
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
87 TD children of TR rows</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnBindAction">_fnBindAction</a></span><span class="type-sig"><span class="signature">(n, oData, fn)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Bind an event handers to allow a click or return key to activate the callback.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
88 This is good for accessibility since a return on the keyboard will have the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
89 same effect as a click, if the element has focus.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnBrowserDetect">_fnBrowserDetect</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>From some browsers (specifically IE6/7) we need special handling to work around browser
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
90 bugs - this function is used to detect when these workarounds are needed.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnBuildHead">_fnBuildHead</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Create the HTML header for the table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnBuildSearchArray">_fnBuildSearchArray</a></span><span class="type-sig"><span class="signature">(oSettings, iMaster)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Create an array which can be quickly search through</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnBuildSearchRow">_fnBuildSearchRow</a></span><span class="type-sig"><span class="signature">(oSettings, aData)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Create a searchable string from a single data row</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnCalculateColumnWidths">_fnCalculateColumnWidths</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Calculate the width of columns for the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnCalculateEnd">_fnCalculateEnd</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Recalculate the end point based on the start point</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnCallbackFire">_fnCallbackFire</a></span><span class="type-sig"><span class="signature">(oSettings, sStore, sTrigger, aArgs)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Fire callback functions and trigger events. Note that the loop over the callback
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
91 array store is done backwards! Further note that you do not want to fire off triggers
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
92 in time sensitive applications (for example cell creation) as its slow.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnCallbackReg">_fnCallbackReg</a></span><span class="type-sig"><span class="signature">(oSettings, sStore, fn, sName)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Register a callback function. Easily allows a callback function to be added to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
93 an array store of callback functions that can then all be called together.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnClearTable">_fnClearTable</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Nuke the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnColumnIndexToVisible">_fnColumnIndexToVisible</a></span><span class="type-sig"><span class="signature">(iMatch, oSettings)</span><span class="type-signature"> &rarr; {int}</span></span></dt><dd class=" odd"><p>Covert the index of an index in the data array and convert it to the visible
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
94 column index (take account of hidden columns)</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnColumnOptions">_fnColumnOptions</a></span><span class="type-sig"><span class="signature">(oSettings, iCol, oOptions)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Apply options for a column</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnColumnOrdering">_fnColumnOrdering</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {string}</span></span></dt><dd class=" odd"><p>Get the column ordering that DataTables expects</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnConvertToWidth">_fnConvertToWidth</a></span><span class="type-sig"><span class="signature">(sWidth, nParent)</span><span class="type-signature"> &rarr; {int}</span></span></dt><dd class=" even"><p>Convert a CSS unit width to pixels (e.g. 2em)</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnCreateCookie">_fnCreateCookie</a></span><span class="type-sig"><span class="signature">(sName, sValue, iSecs, sBaseName, fnCallback)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Create a new cookie with a value to store the state of a table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnCreateTr">_fnCreateTr</a></span><span class="type-sig"><span class="signature">(oSettings, iRow)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Create a new TR element (and it's TD children) for a row</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnDataToSearch">_fnDataToSearch</a></span><span class="type-sig"><span class="signature">(sData, sType)</span><span class="type-signature"> &rarr; {string}</span></span></dt><dd class=" odd"><p>Convert raw data into something that the user can search on</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnDeleteIndex">_fnDeleteIndex</a></span><span class="type-sig"><span class="signature">(a, iTarget)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Take an array of integers (index array) and remove a target integer (value - not
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
95 the key!)</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnDetectHeader">_fnDetectHeader</a></span><span class="type-sig"><span class="signature">(array, nThead)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Use the DOM source to create up an array of header cells. The idea here is to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
96 create a layout grid (array) of rows x columns, which contains a reference
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
97 to the cell that that point in the grid (regardless of col/rowspan), such that
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
98 any column / row could be removed and the new grid constructed</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnDetectType">_fnDetectType</a></span><span class="type-sig"><span class="signature">(sData)</span><span class="type-signature"> &rarr; {string}</span></span></dt><dd class=" even"><p>Get the sort type based on an input string</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnDraw">_fnDraw</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Insert the required TR nodes into the table for display</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnDrawHead">_fnDrawHead</a></span><span class="type-sig"><span class="signature">(oSettings, array, <span class="optional">bIncludeHidden</span>)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Draw the header (or footer) element based on the column visibility states. The
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
99 methodology here is to use the layout array from _fnDetectHeader, modified for
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
100 the instantaneous column visibility, to construct the new layout. The grid is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
101 traversed over cell at a time in a rows x columns grid fashion, although each
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
102 cell insert can cover multiple elements in the grid - which is tracks using the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
103 aApplied array. Cell inserts in the grid will only occur where there isn't
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
104 already a cell in that position.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnEscapeRegex">_fnEscapeRegex</a></span><span class="type-sig"><span class="signature">(sVal)</span><span class="type-signature"> &rarr; {string}</span></span></dt><dd class=" odd"><p>scape a string such that it can be used in a regular expression</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnExtend">_fnExtend</a></span><span class="type-sig"><span class="signature">(oOut, oExtender)</span><span class="type-signature"> &rarr; {object}</span></span></dt><dd class=" even"><p>Extend objects - very similar to jQuery.extend, but deep copy objects, and shallow
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
105 copy arrays. The reason we need to do this, is that we don't want to deep copy array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
106 init values (such as aaSorting) since the dev wouldn't be able to override them, but
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
107 we do want to deep copy arrays.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnExternApiFunc">_fnExternApiFunc</a></span><span class="type-sig"><span class="signature">(sFunc)</span><span class="type-signature"> &rarr; {function}</span></span></dt><dd class=" odd"><p>Create a wrapper function for exporting an internal functions to an external API.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnFeatureHtmlFilter">_fnFeatureHtmlFilter</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {node}</span></span></dt><dd class=" even"><p>Generate the node required for filtering text</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnFeatureHtmlInfo">_fnFeatureHtmlInfo</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {node}</span></span></dt><dd class=" odd"><p>Generate the node required for the info display</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnFeatureHtmlLength">_fnFeatureHtmlLength</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {node}</span></span></dt><dd class=" even"><p>Generate the node required for user display length changing</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnFeatureHtmlPaginate">_fnFeatureHtmlPaginate</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {node}</span></span></dt><dd class=" odd"><p>Generate the node required for default pagination</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnFeatureHtmlProcessing">_fnFeatureHtmlProcessing</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {node}</span></span></dt><dd class=" even"><p>Generate the node required for the processing node</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnFeatureHtmlTable">_fnFeatureHtmlTable</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {node}</span></span></dt><dd class=" odd"><p>Add any control elements for the table - specifically scrolling</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnFilter">_fnFilter</a></span><span class="type-sig"><span class="signature">(oSettings, sInput, iForce, bRegex, bSmart, bCaseInsensitive)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Filter the data table based on user input and draw the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnFilterColumn">_fnFilterColumn</a></span><span class="type-sig"><span class="signature">(oSettings, sInput, iColumn, bRegex, bSmart, bCaseInsensitive)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Filter the table on a per-column basis</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnFilterComplete">_fnFilterComplete</a></span><span class="type-sig"><span class="signature">(oSettings, oSearch, <span class="optional">iForce</span>)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Filter the table using both the global filter and column based filtering</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnFilterCreateSearch">_fnFilterCreateSearch</a></span><span class="type-sig"><span class="signature">(sSearch, bRegex, bSmart, bCaseInsensitive)</span><span class="type-signature"> &rarr; {RegExp}</span></span></dt><dd class=" odd"><p>Build a regular expression object suitable for searching a table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnFilterCustom">_fnFilterCustom</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Apply custom filtering functions</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnGatherData">_fnGatherData</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Read in the data from the target table from the DOM</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnGetCellData">_fnGetCellData</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, iCol, sSpecific)</span><span class="type-signature"> &rarr; {*}</span></span></dt><dd class=" even"><p>Get the data for a given cell from the internal cache, taking into account data mapping</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnGetColumns">_fnGetColumns</a></span><span class="type-sig"><span class="signature">(oSettings, sParam)</span><span class="type-signature"> &rarr; {array}</span></span></dt><dd class=" odd"><p>Get an array of column indexes that match a given property</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnGetDataMaster">_fnGetDataMaster</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Return an array with the full table data</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnGetMaxLenString">_fnGetMaxLenString</a></span><span class="type-sig"><span class="signature">(oSettings, iCol)</span><span class="type-signature"> &rarr; {string}</span></span></dt><dd class=" odd"><p>Get the maximum strlen for each data column</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnGetObjectDataFn">_fnGetObjectDataFn</a></span><span class="type-sig"><span class="signature">(mSource)</span><span class="type-signature"> &rarr; {function}</span></span></dt><dd class=" even"><p>Return a function that can be used to get data from a source object, taking
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
108 into account the ability to use nested objects as a source</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnGetRowData">_fnGetRowData</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, sSpecific, aiColumns)</span><span class="type-signature"> &rarr; {array}</span></span></dt><dd class=" odd"><p>Get an array of data for a given row from the internal data cache</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnGetTdNodes">_fnGetTdNodes</a></span><span class="type-sig"><span class="signature">(oSettings, <span class="optional">iIndividualRow</span>)</span><span class="type-signature"> &rarr; {array}</span></span></dt><dd class=" even"><p>Return an flat array with all TD nodes for the table, or row</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnGetTrNodes">_fnGetTrNodes</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {array}</span></span></dt><dd class=" odd"><p>Return an array with the TR nodes for the table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnGetUniqueThs">_fnGetUniqueThs</a></span><span class="type-sig"><span class="signature">(oSettings, nHeader, aLayout)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Get an array of unique th elements, one for each column</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnGetWidestNode">_fnGetWidestNode</a></span><span class="type-sig"><span class="signature">(oSettings, iCol)</span><span class="type-signature"> &rarr; {node}</span></span></dt><dd class=" odd"><p>Get the widest node</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnInitComplete">_fnInitComplete</a></span><span class="type-sig"><span class="signature">(oSettings, <span class="optional">json</span>)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Draw the table for the first time, adding all required features</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnInitialise">_fnInitialise</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Draw the table for the first time, adding all required features</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnLanguageCompat">_fnLanguageCompat</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Language compatibility - when certain options are given, and others aren't, we
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
109 need to duplicate the values over, in order to provide backwards compatibility
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
110 with older language files.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnLoadState">_fnLoadState</a></span><span class="type-sig"><span class="signature">(oSettings, oInit)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Attempt to load a saved table state from a cookie</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnLog">_fnLog</a></span><span class="type-sig"><span class="signature">(oSettings, iLevel, sMesg)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Log an error message</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnMap">_fnMap</a></span><span class="type-sig"><span class="signature">(oRet, oSrc, sName, <span class="optional">sMappedName</span>)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>See if a property is defined on one object, if so assign it to the other object</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnNodeToColumnIndex">_fnNodeToColumnIndex</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, n)</span><span class="type-signature"> &rarr; {int}</span></span></dt><dd class=" even"><p>Take a TD element and convert it into a column data index (not the visible index)</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnNodeToDataIndex">_fnNodeToDataIndex</a></span><span class="type-sig"><span class="signature">(oSettings, n)</span><span class="type-signature"> &rarr; {int}</span></span></dt><dd class=" odd"><p>Take a TR element and convert it to an index in aoData</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnPageChange">_fnPageChange</a></span><span class="type-sig"><span class="signature">(oSettings, mAction)</span><span class="type-signature"> &rarr; {bool}</span></span></dt><dd class=" even"><p>Alter the display settings to change the page</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnProcessingDisplay">_fnProcessingDisplay</a></span><span class="type-sig"><span class="signature">(oSettings, bShow)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Display or hide the processing indicator</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnReadCookie">_fnReadCookie</a></span><span class="type-sig"><span class="signature">(sName)</span><span class="type-signature"> &rarr; {string}</span></span></dt><dd class=" even"><p>Read an old cookie to get a cookie with an old table state</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnReDraw">_fnReDraw</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Redraw the table - taking account of the various features which are enabled</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnRender">_fnRender</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, iCol)</span><span class="type-signature"> &rarr; {*}</span></span></dt><dd class=" even"><p>Call the developer defined fnRender function for a given cell (row/column) with
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
111 the required parameters and return the result.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnReOrderIndex">_fnReOrderIndex</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Figure out how to reorder a display list</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnSaveState">_fnSaveState</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Save the state of a table in a cookie such that the page can be reloaded</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnScrollBarWidth">_fnScrollBarWidth</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"> &rarr; {int}</span></span></dt><dd class=" odd"><p>Get the width of a scroll bar in this browser being used</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnScrollDraw">_fnScrollDraw</a></span><span class="type-sig"><span class="signature">(o)</span><span class="type-signature"> &rarr; {node}</span></span></dt><dd class=" even"><p>Update the various tables for resizing. It's a bit of a pig this function, but
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
112 basically the idea to:
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
113 1. Re-create the table inside the scrolling div
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
114 2. Take live measurements from the DOM
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
115 3. Apply the measurements
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
116 4. Clean up</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnScrollingWidthAdjust">_fnScrollingWidthAdjust</a></span><span class="type-sig"><span class="signature">(oSettings, n)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Adjust a table's width to take account of scrolling</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnServerParams">_fnServerParams</a></span><span class="type-sig"><span class="signature">(oSettings, array)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Add Ajax parameters from plug-ins</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnSetCellData">_fnSetCellData</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, iCol, val)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Set the value for a specific cell, into the internal data cache</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnSetObjectDataFn">_fnSetObjectDataFn</a></span><span class="type-sig"><span class="signature">(mSource)</span><span class="type-signature"> &rarr; {function}</span></span></dt><dd class=" even"><p>Return a function that can be used to set data from a source object, taking
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
117 into account the ability to use nested objects as a source</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnSettingsFromNode">_fnSettingsFromNode</a></span><span class="type-sig"><span class="signature">(nTable)</span><span class="type-signature"> &rarr; {object}</span></span></dt><dd class=" odd"><p>Return the settings object for a particular table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnSort">_fnSort</a></span><span class="type-sig"><span class="signature">(oSettings, bApplyClasses)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Change the order of the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnSortAttachListener">_fnSortAttachListener</a></span><span class="type-sig"><span class="signature">(oSettings, nNode, iDataIndex, <span class="optional">fnCallback</span>)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Attach a sort handler (click) to a node</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnSortingClasses">_fnSortingClasses</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Set the sorting classes on the header, Note: it is safe to call this function
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
118 when bSort and bSortClasses are false</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnStringToCss">_fnStringToCss</a></span><span class="type-sig"><span class="signature">(aArray1, aArray2)</span><span class="type-signature"> &rarr; {int}</span></span></dt><dd class=" odd"><p>Append a CSS unit (only if required) to a string</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnUpdateInfo">_fnUpdateInfo</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Update the information elements in the display</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnVisbleColumns">_fnVisbleColumns</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {int}</span></span></dt><dd class=" odd"><p>Get the number of visible columns</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnVisibleToColumnIndex">_fnVisibleToColumnIndex</a></span><span class="type-sig"><span class="signature">(oSettings, iMatch)</span><span class="type-signature"> &rarr; {int}</span></span></dt><dd class=" even"><p>Covert the index of a visible column to the index in the data array (take account
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
119 of hidden columns)</p></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
120 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
121 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
122 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
123
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
124
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
125
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
126
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
127 <div class="doc_details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
128 <a name="details"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
129 <h2>Details</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
130 <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
131 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
132 <dt class=" even"><a name="_fnJsonString"></a><a name="_fnJsonString_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#_fnJsonString">_fnJsonString</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" even"><p>JSON stringify. If JSON.stringify it provided by the browser, json2.js or any other
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
133 library, then we use that as it is fast, safe and accurate. If the function isn't
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
134 available then we need to built it ourselves - the inspiration for this function comes
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
135 from Craig Buckler ( <a href='http://www.sitepoint.com/javascript-json-serialization/'>http://www.sitepoint.com/javascript-json-serialization/</a> ). It is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
136 not perfect and absolutely should not be used as a replacement to json2.js - but it does
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
137 do what we need, without requiring a dependency for DataTables.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
138
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
139 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
140 </div></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
141 </dl></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
142 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
143 <dt id="DataTable#oApi._fnAddColumn" class=" even"><a name="_fnAddColumn"></a><a name="_fnAddColumn_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnAddColumn</a></span><span class="type-sig"><span class="signature">(oSettings, nTh)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Add a column to the list used for the table with default values</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
144
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
145 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
146 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
147
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
148 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
149 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
150 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
151 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
152 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
153 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
154 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
155 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
156 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
157 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
158 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
159
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
160 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
161 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">nTh</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The th element for this column</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
162 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
163 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
164 <dt id="DataTable#oApi._fnAddData" class=" odd"><a name="_fnAddData"></a><a name="_fnAddData_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnAddData</a></span><span class="type-sig"><span class="signature">(oSettings, aData)</span><span class="type-signature"> &rarr; {int}</span></span></span></dt><dd class=" odd"><p>Add a data array to the table, creating DOM node etc. This is the parallel to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
165 _fnGatherData, but for adding rows from a Javascript source, rather than a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
166 DOM source.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
167
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
168 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
169 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
170
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
171 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
172 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
173 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
174 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
175 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
176 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
177 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
178 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
179 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
180 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
181 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
182
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
183 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
184 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">aData</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>data array to be added</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
185 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
186 </table><h5>Returns:</h5><p class="returns"><blockquote>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
187 <p>=0 if successful (index of new aoData entry), -1 if failed</p>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
188 </blockquote></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
189 <dt id="DataTable#oApi._fnAddOptionsHtml" class=" even"><a name="_fnAddOptionsHtml"></a><a name="_fnAddOptionsHtml_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnAddOptionsHtml</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Add the options to the page HTML for the table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
190
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
191 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
192 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
193
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
194 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
195 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
196 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
197 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
198 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
199 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
200 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
201 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
202 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
203 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
204 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
205
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
206 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
207 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
208 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
209 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
210 <dt id="DataTable#oApi._fnAdjustColumnSizing" class=" odd"><a name="_fnAdjustColumnSizing"></a><a name="_fnAdjustColumnSizing_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnAdjustColumnSizing</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Adjust the table column widths for new data. Note: you would probably want to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
211 do a redraw after calling this function!</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">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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
230 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
231 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
232 <dt id="DataTable#oApi._fnAjaxParameters" class=" even"><a name="_fnAjaxParameters"></a><a name="_fnAjaxParameters_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnAjaxParameters</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {bool}</span></span></span></dt><dd class=" even"><p>Build up the parameters in an object needed for a server-side processing request</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
233
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
234 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
235 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
236
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
237 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
238 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
239 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
240 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
241 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
242 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
243 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
244 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
245 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
246 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
247 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
248
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
249 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
250 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
251 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
252 </table><h5>Returns:</h5><p class="returns"><p>block the table drawing or not</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
253 <dt id="DataTable#oApi._fnAjaxUpdate" class=" odd"><a name="_fnAjaxUpdate"></a><a name="_fnAjaxUpdate_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnAjaxUpdate</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {boolean}</span></span></span></dt><dd class=" odd"><p>Update the table using an Ajax call</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
254
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
255 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
256 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
257
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
258 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
259 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
260 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
261 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
262 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
263 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
264 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
265 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
266 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
267 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
268 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
269
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
270 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
271 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
272 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
273 </table><h5>Returns:</h5><p class="returns"><p>Block the table drawing or not</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
274 <dt id="DataTable#oApi._fnAjaxUpdateDraw" class=" even"><a name="_fnAjaxUpdateDraw"></a><a name="_fnAjaxUpdateDraw_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnAjaxUpdateDraw</a></span><span class="type-sig"><span class="signature">(oSettings, json)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Data the data from the server (nuking the old) and redraw the table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
275
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
276 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
277 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
278
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
279 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
280 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
281 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
282 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
283 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
284 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
285 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
286 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
287 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
288 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
289 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
290
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
291 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
292 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</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 data return from the server.</p></td></tr><tr><td class="number right_border"></td><td class="name">json.sEcho</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Tracking flag for DataTables to match requests</p></td></tr><tr><td class="number right_border"></td><td class="name">json.iTotalRecords</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Number of records in the data set, not accounting for filtering</p></td></tr><tr><td class="number right_border"></td><td class="name">json.iTotalDisplayRecords</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Number of records in the data set, accounting for filtering</p></td></tr><tr><td class="number right_border"></td><td class="name">json.aaData</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data to display on this page</p></td></tr><tr><td class="number right_border"></td><td class="name">json.sColumns</td><td class="type type-param">string</td><td class="attributes">&lt;optional><br></td><td class="default"></td><td class="description last"><p>Column ordering (sName, comma separated)</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
293 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
294 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
295 <dt id="DataTable#oApi._fnApplyColumnDefs" class=" odd"><a name="_fnApplyColumnDefs"></a><a name="_fnApplyColumnDefs_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnApplyColumnDefs</a></span><span class="type-sig"><span class="signature">(oSettings, aoColDefs, aoCols, fn)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Take the column definitions and static columns arrays and calculate how
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
296 they relate to column indexes. The callback function will then apply the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
297 definition found for a column to a suitable configuration object.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
298
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
299 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
300 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
301
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
302 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
303 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
304 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
305 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
306 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
307 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
308 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
309 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
310 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
311 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
312 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
313
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
314 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
315 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">aoColDefs</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The aoColumnDefs array that is to be applied</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">aoCols</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The aoColumns array that defines columns individually</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">fn</td><td class="type type-param">function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Callback function - takes two parameters, the calculated
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
316 column index and the definition for that column.</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
317 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
318 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
319 <dt id="DataTable#oApi._fnApplyToChildren" class=" even"><a name="_fnApplyToChildren"></a><a name="_fnApplyToChildren_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnApplyToChildren</a></span><span class="type-sig"><span class="signature">(fn, array, array)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Apply a given function to the display child nodes of an element array (typically
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
320 TD children of TR rows</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
321
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
322 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
323 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
324
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
325 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
326 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
327 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
328 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
329 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
330 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
331 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
332 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
333 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
334 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
335 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
336
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
337 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
338 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">fn</td><td class="type type-param">function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Method to apply to the objects</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">array</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>{nodes} an1 List of elements to look through for display children</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">array</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>{nodes} an2 Another list (identical structure to the first) - optional</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
339 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
340 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
341 <dt id="DataTable#oApi._fnBindAction" class=" odd"><a name="_fnBindAction"></a><a name="_fnBindAction_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnBindAction</a></span><span class="type-sig"><span class="signature">(n, oData, fn)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Bind an event handers to allow a click or return key to activate the callback.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
342 This is good for accessibility since a return on the keyboard will have the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
343 same effect as a click, if the element has focus.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
344
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
345 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
346 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
347
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
348 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
349 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
350 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
351 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
352 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
353 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
354 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
355 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
356 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
357 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
358 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
359
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
360 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
361 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">n</td><td class="type type-param">element</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Element to bind the action to</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oData</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Data object to pass to the triggered function</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">fn</td><td class="type type-param">function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Callback function for when the event is triggered</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
362 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
363 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
364 <dt id="DataTable#oApi._fnBrowserDetect" class=" even"><a name="_fnBrowserDetect"></a><a name="_fnBrowserDetect_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnBrowserDetect</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>From some browsers (specifically IE6/7) we need special handling to work around browser
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
365 bugs - this function is used to detect when these workarounds are needed.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
366
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
367 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
368 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
369
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
370 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
371 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
372 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
373 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
374 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
375 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
376 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
377 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
378 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
379 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
380 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
381
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
382 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
383 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
384 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
385 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
386 <dt id="DataTable#oApi._fnBuildHead" class=" odd"><a name="_fnBuildHead"></a><a name="_fnBuildHead_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnBuildHead</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Create the HTML header for the table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
387
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
388 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
389 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
390
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
391 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
392 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
393 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
394 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
395 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
396 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
397 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
398 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
399 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
400 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
401 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
402
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
403 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
404 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
405 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
406 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
407 <dt id="DataTable#oApi._fnBuildSearchArray" class=" even"><a name="_fnBuildSearchArray"></a><a name="_fnBuildSearchArray_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnBuildSearchArray</a></span><span class="type-sig"><span class="signature">(oSettings, iMaster)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Create an array which can be quickly search through</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
408
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
409 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
410 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
411
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
412 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
413 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
414 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
415 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
416 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
417 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
418 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
419 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
420 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
421 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
422 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
423
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
424 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
425 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">iMaster</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>use the master data array - optional</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
426 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
427 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
428 <dt id="DataTable#oApi._fnBuildSearchRow" class=" odd"><a name="_fnBuildSearchRow"></a><a name="_fnBuildSearchRow_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnBuildSearchRow</a></span><span class="type-sig"><span class="signature">(oSettings, aData)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Create a searchable string from a single data row</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
429
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
430 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
431 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
432
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
433 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
434 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
435 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
436 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
437 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
438 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
439 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
440 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
441 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
442 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
443 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
444
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
445 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
446 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">aData</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Row data array to use for the data to search</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
447 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
448 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
449 <dt id="DataTable#oApi._fnCalculateColumnWidths" class=" even"><a name="_fnCalculateColumnWidths"></a><a name="_fnCalculateColumnWidths_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnCalculateColumnWidths</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Calculate the width of columns for the table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
450
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
451 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
452 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
453
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
454 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
455 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
456 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
457 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
458 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
459 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
460 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
461 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
462 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
463 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
464 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
465
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
466 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
467 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
468 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
469 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
470 <dt id="DataTable#oApi._fnCalculateEnd" class=" odd"><a name="_fnCalculateEnd"></a><a name="_fnCalculateEnd_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnCalculateEnd</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Recalculate the end point based on the start point</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
471
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
472 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
473 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
474
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
475 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
476 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
477 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
478 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
479 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
480 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
481 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
482 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
483 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
484 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
485 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
486
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
487 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
488 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
489 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
490 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
491 <dt id="DataTable#oApi._fnCallbackFire" class=" even"><a name="_fnCallbackFire"></a><a name="_fnCallbackFire_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnCallbackFire</a></span><span class="type-sig"><span class="signature">(oSettings, sStore, sTrigger, aArgs)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Fire callback functions and trigger events. Note that the loop over the callback
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
492 array store is done backwards! Further note that you do not want to fire off triggers
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
493 in time sensitive applications (for example cell creation) as its slow.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
494
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
495 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
496 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
497
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
498 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
499 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
500 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
501 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
502 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
503 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
504 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
505 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
506 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
507 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
508 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
509
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
510 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
511 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">sStore</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Name of the array storage for the callbacks in oSettings</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">sTrigger</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Name of the jQuery custom event to trigger. If null no trigger
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
512 is fired</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">aArgs</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Array of arguments to pass to the callback function / trigger</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
513 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
514 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
515 <dt id="DataTable#oApi._fnCallbackReg" class=" odd"><a name="_fnCallbackReg"></a><a name="_fnCallbackReg_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnCallbackReg</a></span><span class="type-sig"><span class="signature">(oSettings, sStore, fn, sName)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Register a callback function. Easily allows a callback function to be added to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
516 an array store of callback functions that can then all be called together.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
517
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
518 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
519 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
520
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
521 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
522 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
523 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
524 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
525 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
526 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
527 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
528 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
529 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
530 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
531 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
532
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
533 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
534 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">sStore</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Name of the array storage for the callbacks in oSettings</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">fn</td><td class="type type-param">function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Function to be called back</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">sName</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Identifying name for the callback (i.e. a label)</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
535 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
536 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
537 <dt id="DataTable#oApi._fnClearTable" class=" even"><a name="_fnClearTable"></a><a name="_fnClearTable_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnClearTable</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Nuke the table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
538
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
539 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
540 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
541
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
542 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
543 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
544 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
545 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
546 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
547 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
548 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
549 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
550 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
551 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
552 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
553
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
554 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
555 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
556 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
557 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
558 <dt id="DataTable#oApi._fnColumnIndexToVisible" class=" odd"><a name="_fnColumnIndexToVisible"></a><a name="_fnColumnIndexToVisible_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnColumnIndexToVisible</a></span><span class="type-sig"><span class="signature">(iMatch, oSettings)</span><span class="type-signature"> &rarr; {int}</span></span></span></dt><dd class=" odd"><p>Covert the index of an index in the data array and convert it to the visible
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
559 column index (take account of hidden columns)</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
560
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
561 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
562 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
563
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
564 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
565 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
566 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
567 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
568 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
569 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
570 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
571 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
572 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
573 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
574 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
575
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
576 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
577 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">iMatch</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Column index to lookup</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
578 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
579 </table><h5>Returns:</h5><p class="returns"><p>i the data index</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
580 <dt id="DataTable#oApi._fnColumnOptions" class=" even"><a name="_fnColumnOptions"></a><a name="_fnColumnOptions_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnColumnOptions</a></span><span class="type-sig"><span class="signature">(oSettings, iCol, oOptions)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Apply options for a column</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
581
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
582 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
583 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
584
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
585 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
586 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
587 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
588 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
589 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
590 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
591 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
592 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
593 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
594 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
595 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
596
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
597 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
598 <tr class="even"><td class="number right_border"><div>1</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="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"></td><td class="default"></td><td class="description last"><p>column index to consider</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">oOptions</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>object with sType, bVisible and bSearchable etc</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
599 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
600 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
601 <dt id="DataTable#oApi._fnColumnOrdering" class=" odd"><a name="_fnColumnOrdering"></a><a name="_fnColumnOrdering_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnColumnOrdering</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {string}</span></span></span></dt><dd class=" odd"><p>Get the column ordering that DataTables expects</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
602
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
603 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
604 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
605
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
606 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
607 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
608 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
609 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
610 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
611 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
612 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
613 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
614 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
615 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
616 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
617
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
618 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
619 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
620 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
621 </table><h5>Returns:</h5><p class="returns"><p>comma separated list of names</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
622 <dt id="DataTable#oApi._fnConvertToWidth" class=" even"><a name="_fnConvertToWidth"></a><a name="_fnConvertToWidth_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnConvertToWidth</a></span><span class="type-sig"><span class="signature">(sWidth, nParent)</span><span class="type-signature"> &rarr; {int}</span></span></span></dt><dd class=" even"><p>Convert a CSS unit width to pixels (e.g. 2em)</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
623
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
624 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
625 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
626
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
627 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
628 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
629 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
630 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
631 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
632 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
633 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
634 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
635 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
636 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
637 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
638
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
639 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
640 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sWidth</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>width to be converted</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">nParent</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>parent to get the with for (required for relative widths) - optional</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
641 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
642 </table><h5>Returns:</h5><p class="returns"><p>iWidth width in pixels</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
643 <dt id="DataTable#oApi._fnCreateCookie" class=" odd"><a name="_fnCreateCookie"></a><a name="_fnCreateCookie_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnCreateCookie</a></span><span class="type-sig"><span class="signature">(sName, sValue, iSecs, sBaseName, fnCallback)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Create a new cookie with a value to store the state of a table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
644
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
645 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
646 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
647
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
648 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
649 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
650 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
651 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
652 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
653 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
654 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
655 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
656 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
657 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
658 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
659
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
660 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
661 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sName</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>name of the cookie to create</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sValue</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>the value the cookie should take</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iSecs</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>duration of the cookie</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">sBaseName</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>sName is made up of the base + file name - this is the base</p></td></tr><tr class="even"><td class="number right_border"><div>5</div></td><td class="name">fnCallback</td><td class="type type-param">function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>User definable function to modify the cookie</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
662 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
663 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
664 <dt id="DataTable#oApi._fnCreateTr" class=" even"><a name="_fnCreateTr"></a><a name="_fnCreateTr_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnCreateTr</a></span><span class="type-sig"><span class="signature">(oSettings, iRow)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Create a new TR element (and it's TD children) for a row</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
665
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
666 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
667 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
668
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
669 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
670 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
671 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
672 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
673 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
674 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
675 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
676 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
677 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
678 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
679 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
680
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
681 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
682 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Row to consider</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
683 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
684 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
685 <dt id="DataTable#oApi._fnDataToSearch" class=" odd"><a name="_fnDataToSearch"></a><a name="_fnDataToSearch_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnDataToSearch</a></span><span class="type-sig"><span class="signature">(sData, sType)</span><span class="type-signature"> &rarr; {string}</span></span></span></dt><dd class=" odd"><p>Convert raw data into something that the user can search on</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
686
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
687 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
688 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
689
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
690 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
691 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
692 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
693 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
694 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
695 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
696 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
697 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
698 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
699 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
700 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
701
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
702 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
703 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sData</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>data to be modified</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sType</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>data type</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
704 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
705 </table><h5>Returns:</h5><p class="returns"><p>search string</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
706 <dt id="DataTable#oApi._fnDeleteIndex" class=" even"><a name="_fnDeleteIndex"></a><a name="_fnDeleteIndex_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnDeleteIndex</a></span><span class="type-sig"><span class="signature">(a, iTarget)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Take an array of integers (index array) and remove a target integer (value - not
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
707 the key!)</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
708
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
709 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
710 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
711
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
712 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
713 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
714 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
715 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
716 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
717 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
718 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
719 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
720 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
721 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
722 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
723
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
724 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
725 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">a</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Index array to target</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iTarget</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>value to find</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
726 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
727 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
728 <dt id="DataTable#oApi._fnDetectHeader" class=" odd"><a name="_fnDetectHeader"></a><a name="_fnDetectHeader_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnDetectHeader</a></span><span class="type-sig"><span class="signature">(array, nThead)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Use the DOM source to create up an array of header cells. The idea here is to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
729 create a layout grid (array) of rows x columns, which contains a reference
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
730 to the cell that that point in the grid (regardless of col/rowspan), such that
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
731 any column / row could be removed and the new grid constructed</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">array</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>{object} aLayout Array to store the calculated layout in</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">nThead</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The header/footer element for the table</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
750 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
751 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
752 <dt id="DataTable#oApi._fnDetectType" class=" even"><a name="_fnDetectType"></a><a name="_fnDetectType_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnDetectType</a></span><span class="type-sig"><span class="signature">(sData)</span><span class="type-signature"> &rarr; {string}</span></span></span></dt><dd class=" even"><p>Get the sort type based on an input string</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
753
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
754 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
755 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
756
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
757 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
758 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
759 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
760 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
761 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
762 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
763 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
764 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
765 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
766 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
767 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
768
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
769 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
770 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sData</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>data we wish to know the type of</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
771 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
772 </table><h5>Returns:</h5><p class="returns"><p>type (defaults to 'string' if no type can be detected)</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
773 <dt id="DataTable#oApi._fnDraw" class=" odd"><a name="_fnDraw"></a><a name="_fnDraw_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnDraw</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Insert the required TR nodes into the table for display</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
774
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
775 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
776 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
777
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
778 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
779 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
780 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
781 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
782 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
783 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
784 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
785 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
786 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
787 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
788 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
789
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
790 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
791 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
792 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
793 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
794 <dt id="DataTable#oApi._fnDrawHead" class=" even"><a name="_fnDrawHead"></a><a name="_fnDrawHead_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnDrawHead</a></span><span class="type-sig"><span class="signature">(oSettings, array, <span class="optional">bIncludeHidden</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Draw the header (or footer) element based on the column visibility states. The
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
795 methodology here is to use the layout array from _fnDetectHeader, modified for
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
796 the instantaneous column visibility, to construct the new layout. The grid is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
797 traversed over cell at a time in a rows x columns grid fashion, although each
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
798 cell insert can cover multiple elements in the grid - which is tracks using the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
799 aApplied array. Cell inserts in the grid will only occur where there isn't
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
800 already a cell in that position.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
801
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
802 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
803 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
804
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
805 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
806 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
807 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
808 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
809 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
810 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
811 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
812 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
813 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
814 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
815 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
816
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
817 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
818 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">array</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>{objects} aoSource Layout array from _fnDetectHeader</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">bIncludeHidden</td><td class="type type-param">boolean</td><td class="attributes">Optional</td><td class="default">false</td><td class="description last"><p>If true then include the hidden columns in the calc,</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
819 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
820 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
821 <dt id="DataTable#oApi._fnEscapeRegex" class=" odd"><a name="_fnEscapeRegex"></a><a name="_fnEscapeRegex_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnEscapeRegex</a></span><span class="type-sig"><span class="signature">(sVal)</span><span class="type-signature"> &rarr; {string}</span></span></span></dt><dd class=" odd"><p>scape a string such that it can be used in a regular expression</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
822
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
823 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
824 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
825
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
826 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
827 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
828 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
829 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
830 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
831 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
832 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
833 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
834 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
835 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
836 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
837
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
838 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
839 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sVal</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>string to escape</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
840 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
841 </table><h5>Returns:</h5><p class="returns"><p>escaped string</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
842 <dt id="DataTable#oApi._fnExtend" class=" even"><a name="_fnExtend"></a><a name="_fnExtend_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnExtend</a></span><span class="type-sig"><span class="signature">(oOut, oExtender)</span><span class="type-signature"> &rarr; {object}</span></span></span></dt><dd class=" even"><p>Extend objects - very similar to jQuery.extend, but deep copy objects, and shallow
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
843 copy arrays. The reason we need to do this, is that we don't want to deep copy array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
844 init values (such as aaSorting) since the dev wouldn't be able to override them, but
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
845 we do want to deep copy arrays.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
846
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
847 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
848 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
849
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
850 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
851 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
852 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
853 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
854 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
855 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
856 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
857 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
858 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
859 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
860 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
861
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
862 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
863 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oOut</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Object to extend</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oExtender</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Object from which the properties will be applied to oOut</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
864 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
865 </table><h5>Returns:</h5><p class="returns"><p>oOut Reference, just for convenience - oOut === the return.</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
866 <dt id="DataTable#oApi._fnExternApiFunc" class=" odd"><a name="_fnExternApiFunc"></a><a name="_fnExternApiFunc_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnExternApiFunc</a></span><span class="type-sig"><span class="signature">(sFunc)</span><span class="type-signature"> &rarr; {function}</span></span></span></dt><dd class=" odd"><p>Create a wrapper function for exporting an internal functions to an external API.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
867
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
868 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
869 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
870
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
871 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
872 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
873 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
874 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
875 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
876 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
877 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
878 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
879 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
880 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
881 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
882
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
883 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
884 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sFunc</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>API function name</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
885 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
886 </table><h5>Returns:</h5><p class="returns"><p>wrapped function</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
887 <dt id="DataTable#oApi._fnFeatureHtmlFilter" class=" even"><a name="_fnFeatureHtmlFilter"></a><a name="_fnFeatureHtmlFilter_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnFeatureHtmlFilter</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {node}</span></span></span></dt><dd class=" even"><p>Generate the node required for filtering text</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
888
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
889 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
890 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
891
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
892 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
893 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
894 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
895 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
896 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
897 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
898 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
899 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
900 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
901 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
902 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
903
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
904 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
905 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
906 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
907 </table><h5>Returns:</h5><p class="returns"><p>Filter control element</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
908 <dt id="DataTable#oApi._fnFeatureHtmlInfo" class=" odd"><a name="_fnFeatureHtmlInfo"></a><a name="_fnFeatureHtmlInfo_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnFeatureHtmlInfo</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {node}</span></span></span></dt><dd class=" odd"><p>Generate the node required for the info display</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
909
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
910 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
911 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
912
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
913 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
914 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
915 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
916 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
917 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
918 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
919 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
920 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
921 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
922 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
923 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
924
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
925 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
926 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
927 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
928 </table><h5>Returns:</h5><p class="returns"><p>Information element</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
929 <dt id="DataTable#oApi._fnFeatureHtmlLength" class=" even"><a name="_fnFeatureHtmlLength"></a><a name="_fnFeatureHtmlLength_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnFeatureHtmlLength</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {node}</span></span></span></dt><dd class=" even"><p>Generate the node required for user display length changing</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
930
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
931 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
932 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
933
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
934 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
935 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
936 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
937 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
938 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
939 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
940 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
941 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
942 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
943 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
944 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
945
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
946 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
947 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
948 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
949 </table><h5>Returns:</h5><p class="returns"><p>Display length feature node</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
950 <dt id="DataTable#oApi._fnFeatureHtmlPaginate" class=" odd"><a name="_fnFeatureHtmlPaginate"></a><a name="_fnFeatureHtmlPaginate_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnFeatureHtmlPaginate</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {node}</span></span></span></dt><dd class=" odd"><p>Generate the node required for default pagination</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
951
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
952 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
953 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
954
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
955 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
956 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
957 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
958 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
959 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
960 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
961 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
962 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
963 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
964 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
965 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
966
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
967 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
968 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
969 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
970 </table><h5>Returns:</h5><p class="returns"><p>Pagination feature node</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
971 <dt id="DataTable#oApi._fnFeatureHtmlProcessing" class=" even"><a name="_fnFeatureHtmlProcessing"></a><a name="_fnFeatureHtmlProcessing_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnFeatureHtmlProcessing</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {node}</span></span></span></dt><dd class=" even"><p>Generate the node required for the processing node</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
972
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
973 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
974 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
975
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
976 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
977 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
978 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
979 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
980 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
981 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
982 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
983 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
984 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
985 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
986 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
987
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
988 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
989 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
990 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
991 </table><h5>Returns:</h5><p class="returns"><p>Processing element</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
992 <dt id="DataTable#oApi._fnFeatureHtmlTable" class=" odd"><a name="_fnFeatureHtmlTable"></a><a name="_fnFeatureHtmlTable_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnFeatureHtmlTable</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {node}</span></span></span></dt><dd class=" odd"><p>Add any control elements for the table - specifically scrolling</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
993
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
994 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
995 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
996
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
997 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
998 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
999 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1000 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1001 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1002 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1003 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1004 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1005 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1006 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1007 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1008
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1009 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1010 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1011 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1012 </table><h5>Returns:</h5><p class="returns"><p>Node to add to the DOM</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1013 <dt id="DataTable#oApi._fnFilter" class=" even"><a name="_fnFilter"></a><a name="_fnFilter_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnFilter</a></span><span class="type-sig"><span class="signature">(oSettings, sInput, iForce, bRegex, bSmart, bCaseInsensitive)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Filter the data table based on user input and draw the table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1014
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1015 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1016 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1017
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1018 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1019 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1020 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1021 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1022 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1023 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1024 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1025 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1026 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1027 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1028 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1029
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1030 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1031 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</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 on</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iForce</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>optional - force a research of the master array (1) or not (undefined or 0)</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">bRegex</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>treat as a regular expression or not</p></td></tr><tr class="even"><td class="number right_border"><div>5</div></td><td class="name">bSmart</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>perform smart filtering or not</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"></td><td class="default"></td><td class="description last"><p>Do case insenstive matching or not</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1032 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1033 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1034 <dt id="DataTable#oApi._fnFilterColumn" class=" odd"><a name="_fnFilterColumn"></a><a name="_fnFilterColumn_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnFilterColumn</a></span><span class="type-sig"><span class="signature">(oSettings, sInput, iColumn, bRegex, bSmart, bCaseInsensitive)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Filter the table on a per-column basis</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1035
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1036 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1037 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1038
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1039 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1040 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1041 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1042 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1043 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1044 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1045 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1046 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1047 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1048 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1049 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1050
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1051 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1052 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</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 on</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"></td><td class="default"></td><td class="description last"><p>column to filter</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">bRegex</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>treat search string as a regular expression or not</p></td></tr><tr class="even"><td class="number right_border"><div>5</div></td><td class="name">bSmart</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>use smart filtering or not</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"></td><td class="default"></td><td class="description last"><p>Do case insenstive matching or not</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1053 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1054 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1055 <dt id="DataTable#oApi._fnFilterComplete" class=" even"><a name="_fnFilterComplete"></a><a name="_fnFilterComplete_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnFilterComplete</a></span><span class="type-sig"><span class="signature">(oSettings, oSearch, <span class="optional">iForce</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Filter the table using both the global filter and column based filtering</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1056
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1057 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1058 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1059
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1060 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1061 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1062 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1063 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1064 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1065 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1066 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1067 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1068 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1069 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1070 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1071
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1072 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1073 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">oSearch</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>search information</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iForce</td><td class="type type-param">int</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>force a research of the master array (1) or not (undefined or 0)</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1074 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1075 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1076 <dt id="DataTable#oApi._fnFilterCreateSearch" class=" odd"><a name="_fnFilterCreateSearch"></a><a name="_fnFilterCreateSearch_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnFilterCreateSearch</a></span><span class="type-sig"><span class="signature">(sSearch, bRegex, bSmart, bCaseInsensitive)</span><span class="type-signature"> &rarr; {RegExp}</span></span></span></dt><dd class=" odd"><p>Build a regular expression object suitable for searching a table</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">sSearch</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>string to search for</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">bRegex</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>treat as a regular expression or not</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">bSmart</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>perform smart filtering or not</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">bCaseInsensitive</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Do case insensitive matching or not</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1095 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1096 </table><h5>Returns:</h5><p class="returns"><p>constructed object</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1097 <dt id="DataTable#oApi._fnFilterCustom" class=" even"><a name="_fnFilterCustom"></a><a name="_fnFilterCustom_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnFilterCustom</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Apply custom filtering functions</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1098
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1099 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1100 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1101
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1102 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1103 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1104 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1105 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1106 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1107 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1108 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1109 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1110 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1111 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1112 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1113
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1114 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1115 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1116 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1117 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1118 <dt id="DataTable#oApi._fnGatherData" class=" odd"><a name="_fnGatherData"></a><a name="_fnGatherData_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnGatherData</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Read in the data from the target table from the DOM</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1119
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1120 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1121 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1122
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1123 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1124 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1125 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1126 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1127 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1128 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1129 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1130 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1131 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1132 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1133 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1134
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1135 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1136 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1137 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1138 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1139 <dt id="DataTable#oApi._fnGetCellData" class=" even"><a name="_fnGetCellData"></a><a name="_fnGetCellData_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnGetCellData</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, iCol, sSpecific)</span><span class="type-signature"> &rarr; {*}</span></span></span></dt><dd class=" even"><p>Get the data for a given cell from the internal cache, taking into account data mapping</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1140
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1141 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1142 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1143
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1144 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1145 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1146 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1147 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1148 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1149 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1150 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1151 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1152 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1153 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1154 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1155
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1156 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1157 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>aoData row id</p></td></tr><tr class="even"><td class="number right_border"><div>3</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>Column index</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">sSpecific</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>data get type ('display', 'type' 'filter' 'sort')</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1158 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1159 </table><h5>Returns:</h5><p class="returns"><p>Cell data</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1160 <dt id="DataTable#oApi._fnGetColumns" class=" odd"><a name="_fnGetColumns"></a><a name="_fnGetColumns_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnGetColumns</a></span><span class="type-sig"><span class="signature">(oSettings, sParam)</span><span class="type-signature"> &rarr; {array}</span></span></span></dt><dd class=" odd"><p>Get an array of column indexes that match a given property</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1161
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1162 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1163 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1164
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1165 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1166 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1167 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1168 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1169 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1170 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1171 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1172 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1173 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1174 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1175 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1176
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1177 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1178 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">sParam</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Parameter in aoColumns to look for - typically
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1179 bVisible or bSearchable</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1180 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1181 </table><h5>Returns:</h5><p class="returns"><p>Array of indexes with matched properties</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1182 <dt id="DataTable#oApi._fnGetDataMaster" class=" even"><a name="_fnGetDataMaster"></a><a name="_fnGetDataMaster_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnGetDataMaster</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Return an array with the full table data</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1183
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1184 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1185 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1186
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1187 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1188 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1189 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1190 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1191 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1192 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1193 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1194 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1195 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1196 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1197 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1198
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1199 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1200 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1201 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1202 </table><h5>Returns:</h5><p class="returns"><p>array {array} aData Master data array</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1203 <dt id="DataTable#oApi._fnGetMaxLenString" class=" odd"><a name="_fnGetMaxLenString"></a><a name="_fnGetMaxLenString_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnGetMaxLenString</a></span><span class="type-sig"><span class="signature">(oSettings, iCol)</span><span class="type-signature"> &rarr; {string}</span></span></span></dt><dd class=" odd"><p>Get the maximum strlen for each data column</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1204
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1205 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1206 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1207
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1208 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1209 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1210 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1211 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1212 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1213 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1214 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1215 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1216 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1217 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1218 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1219
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1220 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1221 <tr class="even"><td class="number right_border"><div>1</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="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"></td><td class="default"></td><td class="description last"><p>column of interest</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1222 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1223 </table><h5>Returns:</h5><p class="returns"><p>max string length for each column</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1224 <dt id="DataTable#oApi._fnGetObjectDataFn" class=" even"><a name="_fnGetObjectDataFn"></a><a name="_fnGetObjectDataFn_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnGetObjectDataFn</a></span><span class="type-sig"><span class="signature">(mSource)</span><span class="type-signature"> &rarr; {function}</span></span></span></dt><dd class=" even"><p>Return a function that can be used to get data from a source object, taking
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1225 into account the ability to use nested objects as a source</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1226
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1227 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1228 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1229
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1230 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1231 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1232 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1233 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1234 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1235 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1236 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1237 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1238 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1239 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1240 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1241
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1242 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1243 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">mSource</td><td class="type type-param">string | int | function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data source for the object</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1244 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1245 </table><h5>Returns:</h5><p class="returns"><p>Data get function</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1246 <dt id="DataTable#oApi._fnGetRowData" class=" odd"><a name="_fnGetRowData"></a><a name="_fnGetRowData_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnGetRowData</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, sSpecific, aiColumns)</span><span class="type-signature"> &rarr; {array}</span></span></span></dt><dd class=" odd"><p>Get an array of data for a given row from the internal data cache</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1247
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1248 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1249 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1250
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1251 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1252 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1253 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1254 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1255 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1256 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1257 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1258 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1259 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1260 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1261 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1262
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1263 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1264 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>aoData row id</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">sSpecific</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>data get type ('type' 'filter' 'sort')</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">aiColumns</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Array of column indexes to get data from</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1265 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1266 </table><h5>Returns:</h5><p class="returns"><p>Data array</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1267 <dt id="DataTable#oApi._fnGetTdNodes" class=" even"><a name="_fnGetTdNodes"></a><a name="_fnGetTdNodes_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnGetTdNodes</a></span><span class="type-sig"><span class="signature">(oSettings, <span class="optional">iIndividualRow</span>)</span><span class="type-signature"> &rarr; {array}</span></span></span></dt><dd class=" even"><p>Return an flat array with all TD nodes for the table, or row</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1268
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1269 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1270 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1271
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1272 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1273 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1274 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1275 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1276 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1277 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1278 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1279 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1280 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1281 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1282 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1283
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1284 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1285 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">iIndividualRow</td><td class="type type-param">int</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>aoData index to get the nodes for - optional
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1286 if not given then the return array will contain all nodes for the table</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1287 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1288 </table><h5>Returns:</h5><p class="returns"><p>TD array</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1289 <dt id="DataTable#oApi._fnGetTrNodes" class=" odd"><a name="_fnGetTrNodes"></a><a name="_fnGetTrNodes_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnGetTrNodes</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {array}</span></span></span></dt><dd class=" odd"><p>Return an array with the TR nodes for the table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1290
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1291 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1292 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1293
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1294 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1295 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1296 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1297 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1298 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1299 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1300 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1301 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1302 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1303 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1304 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1305
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1306 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1307 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1308 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1309 </table><h5>Returns:</h5><p class="returns"><p>TR array</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1310 <dt id="DataTable#oApi._fnGetUniqueThs" class=" even"><a name="_fnGetUniqueThs"></a><a name="_fnGetUniqueThs_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnGetUniqueThs</a></span><span class="type-sig"><span class="signature">(oSettings, nHeader, aLayout)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Get an array of unique th elements, one for each column</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1311
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1312 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1313 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1314
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1315 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1316 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1317 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1318 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1319 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1320 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1321 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1322 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1323 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1324 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1325 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1326
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1327 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1328 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">nHeader</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>automatically detect the layout from this node - optional</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">aLayout</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>thead/tfoot layout from _fnDetectHeader - optional</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1329 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1330 </table><h5>Returns:</h5><p class="returns"><p>array {node} aReturn list of unique th's</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1331 <dt id="DataTable#oApi._fnGetWidestNode" class=" odd"><a name="_fnGetWidestNode"></a><a name="_fnGetWidestNode_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnGetWidestNode</a></span><span class="type-sig"><span class="signature">(oSettings, iCol)</span><span class="type-signature"> &rarr; {node}</span></span></span></dt><dd class=" odd"><p>Get the widest node</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1332
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1333 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1334 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1335
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1336 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1337 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1338 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1339 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1340 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1341 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1342 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1343 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1344 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1345 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1346 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1347
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1348 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1349 <tr class="even"><td class="number right_border"><div>1</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="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"></td><td class="default"></td><td class="description last"><p>column of interest</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1350 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1351 </table><h5>Returns:</h5><p class="returns"><p>widest table node</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1352 <dt id="DataTable#oApi._fnInitComplete" class=" even"><a name="_fnInitComplete"></a><a name="_fnInitComplete_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnInitComplete</a></span><span class="type-sig"><span class="signature">(oSettings, <span class="optional">json</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Draw the table for the first time, adding all required features</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1353
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1354 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1355 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1356
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1357 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1358 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1359 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1360 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1361 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1362 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1363 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1364 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1365 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1366 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1367 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1368
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1369 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1370 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">json</td><td class="type type-param">object</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>JSON from the server that completed the table, if using Ajax source
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1371 with client-side processing (optional)</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1372 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1373 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1374 <dt id="DataTable#oApi._fnInitialise" class=" odd"><a name="_fnInitialise"></a><a name="_fnInitialise_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnInitialise</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Draw the table for the first time, adding all required features</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1375
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1376 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1377 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1378
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1379 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1380 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1381 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1382 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1383 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1384 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1385 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1386 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1387 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1388 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1389 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1390
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1391 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1392 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1393 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1394 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1395 <dt id="DataTable#oApi._fnLanguageCompat" class=" even"><a name="_fnLanguageCompat"></a><a name="_fnLanguageCompat_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnLanguageCompat</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Language compatibility - when certain options are given, and others aren't, we
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1396 need to duplicate the values over, in order to provide backwards compatibility
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1397 with older language files.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1398
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1399 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1400 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1401
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1402 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1403 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1404 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1405 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1406 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1407 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1408 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1409 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1410 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1411 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1412 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1413
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1414 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1415 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1416 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1417 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1418 <dt id="DataTable#oApi._fnLoadState" class=" odd"><a name="_fnLoadState"></a><a name="_fnLoadState_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnLoadState</a></span><span class="type-sig"><span class="signature">(oSettings, oInit)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Attempt to load a saved table state from a cookie</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1419
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1420 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1421 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1422
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1423 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1424 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1425 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1426 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1427 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1428 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1429 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1430 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1431 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1432 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1433 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1434
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1435 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1436 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">oInit</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables init object so we can override settings</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1437 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1438 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1439 <dt id="DataTable#oApi._fnLog" class=" even"><a name="_fnLog"></a><a name="_fnLog_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnLog</a></span><span class="type-sig"><span class="signature">(oSettings, iLevel, sMesg)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Log an error message</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1440
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1441 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1442 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1443
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1444 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1445 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1446 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1447 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1448 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1449 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1450 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1451 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1452 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1453 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1454 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1455
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1456 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1457 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">iLevel</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>log error messages, or display them to the user</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">sMesg</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>error message</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1458 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1459 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1460 <dt id="DataTable#oApi._fnMap" class=" odd"><a name="_fnMap"></a><a name="_fnMap_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnMap</a></span><span class="type-sig"><span class="signature">(oRet, oSrc, sName, <span class="optional">sMappedName</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>See if a property is defined on one object, if so assign it to the other object</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1461
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1462 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1463 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1464
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1465 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1466 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1467 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1468 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1469 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1470 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1471 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1472 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1473 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1474 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1475 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1476
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1477 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1478 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oRet</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>target object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oSrc</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>source object</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">sName</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>property</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">sMappedName</td><td class="type type-param">string</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>name to map too - optional, sName used if not given</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1479 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1480 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1481 <dt id="DataTable#oApi._fnNodeToColumnIndex" class=" even"><a name="_fnNodeToColumnIndex"></a><a name="_fnNodeToColumnIndex_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnNodeToColumnIndex</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, n)</span><span class="type-signature"> &rarr; {int}</span></span></span></dt><dd class=" even"><p>Take a TD element and convert it into a column data index (not the visible index)</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1482
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1483 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1484 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1485
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1486 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1487 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1488 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1489 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1490 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1491 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1492 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1493 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1494 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1495 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1496 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1497
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1498 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1499 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The row number the TD/TH can be found in</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">n</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The TD/TH element to find</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1500 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1501 </table><h5>Returns:</h5><p class="returns"><p>index if the node is found, -1 if not</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1502 <dt id="DataTable#oApi._fnNodeToDataIndex" class=" odd"><a name="_fnNodeToDataIndex"></a><a name="_fnNodeToDataIndex_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnNodeToDataIndex</a></span><span class="type-sig"><span class="signature">(oSettings, n)</span><span class="type-signature"> &rarr; {int}</span></span></span></dt><dd class=" odd"><p>Take a TR element and convert it to an index in aoData</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1503
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1504 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1505 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1506
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1507 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1508 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1509 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1510 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1511 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1512 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1513 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1514 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1515 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1516 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1517 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1518
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1519 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1520 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">n</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>the TR element to find</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1521 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1522 </table><h5>Returns:</h5><p class="returns"><p>index if the node is found, null if not</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1523 <dt id="DataTable#oApi._fnPageChange" class=" even"><a name="_fnPageChange"></a><a name="_fnPageChange_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnPageChange</a></span><span class="type-sig"><span class="signature">(oSettings, mAction)</span><span class="type-signature"> &rarr; {bool}</span></span></span></dt><dd class=" even"><p>Alter the display settings to change the page</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1524
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1525 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1526 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1527
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1528 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1529 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1530 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1531 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1532 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1533 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1534 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1535 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1536 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1537 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1538 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1539
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1540 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1541 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</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
1542 or page number to jump to (integer)</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1543 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1544 </table><h5>Returns:</h5><p class="returns"><p>true page has changed, false - no change (no effect) eg 'first' on page 1</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1545 <dt id="DataTable#oApi._fnProcessingDisplay" class=" odd"><a name="_fnProcessingDisplay"></a><a name="_fnProcessingDisplay_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnProcessingDisplay</a></span><span class="type-sig"><span class="signature">(oSettings, bShow)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Display or hide the processing indicator</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1546
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1547 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1548 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1549
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1550 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1551 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1552 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1553 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1554 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1555 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1556 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1557 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1558 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1559 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1560 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1561
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1562 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1563 <tr class="even"><td class="number right_border"><div>1</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="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 the processing indicator (true) or not (false)</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1564 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1565 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1566 <dt id="DataTable#oApi._fnReadCookie" class=" even"><a name="_fnReadCookie"></a><a name="_fnReadCookie_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnReadCookie</a></span><span class="type-sig"><span class="signature">(sName)</span><span class="type-signature"> &rarr; {string}</span></span></span></dt><dd class=" even"><p>Read an old cookie to get a cookie with an old table state</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1567
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1568 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1569 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1570
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1571 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1572 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1573 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1574 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1575 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1576 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1577 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1578 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1579 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1580 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1581 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1582
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1583 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1584 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sName</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>name of the cookie to read</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1585 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1586 </table><h5>Returns:</h5><p class="returns"><p>contents of the cookie - or null if no cookie with that name found</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1587 <dt id="DataTable#oApi._fnReDraw" class=" odd"><a name="_fnReDraw"></a><a name="_fnReDraw_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnReDraw</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Redraw the table - taking account of the various features which are enabled</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1588
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1589 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1590 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1591
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1592 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1593 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1594 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1595 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1596 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1597 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1598 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1599 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1600 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1601 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1602 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1603
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1604 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1605 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1606 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1607 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1608 <dt id="DataTable#oApi._fnRender" class=" even"><a name="_fnRender"></a><a name="_fnRender_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnRender</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, iCol)</span><span class="type-signature"> &rarr; {*}</span></span></span></dt><dd class=" even"><p>Call the developer defined fnRender function for a given cell (row/column) with
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1609 the required parameters and return the result.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1610
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1611 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1612 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1613
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1614 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1615 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1616 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1617 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1618 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1619 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1620 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1621 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1622 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1623 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1624 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1625
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1626 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1627 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>aoData index for the row</p></td></tr><tr class="even"><td class="number right_border"><div>3</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>aoColumns index for the column</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1628 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1629 </table><h5>Returns:</h5><p class="returns"><p>Return of the developer's fnRender function</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1630 <dt id="DataTable#oApi._fnReOrderIndex" class=" odd"><a name="_fnReOrderIndex"></a><a name="_fnReOrderIndex_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnReOrderIndex</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Figure out how to reorder a display list</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1631
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1632 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1633 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1634
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1635 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1636 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1637 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1638 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1639 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1640 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1641 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1642 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1643 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1644 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1645 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1646
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1647 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1648 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1649 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1650 </table><h5>Returns:</h5><p class="returns"><p>array {int} aiReturn index list for reordering</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1651 <dt id="DataTable#oApi._fnSaveState" class=" even"><a name="_fnSaveState"></a><a name="_fnSaveState_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnSaveState</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Save the state of a table in a cookie such that the page can be reloaded</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1652
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1653 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1654 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1655
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1656 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1657 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1658 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1659 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1660 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1661 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1662 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1663 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1664 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1665 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1666 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1667
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1668 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1669 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1670 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1671 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1672 <dt id="DataTable#oApi._fnScrollBarWidth" class=" odd"><a name="_fnScrollBarWidth"></a><a name="_fnScrollBarWidth_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnScrollBarWidth</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"> &rarr; {int}</span></span></span></dt><dd class=" odd"><p>Get the width of a scroll bar in this browser being used</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1673
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1674 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1675 <h5>Returns:</h5><p class="returns"><p>width in pixels</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1676 <dt id="DataTable#oApi._fnScrollDraw" class=" even"><a name="_fnScrollDraw"></a><a name="_fnScrollDraw_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnScrollDraw</a></span><span class="type-sig"><span class="signature">(o)</span><span class="type-signature"> &rarr; {node}</span></span></span></dt><dd class=" even"><p>Update the various tables for resizing. It's a bit of a pig this function, but
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1677 basically the idea to:
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1678 1. Re-create the table inside the scrolling div
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1679 2. Take live measurements from the DOM
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1680 3. Apply the measurements
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1681 4. Clean up</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1682
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1683 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1684 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1685
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1686 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1687 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1688 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1689 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1690 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1691 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1692 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1693 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1694 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1695 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1696 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1697
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1698 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1699 <tr class="even"><td class="number right_border"><div>1</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</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1700 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1701 </table><h5>Returns:</h5><p class="returns"><p>Node to add to the DOM</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1702 <dt id="DataTable#oApi._fnScrollingWidthAdjust" class=" odd"><a name="_fnScrollingWidthAdjust"></a><a name="_fnScrollingWidthAdjust_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnScrollingWidthAdjust</a></span><span class="type-sig"><span class="signature">(oSettings, n)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Adjust a table's width to take account of scrolling</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1703
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1704 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1705 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1706
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1707 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1708 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1709 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1710 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1711 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1712 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1713 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1714 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1715 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1716 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1717 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1718
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1719 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1720 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">n</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>table node</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1721 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1722 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1723 <dt id="DataTable#oApi._fnServerParams" class=" even"><a name="_fnServerParams"></a><a name="_fnServerParams_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnServerParams</a></span><span class="type-sig"><span class="signature">(oSettings, array)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Add Ajax parameters from plug-ins</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1724
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1725 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1726 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1727
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1728 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1729 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1730 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1731 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1732 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1733 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1734 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1735 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1736 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1737 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1738 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1739
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1740 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1741 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">array</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>{objects} aoData name/value pairs to send to the server</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1742 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1743 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1744 <dt id="DataTable#oApi._fnSetCellData" class=" odd"><a name="_fnSetCellData"></a><a name="_fnSetCellData_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnSetCellData</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, iCol, val)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Set the value for a specific cell, into the internal data cache</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1745
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1746 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1747 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1748
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1749 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1750 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1751 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1752 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1753 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1754 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1755 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1756 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1757 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1758 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1759 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1760
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1761 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1762 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>aoData row id</p></td></tr><tr class="even"><td class="number right_border"><div>3</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>Column index</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">val</td><td class="type type-param">*</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Value to set</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1763 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1764 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1765 <dt id="DataTable#oApi._fnSetObjectDataFn" class=" even"><a name="_fnSetObjectDataFn"></a><a name="_fnSetObjectDataFn_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnSetObjectDataFn</a></span><span class="type-sig"><span class="signature">(mSource)</span><span class="type-signature"> &rarr; {function}</span></span></span></dt><dd class=" even"><p>Return a function that can be used to set data from a source object, taking
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1766 into account the ability to use nested objects as a source</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1767
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1768 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1769 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1770
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1771 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1772 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1773 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1774 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1775 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1776 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1777 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1778 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1779 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1780 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1781 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1782
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1783 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1784 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">mSource</td><td class="type type-param">string | int | function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data source for the object</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1785 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1786 </table><h5>Returns:</h5><p class="returns"><p>Data set function</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1787 <dt id="DataTable#oApi._fnSettingsFromNode" class=" odd"><a name="_fnSettingsFromNode"></a><a name="_fnSettingsFromNode_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnSettingsFromNode</a></span><span class="type-sig"><span class="signature">(nTable)</span><span class="type-signature"> &rarr; {object}</span></span></span></dt><dd class=" odd"><p>Return the settings object for a particular table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1788
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1789 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1790 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1791
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1792 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1793 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1794 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1795 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1796 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1797 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1798 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1799 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1800 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1801 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1802 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1803
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1804 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1805 <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>table we are using as a dataTable</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1806 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1807 </table><h5>Returns:</h5><p class="returns"><p>Settings object - or null if not found</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1808 <dt id="DataTable#oApi._fnSort" class=" even"><a name="_fnSort"></a><a name="_fnSort_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnSort</a></span><span class="type-sig"><span class="signature">(oSettings, bApplyClasses)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Change the order of the table</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1809
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1810 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1811 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1812
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1813 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1814 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1815 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1816 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1817 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1818 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1819 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1820 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1821 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1822 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1823 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1824
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1825 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1826 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">bApplyClasses</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>optional - should we apply classes or not</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1827 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1828 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1829 <dt id="DataTable#oApi._fnSortAttachListener" class=" odd"><a name="_fnSortAttachListener"></a><a name="_fnSortAttachListener_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnSortAttachListener</a></span><span class="type-sig"><span class="signature">(oSettings, nNode, iDataIndex, <span class="optional">fnCallback</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Attach a sort handler (click) to a node</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1830
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1831 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1832 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1833
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1834 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1835 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1836 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1837 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1838 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1839 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1840 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1841 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1842 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1843 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1844 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1845
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1846 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1847 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</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>node to attach the handler to</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iDataIndex</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>column sorting index</p></td></tr><tr class="odd"><td class="number right_border"><div>4</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</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1848 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1849 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1850 <dt id="DataTable#oApi._fnSortingClasses" class=" even"><a name="_fnSortingClasses"></a><a name="_fnSortingClasses_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnSortingClasses</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Set the sorting classes on the header, Note: it is safe to call this function
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1851 when bSort and bSortClasses are false</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1852
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1853 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1854 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1855
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1856 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1857 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1858 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1859 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1860 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1861 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1862 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1863 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1864 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1865 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1866 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1867
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1868 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1869 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1870 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1871 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1872 <dt id="DataTable#oApi._fnStringToCss" class=" odd"><a name="_fnStringToCss"></a><a name="_fnStringToCss_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnStringToCss</a></span><span class="type-sig"><span class="signature">(aArray1, aArray2)</span><span class="type-signature"> &rarr; {int}</span></span></span></dt><dd class=" odd"><p>Append a CSS unit (only if required) to a string</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1873
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1874 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1875 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1876
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1877 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1878 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1879 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1880 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1881 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1882 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1883 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1884 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1885 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1886 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1887 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1888
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1889 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1890 <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">aArray1</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>first array</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">aArray2</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>second array</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1891 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1892 </table><h5>Returns:</h5><p class="returns"><p>0 if match, 1 if length is different, 2 if no match</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1893 <dt id="DataTable#oApi._fnUpdateInfo" class=" even"><a name="_fnUpdateInfo"></a><a name="_fnUpdateInfo_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnUpdateInfo</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Update the information elements in the display</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1894
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1895 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1896 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1897
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1898 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1899 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1900 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1901 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1902 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1903 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1904 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1905 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1906 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1907 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1908 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1909
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1910 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1911 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1912 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1913 </table></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1914 <dt id="DataTable#oApi._fnVisbleColumns" class=" odd"><a name="_fnVisbleColumns"></a><a name="_fnVisbleColumns_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnVisbleColumns</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> &rarr; {int}</span></span></span></dt><dd class=" odd"><p>Get the number of visible columns</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1915
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1916 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1917 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1918
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1919 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1920 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1921 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1922 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1923 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1924 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1925 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1926 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1927 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1928 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1929 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1930
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1931 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1932 <tr class="even"><td class="number right_border"><div>1</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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1933 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1934 </table><h5>Returns:</h5><p class="returns"><p>i the number of visible columns</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1935 <dt id="DataTable#oApi._fnVisibleToColumnIndex" class=" even"><a name="_fnVisibleToColumnIndex"></a><a name="_fnVisibleToColumnIndex_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a>_fnVisibleToColumnIndex</a></span><span class="type-sig"><span class="signature">(oSettings, iMatch)</span><span class="type-signature"> &rarr; {int}</span></span></span></dt><dd class=" even"><p>Covert the index of a visible column to the index in the data array (take account
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1936 of hidden columns)</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1937
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1938 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1939 <h5>Parameters:</h5>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1940
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1941 <table class="params">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1942 <thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1943 <tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1944 <th width="20"></th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1945 <th width="12%" class="bottom_border name">Name</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1946 <th width="10%" class="bottom_border">Type</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1947 <th width="10%" class="bottom_border">Attributes</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1948 <th width="10%" class="bottom_border">Default</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1949 <th class="last bottom_border">Description</th>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1950 </tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1951 </thead>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1952
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1953 <tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1954 <tr class="even"><td class="number right_border"><div>1</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="odd"><td class="number right_border"><div>2</div></td><td class="name">iMatch</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Visible column index to lookup</p></td></tr>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1955 </tbody>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1956 </table><h5>Returns:</h5><p class="returns"><p>i the data index</p></p></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1957
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1958 </dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1959 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1960 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1961
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1962 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1963
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1964 <div class="fw_footer">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1965 DataTables: Copyright 2008-2012 Allan Jardine, all rights reserved<br>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1966
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1967 Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1968 23th Sep 2012 - 14:27
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1969 with the <a href="http://datatables.net/">DataTables</a> template.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1970 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1971 </body>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1972 </html>