1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
2 |
<html> |
3 |
<head> |
4 |
<meta http-equiv="Content-type" content="text/html; charset=utf-8"> |
5 |
<title>Namespace: oApi - documentation</title> |
6 |
|
7 |
<style type="text/css" media="screen"> |
8 |
@import "media/css/doc.css"; |
9 |
@import "media/css/shCore.css"; |
10 |
@import "media/css/shThemeDataTables.css"; |
11 |
</style> |
12 |
|
13 |
<script type="text/javascript" src="media/js/shCore.js"></script> |
14 |
<script type="text/javascript" src="media/js/shBrushJScript.js"></script> |
15 |
<script type="text/javascript" src="media/js/jquery.js"></script> |
16 |
<script type="text/javascript" src="media/js/doc.js"></script> |
17 |
</head> |
18 |
<body> |
19 |
<div class="fw_container"> |
20 |
|
21 |
<a name="top"></a> |
22 |
<div class="fw_header"> |
23 |
<h1 class="page-title">Namespace: oApi</h1> |
24 |
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a>#</span> ยป oApi</h2> |
25 |
<div class="page-info"> |
26 |
DataTables v1.9.4 documentation |
27 |
</div> |
28 |
</div> |
29 |
|
30 |
|
31 |
|
32 |
<div class="fw_nav"> |
33 |
<h2>Navigation</h2> |
34 |
<ul> |
35 |
<li><a href="#top">Overview</a></li> |
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> |
37 |
<div style="margin-top: 10px;"> |
38 |
<input type="hidden" name="show_private" value="0"> |
39 |
<span id="private_label">Hiding</span> private elements |
40 |
(<a id="private_toggle" href="">toggle</a>) |
41 |
</span> |
42 |
</div> |
43 |
<div> |
44 |
<input type="hidden" name="show_extended" value="1"> |
45 |
<span id="extended_label">Showing</span> extended elements |
46 |
(<a id="extended_toggle" href="">toggle</a>) |
47 |
</span> |
48 |
</div> |
49 |
</div> |
50 |
|
51 |
<div class="fw_content"> |
52 |
<a name="overview"></a> |
53 |
<div class="doc_overview"> |
54 |
<div class="nav_blocker"></div> |
55 |
<p>Reference to internal functions for use by plug-in developers. Note that these |
56 |
methods are references to internal functions and are considered to be private. |
57 |
If you use these methods, be aware that they are liable to change between versions |
58 |
(check the upgrade notes).</p><dl class="details"> |
59 |
|
60 |
</dl> |
61 |
|
62 |
</div> |
63 |
|
64 |
|
65 |
<div class="doc_summary"> |
66 |
<a name="summary"></a> |
67 |
<h2>Summary</h2> |
68 |
|
69 |
<div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3> |
70 |
|
71 |
<dl> |
72 |
<dt class=" even"><span class="type-attr"><span class="type-signature"><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 |
73 |
library, then we use that as it is fast, safe and accurate. If the function isn't |
74 |
available then we need to built it ourselves - the inspiration for this function comes |
75 |
from Craig Buckler ( <a href='http://www.sitepoint.com/javascript-json-serialization/'>http://www.sitepoint.com/javascript-json-serialization/</a> ). It is |
76 |
not perfect and absolutely should not be used as a replacement to json2.js - but it does |
77 |
do what we need, without requiring a dependency for DataTables.</p></dd> |
78 |
</dl></div><div class="doc_group"><a name="summary_methods_static"></a><h3 class="subsection-title">Methods - static</h3> |
79 |
|
80 |
<dl> |
81 |
<dt class=" even"><span class="type-attr"><span class="type-signature"><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"><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"> → {int}</span></span></dt><dd class=" odd"><p>Add a data array to the table, creating DOM node etc. This is the parallel to |
82 |
_fnGatherData, but for adding rows from a Javascript source, rather than a |
83 |
DOM source.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><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"><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 |
84 |
do a redraw after calling this function!</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><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"> → {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"><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"> → {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"><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"><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 |
85 |
they relate to column indexes. The callback function will then apply the |
86 |
definition found for a column to a suitable configuration object.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><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 |
87 |
TD children of TR rows</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><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. |
88 |
This is good for accessibility since a return on the keyboard will have the |
89 |
same effect as a click, if the element has focus.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><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 |
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"><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"><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"><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"><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"><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"><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 |
91 |
array store is done backwards! Further note that you do not want to fire off triggers |
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"><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 |
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"><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"><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"> → {int}</span></span></dt><dd class=" odd"><p>Covert the index of an index in the data array and convert it to the visible |
94 |
column index (take account of hidden columns)</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><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"><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"> → {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"><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"> → {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"><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"><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"><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"> → {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"><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 |
95 |
the key!)</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><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 |
96 |
create a layout grid (array) of rows x columns, which contains a reference |
97 |
to the cell that that point in the grid (regardless of col/rowspan), such that |
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"><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"> → {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"><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"><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 |
99 |
methodology here is to use the layout array from _fnDetectHeader, modified for |
100 |
the instantaneous column visibility, to construct the new layout. The grid is |
101 |
traversed over cell at a time in a rows x columns grid fashion, although each |
102 |
cell insert can cover multiple elements in the grid - which is tracks using the |
103 |
aApplied array. Cell inserts in the grid will only occur where there isn't |
104 |
already a cell in that position.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><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"> → {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"><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"> → {object}</span></span></dt><dd class=" even"><p>Extend objects - very similar to jQuery.extend, but deep copy objects, and shallow |
105 |
copy arrays. The reason we need to do this, is that we don't want to deep copy array |
106 |
init values (such as aaSorting) since the dev wouldn't be able to override them, but |
107 |
we do want to deep copy arrays.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><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"> → {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"><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"> → {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"><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"> → {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"><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"> → {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"><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"> → {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"><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"> → {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"><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"> → {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"><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"><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"><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"><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"> → {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"><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"><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"><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"> → {*}</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"><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"> → {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"><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"><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"> → {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"><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"> → {function}</span></span></dt><dd class=" even"><p>Return a function that can be used to get data from a source object, taking |
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"><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"> → {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"><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"> → {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"><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"> → {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"><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"><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"> → {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"><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"><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"><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 |
109 |
need to duplicate the values over, in order to provide backwards compatibility |
110 |
with older language files.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><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"><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"><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"><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"> → {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"><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"> → {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"><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"> → {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"><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"><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"> → {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"><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"><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"> → {*}</span></span></dt><dd class=" even"><p>Call the developer defined fnRender function for a given cell (row/column) with |
111 |
the required parameters and return the result.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><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"><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"><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"> → {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"><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"> → {node}</span></span></dt><dd class=" even"><p>Update the various tables for resizing. It's a bit of a pig this function, but |
112 |
basically the idea to: |
113 |
1. Re-create the table inside the scrolling div |
114 |
2. Take live measurements from the DOM |
115 |
3. Apply the measurements |
116 |
4. Clean up</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><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"><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"><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"><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"> → {function}</span></span></dt><dd class=" even"><p>Return a function that can be used to set data from a source object, taking |
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"><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"> → {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"><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"><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"><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 |
118 |
when bSort and bSortClasses are false</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><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"> → {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"><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"><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"> → {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"><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"> → {int}</span></span></dt><dd class=" even"><p>Covert the index of a visible column to the index in the data array (take account |
119 |
of hidden columns)</p></dd> |
120 |
</dl> |
121 |
</div> |
122 |
</div> |
123 |
|
124 |
|
125 |
|
126 |
|
127 |
<div class="doc_details"> |
128 |
<a name="details"></a> |
129 |
<h2>Details</h2> |
130 |
<div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3> |
131 |
<dl> |
132 |
<dt class=" even"><a name="_fnJsonString"></a><a name="_fnJsonString_details"></a><span class="type-attr"><span class="type-signature"><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 |
133 |
library, then we use that as it is fast, safe and accurate. If the function isn't |
134 |
available then we need to built it ourselves - the inspiration for this function comes |
135 |
from Craig Buckler ( <a href='http://www.sitepoint.com/javascript-json-serialization/'>http://www.sitepoint.com/javascript-json-serialization/</a> ). It is |
136 |
not perfect and absolutely should not be used as a replacement to json2.js - but it does |
137 |
do what we need, without requiring a dependency for DataTables.</p><div class="collapse_details"><dl class="details"> |
138 |
|
139 |
</dl> |
140 |
</div></dd> |
141 |
</dl></div><div class="doc_group"><a name="details_methods"></a><h3 class="subsection-title">Methods - static</h3> |
142 |
<dl> |
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"><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"> |
144 |
|
145 |
</dl> |
146 |
<h5>Parameters:</h5> |
147 |
|
148 |
<table class="params"> |
149 |
<thead> |
150 |
<tr> |
151 |
<th width="20"></th> |
152 |
<th width="12%" class="bottom_border name">Name</th> |
153 |
<th width="10%" class="bottom_border">Type</th> |
154 |
<th width="10%" class="bottom_border">Attributes</th> |
155 |
<th width="10%" class="bottom_border">Default</th> |
156 |
<th class="last bottom_border">Description</th> |
157 |
</tr> |
158 |
</thead> |
159 |
|
160 |
<tbody> |
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> |
162 |
</tbody> |
163 |
</table></div> |
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"><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"> → {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 |
165 |
_fnGatherData, but for adding rows from a Javascript source, rather than a |
166 |
DOM source.</p><div class="collapse_details"><dl class="details"> |
167 |
|
168 |
</dl> |
169 |
<h5>Parameters:</h5> |
170 |
|
171 |
<table class="params"> |
172 |
<thead> |
173 |
<tr> |
174 |
<th width="20"></th> |
175 |
<th width="12%" class="bottom_border name">Name</th> |
176 |
<th width="10%" class="bottom_border">Type</th> |
177 |
<th width="10%" class="bottom_border">Attributes</th> |
178 |
<th width="10%" class="bottom_border">Default</th> |
179 |
<th class="last bottom_border">Description</th> |
180 |
</tr> |
181 |
</thead> |
182 |
|
183 |
<tbody> |
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> |
185 |
</tbody> |
186 |
</table><h5>Returns:</h5><p class="returns"><blockquote> |
187 |
<p>=0 if successful (index of new aoData entry), -1 if failed</p> |
188 |
</blockquote></p></div> |
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"><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"> |
190 |
|
191 |
</dl> |
192 |
<h5>Parameters:</h5> |
193 |
|
194 |
<table class="params"> |
195 |
<thead> |
196 |
<tr> |
197 |
<th width="20"></th> |
198 |
<th width="12%" class="bottom_border name">Name</th> |
199 |
<th width="10%" class="bottom_border">Type</th> |
200 |
<th width="10%" class="bottom_border">Attributes</th> |
201 |
<th width="10%" class="bottom_border">Default</th> |
202 |
<th class="last bottom_border">Description</th> |
203 |
</tr> |
204 |
</thead> |
205 |
|
206 |
<tbody> |
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> |
208 |
</tbody> |
209 |
</table></div> |
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"><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 |
211 |
do a redraw after calling this function!</p><div class="collapse_details"><dl class="details"> |
212 |
|
213 |
</dl> |
214 |
<h5>Parameters:</h5> |
215 |
|
216 |
<table class="params"> |
217 |
<thead> |
218 |
<tr> |
219 |
<th width="20"></th> |
220 |
<th width="12%" class="bottom_border name">Name</th> |
221 |
<th width="10%" class="bottom_border">Type</th> |
222 |
<th width="10%" class="bottom_border">Attributes</th> |
223 |
<th width="10%" class="bottom_border">Default</th> |
224 |
<th class="last bottom_border">Description</th> |
225 |
</tr> |
226 |
</thead> |
227 |
|
228 |
<tbody> |
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> |
230 |
</tbody> |
231 |
</table></div> |
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"><static> </span></span><span class="type-name"><a>_fnAjaxParameters</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {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"> |
233 |
|
234 |
</dl> |
235 |
<h5>Parameters:</h5> |
236 |
|
237 |
<table class="params"> |
238 |
<thead> |
239 |
<tr> |
240 |
<th width="20"></th> |
241 |
<th width="12%" class="bottom_border name">Name</th> |
242 |
<th width="10%" class="bottom_border">Type</th> |
243 |
<th width="10%" class="bottom_border">Attributes</th> |
244 |
<th width="10%" class="bottom_border">Default</th> |
245 |
<th class="last bottom_border">Description</th> |
246 |
</tr> |
247 |
</thead> |
248 |
|
249 |
<tbody> |
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> |
251 |
</tbody> |
252 |
</table><h5>Returns:</h5><p class="returns"><p>block the table drawing or not</p></p></div> |
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"><static> </span></span><span class="type-name"><a>_fnAjaxUpdate</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {boolean}</span></span></span></dt><dd class=" odd"><p>Update the table using an Ajax call</p><div class="collapse_details"><dl class="details"> |
254 |
|
255 |
</dl> |
256 |
<h5>Parameters:</h5> |
257 |
|
258 |
<table class="params"> |
259 |
<thead> |
260 |
<tr> |
261 |
<th width="20"></th> |
262 |
<th width="12%" class="bottom_border name">Name</th> |
263 |
<th width="10%" class="bottom_border">Type</th> |
264 |
<th width="10%" class="bottom_border">Attributes</th> |
265 |
<th width="10%" class="bottom_border">Default</th> |
266 |
<th class="last bottom_border">Description</th> |
267 |
</tr> |
268 |
</thead> |
269 |
|
270 |
<tbody> |
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> |
272 |
</tbody> |
273 |
</table><h5>Returns:</h5><p class="returns"><p>Block the table drawing or not</p></p></div> |
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"><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"> |
275 |
|
276 |
</dl> |
277 |
<h5>Parameters:</h5> |
278 |
|
279 |
<table class="params"> |
280 |
<thead> |
281 |
<tr> |
282 |
<th width="20"></th> |
283 |
<th width="12%" class="bottom_border name">Name</th> |
284 |
<th width="10%" class="bottom_border">Type</th> |
285 |
<th width="10%" class="bottom_border">Attributes</th> |
286 |
<th width="10%" class="bottom_border">Default</th> |
287 |
<th class="last bottom_border">Description</th> |
288 |
</tr> |
289 |
</thead> |
290 |
|
291 |
<tbody> |
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"><optional><br></td><td class="default"></td><td class="description last"><p>Column ordering (sName, comma separated)</p></td></tr> |
293 |
</tbody> |
294 |
</table></div> |
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"><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 |
296 |
they relate to column indexes. The callback function will then apply the |
297 |
definition found for a column to a suitable configuration object.</p><div class="collapse_details"><dl class="details"> |
298 |
|
299 |
</dl> |
300 |
<h5>Parameters:</h5> |
301 |
|
302 |
<table class="params"> |
303 |
<thead> |
304 |
<tr> |
305 |
<th width="20"></th> |
306 |
<th width="12%" class="bottom_border name">Name</th> |
307 |
<th width="10%" class="bottom_border">Type</th> |
308 |
<th width="10%" class="bottom_border">Attributes</th> |
309 |
<th width="10%" class="bottom_border">Default</th> |
310 |
<th class="last bottom_border">Description</th> |
311 |
</tr> |
312 |
</thead> |
313 |
|
314 |
<tbody> |
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 |
316 |
column index and the definition for that column.</p></td></tr> |
317 |
</tbody> |
318 |
</table></div> |
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"><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 |
320 |
TD children of TR rows</p><div class="collapse_details"><dl class="details"> |
321 |
|
322 |
</dl> |
323 |
<h5>Parameters:</h5> |
324 |
|
325 |
<table class="params"> |
326 |
<thead> |
327 |
<tr> |
328 |
<th width="20"></th> |
329 |
<th width="12%" class="bottom_border name">Name</th> |
330 |
<th width="10%" class="bottom_border">Type</th> |
331 |
<th width="10%" class="bottom_border">Attributes</th> |
332 |
<th width="10%" class="bottom_border">Default</th> |
333 |
<th class="last bottom_border">Description</th> |
334 |
</tr> |
335 |
</thead> |
336 |
|
337 |
<tbody> |
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> |
339 |
</tbody> |
340 |
</table></div> |
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"><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. |
342 |
This is good for accessibility since a return on the keyboard will have the |
343 |
same effect as a click, if the element has focus.</p><div class="collapse_details"><dl class="details"> |
344 |
|
345 |
</dl> |
346 |
<h5>Parameters:</h5> |
347 |
|
348 |
<table class="params"> |
349 |
<thead> |
350 |
<tr> |
351 |
<th width="20"></th> |
352 |
<th width="12%" class="bottom_border name">Name</th> |
353 |
<th width="10%" class="bottom_border">Type</th> |
354 |
<th width="10%" class="bottom_border">Attributes</th> |
355 |
<th width="10%" class="bottom_border">Default</th> |
356 |
<th class="last bottom_border">Description</th> |
357 |
</tr> |
358 |
</thead> |
359 |
|
360 |
<tbody> |
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> |
362 |
</tbody> |
363 |
</table></div> |
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"><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 |
365 |
bugs - this function is used to detect when these workarounds are needed.</p><div class="collapse_details"><dl class="details"> |
366 |
|
367 |
</dl> |
368 |
<h5>Parameters:</h5> |
369 |
|
370 |
<table class="params"> |
371 |
<thead> |
372 |
<tr> |
373 |
<th width="20"></th> |
374 |
<th width="12%" class="bottom_border name">Name</th> |
375 |
<th width="10%" class="bottom_border">Type</th> |
376 |
<th width="10%" class="bottom_border">Attributes</th> |
377 |
<th width="10%" class="bottom_border">Default</th> |
378 |
<th class="last bottom_border">Description</th> |
379 |
</tr> |
380 |
</thead> |
381 |
|
382 |
<tbody> |
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> |
384 |
</tbody> |
385 |
</table></div> |
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"><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"> |
387 |
|
388 |
</dl> |
389 |
<h5>Parameters:</h5> |
390 |
|
391 |
<table class="params"> |
392 |
<thead> |
393 |
<tr> |
394 |
<th width="20"></th> |
395 |
<th width="12%" class="bottom_border name">Name</th> |
396 |
<th width="10%" class="bottom_border">Type</th> |
397 |
<th width="10%" class="bottom_border">Attributes</th> |
398 |
<th width="10%" class="bottom_border">Default</th> |
399 |
<th class="last bottom_border">Description</th> |
400 |
</tr> |
401 |
</thead> |
402 |
|
403 |
<tbody> |
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> |
405 |
</tbody> |
406 |
</table></div> |
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"><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"> |
408 |
|
409 |
</dl> |
410 |
<h5>Parameters:</h5> |
411 |
|
412 |
<table class="params"> |
413 |
<thead> |
414 |
<tr> |
415 |
<th width="20"></th> |
416 |
<th width="12%" class="bottom_border name">Name</th> |
417 |
<th width="10%" class="bottom_border">Type</th> |
418 |
<th width="10%" class="bottom_border">Attributes</th> |
419 |
<th width="10%" class="bottom_border">Default</th> |
420 |
<th class="last bottom_border">Description</th> |
421 |
</tr> |
422 |
</thead> |
423 |
|
424 |
<tbody> |
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> |
426 |
</tbody> |
427 |
</table></div> |
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"><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"> |
429 |
|
430 |
</dl> |
431 |
<h5>Parameters:</h5> |
432 |
|
433 |
<table class="params"> |
434 |
<thead> |
435 |
<tr> |
436 |
<th width="20"></th> |
437 |
<th width="12%" class="bottom_border name">Name</th> |
438 |
<th width="10%" class="bottom_border">Type</th> |
439 |
<th width="10%" class="bottom_border">Attributes</th> |
440 |
<th width="10%" class="bottom_border">Default</th> |
441 |
<th class="last bottom_border">Description</th> |
442 |
</tr> |
443 |
</thead> |
444 |
|
445 |
<tbody> |
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> |
447 |
</tbody> |
448 |
</table></div> |
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"><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"> |
450 |
|
451 |
</dl> |
452 |
<h5>Parameters:</h5> |
453 |
|
454 |
<table class="params"> |
455 |
<thead> |
456 |
<tr> |
457 |
<th width="20"></th> |
458 |
<th width="12%" class="bottom_border name">Name</th> |
459 |
<th width="10%" class="bottom_border">Type</th> |
460 |
<th width="10%" class="bottom_border">Attributes</th> |
461 |
<th width="10%" class="bottom_border">Default</th> |
462 |
<th class="last bottom_border">Description</th> |
463 |
</tr> |
464 |
</thead> |
465 |
|
466 |
<tbody> |
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> |
468 |
</tbody> |
469 |
</table></div> |
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"><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"> |
471 |
|
472 |
</dl> |
473 |
<h5>Parameters:</h5> |
474 |
|
475 |
<table class="params"> |
476 |
<thead> |
477 |
<tr> |
478 |
<th width="20"></th> |
479 |
<th width="12%" class="bottom_border name">Name</th> |
480 |
<th width="10%" class="bottom_border">Type</th> |
481 |
<th width="10%" class="bottom_border">Attributes</th> |
482 |
<th width="10%" class="bottom_border">Default</th> |
483 |
<th class="last bottom_border">Description</th> |
484 |
</tr> |
485 |
</thead> |
486 |
|
487 |
<tbody> |
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> |
489 |
</tbody> |
490 |
</table></div> |
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"><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 |
492 |
array store is done backwards! Further note that you do not want to fire off triggers |
493 |
in time sensitive applications (for example cell creation) as its slow.</p><div class="collapse_details"><dl class="details"> |
494 |
|
495 |
</dl> |
496 |
<h5>Parameters:</h5> |
497 |
|
498 |
<table class="params"> |
499 |
<thead> |
500 |
<tr> |
501 |
<th width="20"></th> |
502 |
<th width="12%" class="bottom_border name">Name</th> |
503 |
<th width="10%" class="bottom_border">Type</th> |
504 |
<th width="10%" class="bottom_border">Attributes</th> |
505 |
<th width="10%" class="bottom_border">Default</th> |
506 |
<th class="last bottom_border">Description</th> |
507 |
</tr> |
508 |
</thead> |
509 |
|
510 |
<tbody> |
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 |
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> |
513 |
</tbody> |
514 |
</table></div> |
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"><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 |
516 |
an array store of callback functions that can then all be called together.</p><div class="collapse_details"><dl class="details"> |
517 |
|
518 |
</dl> |
519 |
<h5>Parameters:</h5> |
520 |
|
521 |
<table class="params"> |
522 |
<thead> |
523 |
<tr> |
524 |
<th width="20"></th> |
525 |
<th width="12%" class="bottom_border name">Name</th> |
526 |
<th width="10%" class="bottom_border">Type</th> |
527 |
<th width="10%" class="bottom_border">Attributes</th> |
528 |
<th width="10%" class="bottom_border">Default</th> |
529 |
<th class="last bottom_border">Description</th> |
530 |
</tr> |
531 |
</thead> |
532 |
|
533 |
<tbody> |
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> |
535 |
</tbody> |
536 |
</table></div> |
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"><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"> |
538 |
|
539 |
</dl> |
540 |
<h5>Parameters:</h5> |
541 |
|
542 |
<table class="params"> |
543 |
<thead> |
544 |
<tr> |
545 |
<th width="20"></th> |
546 |
<th width="12%" class="bottom_border name">Name</th> |
547 |
<th width="10%" class="bottom_border">Type</th> |
548 |
<th width="10%" class="bottom_border">Attributes</th> |
549 |
<th width="10%" class="bottom_border">Default</th> |
550 |
<th class="last bottom_border">Description</th> |
551 |
</tr> |
552 |
</thead> |
553 |
|
554 |
<tbody> |
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> |
556 |
</tbody> |
557 |
</table></div> |
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"><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"> → {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 |
559 |
column index (take account of hidden columns)</p><div class="collapse_details"><dl class="details"> |
560 |
|
561 |
</dl> |
562 |
<h5>Parameters:</h5> |
563 |
|
564 |
<table class="params"> |
565 |
<thead> |
566 |
<tr> |
567 |
<th width="20"></th> |
568 |
<th width="12%" class="bottom_border name">Name</th> |
569 |
<th width="10%" class="bottom_border">Type</th> |
570 |
<th width="10%" class="bottom_border">Attributes</th> |
571 |
<th width="10%" class="bottom_border">Default</th> |
572 |
<th class="last bottom_border">Description</th> |
573 |
</tr> |
574 |
</thead> |
575 |
|
576 |
<tbody> |
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> |
578 |
</tbody> |
579 |
</table><h5>Returns:</h5><p class="returns"><p>i the data index</p></p></div> |
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"><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"> |
581 |
|
582 |
</dl> |
583 |
<h5>Parameters:</h5> |
584 |
|
585 |
<table class="params"> |
586 |
<thead> |
587 |
<tr> |
588 |
<th width="20"></th> |
589 |
<th width="12%" class="bottom_border name">Name</th> |
590 |
<th width="10%" class="bottom_border">Type</th> |
591 |
<th width="10%" class="bottom_border">Attributes</th> |
592 |
<th width="10%" class="bottom_border">Default</th> |
593 |
<th class="last bottom_border">Description</th> |
594 |
</tr> |
595 |
</thead> |
596 |
|
597 |
<tbody> |
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> |
599 |
</tbody> |
600 |
</table></div> |
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"><static> </span></span><span class="type-name"><a>_fnColumnOrdering</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {string}</span></span></span></dt><dd class=" odd"><p>Get the column ordering that DataTables expects</p><div class="collapse_details"><dl class="details"> |
602 |
|
603 |
</dl> |
604 |
<h5>Parameters:</h5> |
605 |
|
606 |
<table class="params"> |
607 |
<thead> |
608 |
<tr> |
609 |
<th width="20"></th> |
610 |
<th width="12%" class="bottom_border name">Name</th> |
611 |
<th width="10%" class="bottom_border">Type</th> |
612 |
<th width="10%" class="bottom_border">Attributes</th> |
613 |
<th width="10%" class="bottom_border">Default</th> |
614 |
<th class="last bottom_border">Description</th> |
615 |
</tr> |
616 |
</thead> |
617 |
|
618 |
<tbody> |
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> |
620 |
</tbody> |
621 |
</table><h5>Returns:</h5><p class="returns"><p>comma separated list of names</p></p></div> |
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"><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"> → {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"> |
623 |
|
624 |
</dl> |
625 |
<h5>Parameters:</h5> |
626 |
|
627 |
<table class="params"> |
628 |
<thead> |
629 |
<tr> |
630 |
<th width="20"></th> |
631 |
<th width="12%" class="bottom_border name">Name</th> |
632 |
<th width="10%" class="bottom_border">Type</th> |
633 |
<th width="10%" class="bottom_border">Attributes</th> |
634 |
<th width="10%" class="bottom_border">Default</th> |
635 |
<th class="last bottom_border">Description</th> |
636 |
</tr> |
637 |
</thead> |
638 |
|
639 |
<tbody> |
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> |
641 |
</tbody> |
642 |
</table><h5>Returns:</h5><p class="returns"><p>iWidth width in pixels</p></p></div> |
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"><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"> |
644 |
|
645 |
</dl> |
646 |
<h5>Parameters:</h5> |
647 |
|
648 |
<table class="params"> |
649 |
<thead> |
650 |
<tr> |
651 |
<th width="20"></th> |
652 |
<th width="12%" class="bottom_border name">Name</th> |
653 |
<th width="10%" class="bottom_border">Type</th> |
654 |
<th width="10%" class="bottom_border">Attributes</th> |
655 |
<th width="10%" class="bottom_border">Default</th> |
656 |
<th class="last bottom_border">Description</th> |
657 |
</tr> |
658 |
</thead> |
659 |
|
660 |
<tbody> |
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> |
662 |
</tbody> |
663 |
</table></div> |
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"><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"> |
665 |
|
666 |
</dl> |
667 |
<h5>Parameters:</h5> |
668 |
|
669 |
<table class="params"> |
670 |
<thead> |
671 |
<tr> |
672 |
<th width="20"></th> |
673 |
<th width="12%" class="bottom_border name">Name</th> |
674 |
<th width="10%" class="bottom_border">Type</th> |
675 |
<th width="10%" class="bottom_border">Attributes</th> |
676 |
<th width="10%" class="bottom_border">Default</th> |
677 |
<th class="last bottom_border">Description</th> |
678 |
</tr> |
679 |
</thead> |
680 |
|
681 |
<tbody> |
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> |
683 |
</tbody> |
684 |
</table></div> |
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"><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"> → {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"> |
686 |
|
687 |
</dl> |
688 |
<h5>Parameters:</h5> |
689 |
|
690 |
<table class="params"> |
691 |
<thead> |
692 |
<tr> |
693 |
<th width="20"></th> |
694 |
<th width="12%" class="bottom_border name">Name</th> |
695 |
<th width="10%" class="bottom_border">Type</th> |
696 |
<th width="10%" class="bottom_border">Attributes</th> |
697 |
<th width="10%" class="bottom_border">Default</th> |
698 |
<th class="last bottom_border">Description</th> |
699 |
</tr> |
700 |
</thead> |
701 |
|
702 |
<tbody> |
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> |
704 |
</tbody> |
705 |
</table><h5>Returns:</h5><p class="returns"><p>search string</p></p></div> |
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"><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 |
707 |
the key!)</p><div class="collapse_details"><dl class="details"> |
708 |
|
709 |
</dl> |
710 |
<h5>Parameters:</h5> |
711 |
|
712 |
<table class="params"> |
713 |
<thead> |
714 |
<tr> |
715 |
<th width="20"></th> |
716 |
<th width="12%" class="bottom_border name">Name</th> |
717 |
<th width="10%" class="bottom_border">Type</th> |
718 |
<th width="10%" class="bottom_border">Attributes</th> |
719 |
<th width="10%" class="bottom_border">Default</th> |
720 |
<th class="last bottom_border">Description</th> |
721 |
</tr> |
722 |
</thead> |
723 |
|
724 |
<tbody> |
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> |
726 |
</tbody> |
727 |
</table></div> |
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"><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 |
729 |
create a layout grid (array) of rows x columns, which contains a reference |
730 |
to the cell that that point in the grid (regardless of col/rowspan), such that |
731 |
any column / row could be removed and the new grid constructed</p><div class="collapse_details"><dl class="details"> |
732 |
|
733 |
</dl> |
734 |
<h5>Parameters:</h5> |
735 |
|
736 |
<table class="params"> |
737 |
<thead> |
738 |
<tr> |
739 |
<th width="20"></th> |
740 |
<th width="12%" class="bottom_border name">Name</th> |
741 |
<th width="10%" class="bottom_border">Type</th> |
742 |
<th width="10%" class="bottom_border">Attributes</th> |
743 |
<th width="10%" class="bottom_border">Default</th> |
744 |
<th class="last bottom_border">Description</th> |
745 |
</tr> |
746 |
</thead> |
747 |
|
748 |
<tbody> |
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> |
750 |
</tbody> |
751 |
</table></div> |
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"><static> </span></span><span class="type-name"><a>_fnDetectType</a></span><span class="type-sig"><span class="signature">(sData)</span><span class="type-signature"> → {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"> |
753 |
|
754 |
</dl> |
755 |
<h5>Parameters:</h5> |
756 |
|
757 |
<table class="params"> |
758 |
<thead> |
759 |
<tr> |
760 |
<th width="20"></th> |
761 |
<th width="12%" class="bottom_border name">Name</th> |
762 |
<th width="10%" class="bottom_border">Type</th> |
763 |
<th width="10%" class="bottom_border">Attributes</th> |
764 |
<th width="10%" class="bottom_border">Default</th> |
765 |
<th class="last bottom_border">Description</th> |
766 |
</tr> |
767 |
</thead> |
768 |
|
769 |
<tbody> |
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> |
771 |
</tbody> |
772 |
</table><h5>Returns:</h5><p class="returns"><p>type (defaults to 'string' if no type can be detected)</p></p></div> |
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"><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"> |
774 |
|
775 |
</dl> |
776 |
<h5>Parameters:</h5> |
777 |
|
778 |
<table class="params"> |
779 |
<thead> |
780 |
<tr> |
781 |
<th width="20"></th> |
782 |
<th width="12%" class="bottom_border name">Name</th> |
783 |
<th width="10%" class="bottom_border">Type</th> |
784 |
<th width="10%" class="bottom_border">Attributes</th> |
785 |
<th width="10%" class="bottom_border">Default</th> |
786 |
<th class="last bottom_border">Description</th> |
787 |
</tr> |
788 |
</thead> |
789 |
|
790 |
<tbody> |
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> |
792 |
</tbody> |
793 |
</table></div> |
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"><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 |
795 |
methodology here is to use the layout array from _fnDetectHeader, modified for |
796 |
the instantaneous column visibility, to construct the new layout. The grid is |
797 |
traversed over cell at a time in a rows x columns grid fashion, although each |
798 |
cell insert can cover multiple elements in the grid - which is tracks using the |
799 |
aApplied array. Cell inserts in the grid will only occur where there isn't |
800 |
already a cell in that position.</p><div class="collapse_details"><dl class="details"> |
801 |
|
802 |
</dl> |
803 |
<h5>Parameters:</h5> |
804 |
|
805 |
<table class="params"> |
806 |
<thead> |
807 |
<tr> |
808 |
<th width="20"></th> |
809 |
<th width="12%" class="bottom_border name">Name</th> |
810 |
<th width="10%" class="bottom_border">Type</th> |
811 |
<th width="10%" class="bottom_border">Attributes</th> |
812 |
<th width="10%" class="bottom_border">Default</th> |
813 |
<th class="last bottom_border">Description</th> |
814 |
</tr> |
815 |
</thead> |
816 |
|
817 |
<tbody> |
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> |
819 |
</tbody> |
820 |
</table></div> |
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"><static> </span></span><span class="type-name"><a>_fnEscapeRegex</a></span><span class="type-sig"><span class="signature">(sVal)</span><span class="type-signature"> → {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"> |
822 |
|
823 |
</dl> |
824 |
<h5>Parameters:</h5> |
825 |
|
826 |
<table class="params"> |
827 |
<thead> |
828 |
<tr> |
829 |
<th width="20"></th> |
830 |
<th width="12%" class="bottom_border name">Name</th> |
831 |
<th width="10%" class="bottom_border">Type</th> |
832 |
<th width="10%" class="bottom_border">Attributes</th> |
833 |
<th width="10%" class="bottom_border">Default</th> |
834 |
<th class="last bottom_border">Description</th> |
835 |
</tr> |
836 |
</thead> |
837 |
|
838 |
<tbody> |
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> |
840 |
</tbody> |
841 |
</table><h5>Returns:</h5><p class="returns"><p>escaped string</p></p></div> |
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"><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"> → {object}</span></span></span></dt><dd class=" even"><p>Extend objects - very similar to jQuery.extend, but deep copy objects, and shallow |
843 |
copy arrays. The reason we need to do this, is that we don't want to deep copy array |
844 |
init values (such as aaSorting) since the dev wouldn't be able to override them, but |
845 |
we do want to deep copy arrays.</p><div class="collapse_details"><dl class="details"> |
846 |
|
847 |
</dl> |
848 |
<h5>Parameters:</h5> |
849 |
|
850 |
<table class="params"> |
851 |
<thead> |
852 |
<tr> |
853 |
<th width="20"></th> |
854 |
<th width="12%" class="bottom_border name">Name</th> |
855 |
<th width="10%" class="bottom_border">Type</th> |
856 |
<th width="10%" class="bottom_border">Attributes</th> |
857 |
<th width="10%" class="bottom_border">Default</th> |
858 |
<th class="last bottom_border">Description</th> |
859 |
</tr> |
860 |
</thead> |
861 |
|
862 |
<tbody> |
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> |
864 |
</tbody> |
865 |
</table><h5>Returns:</h5><p class="returns"><p>oOut Reference, just for convenience - oOut === the return.</p></p></div> |
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"><static> </span></span><span class="type-name"><a>_fnExternApiFunc</a></span><span class="type-sig"><span class="signature">(sFunc)</span><span class="type-signature"> → {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"> |
867 |
|
868 |
</dl> |
869 |
<h5>Parameters:</h5> |
870 |
|
871 |
<table class="params"> |
872 |
<thead> |
873 |
<tr> |
874 |
<th width="20"></th> |
875 |
<th width="12%" class="bottom_border name">Name</th> |
876 |
<th width="10%" class="bottom_border">Type</th> |
877 |
<th width="10%" class="bottom_border">Attributes</th> |
878 |
<th width="10%" class="bottom_border">Default</th> |
879 |
<th class="last bottom_border">Description</th> |
880 |
</tr> |
881 |
</thead> |
882 |
|
883 |
<tbody> |
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> |
885 |
</tbody> |
886 |
</table><h5>Returns:</h5><p class="returns"><p>wrapped function</p></p></div> |
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"><static> </span></span><span class="type-name"><a>_fnFeatureHtmlFilter</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></span></dt><dd class=" even"><p>Generate the node required for filtering text</p><div class="collapse_details"><dl class="details"> |
888 |
|
889 |
</dl> |
890 |
<h5>Parameters:</h5> |
891 |
|
892 |
<table class="params"> |
893 |
<thead> |
894 |
<tr> |
895 |
<th width="20"></th> |
896 |
<th width="12%" class="bottom_border name">Name</th> |
897 |
<th width="10%" class="bottom_border">Type</th> |
898 |
<th width="10%" class="bottom_border">Attributes</th> |
899 |
<th width="10%" class="bottom_border">Default</th> |
900 |
<th class="last bottom_border">Description</th> |
901 |
</tr> |
902 |
</thead> |
903 |
|
904 |
<tbody> |
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> |
906 |
</tbody> |
907 |
</table><h5>Returns:</h5><p class="returns"><p>Filter control element</p></p></div> |
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"><static> </span></span><span class="type-name"><a>_fnFeatureHtmlInfo</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {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"> |
909 |
|
910 |
</dl> |
911 |
<h5>Parameters:</h5> |
912 |
|
913 |
<table class="params"> |
914 |
<thead> |
915 |
<tr> |
916 |
<th width="20"></th> |
917 |
<th width="12%" class="bottom_border name">Name</th> |
918 |
<th width="10%" class="bottom_border">Type</th> |
919 |
<th width="10%" class="bottom_border">Attributes</th> |
920 |
<th width="10%" class="bottom_border">Default</th> |
921 |
<th class="last bottom_border">Description</th> |
922 |
</tr> |
923 |
</thead> |
924 |
|
925 |
<tbody> |
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> |
927 |
</tbody> |
928 |
</table><h5>Returns:</h5><p class="returns"><p>Information element</p></p></div> |
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"><static> </span></span><span class="type-name"><a>_fnFeatureHtmlLength</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {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"> |
930 |
|
931 |
</dl> |
932 |
<h5>Parameters:</h5> |
933 |
|
934 |
<table class="params"> |
935 |
<thead> |
936 |
<tr> |
937 |
<th width="20"></th> |
938 |
<th width="12%" class="bottom_border name">Name</th> |
939 |
<th width="10%" class="bottom_border">Type</th> |
940 |
<th width="10%" class="bottom_border">Attributes</th> |
941 |
<th width="10%" class="bottom_border">Default</th> |
942 |
<th class="last bottom_border">Description</th> |
943 |
</tr> |
944 |
</thead> |
945 |
|
946 |
<tbody> |
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> |
948 |
</tbody> |
949 |
</table><h5>Returns:</h5><p class="returns"><p>Display length feature node</p></p></div> |
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"><static> </span></span><span class="type-name"><a>_fnFeatureHtmlPaginate</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></span></dt><dd class=" odd"><p>Generate the node required for default pagination</p><div class="collapse_details"><dl class="details"> |
951 |
|
952 |
</dl> |
953 |
<h5>Parameters:</h5> |
954 |
|
955 |
<table class="params"> |
956 |
<thead> |
957 |
<tr> |
958 |
<th width="20"></th> |
959 |
<th width="12%" class="bottom_border name">Name</th> |
960 |
<th width="10%" class="bottom_border">Type</th> |
961 |
<th width="10%" class="bottom_border">Attributes</th> |
962 |
<th width="10%" class="bottom_border">Default</th> |
963 |
<th class="last bottom_border">Description</th> |
964 |
</tr> |
965 |
</thead> |
966 |
|
967 |
<tbody> |
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> |
969 |
</tbody> |
970 |
</table><h5>Returns:</h5><p class="returns"><p>Pagination feature node</p></p></div> |
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"><static> </span></span><span class="type-name"><a>_fnFeatureHtmlProcessing</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {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"> |
972 |
|
973 |
</dl> |
974 |
<h5>Parameters:</h5> |
975 |
|
976 |
<table class="params"> |
977 |
<thead> |
978 |
<tr> |
979 |
<th width="20"></th> |
980 |
<th width="12%" class="bottom_border name">Name</th> |
981 |
<th width="10%" class="bottom_border">Type</th> |
982 |
<th width="10%" class="bottom_border">Attributes</th> |
983 |
<th width="10%" class="bottom_border">Default</th> |
984 |
<th class="last bottom_border">Description</th> |
985 |
</tr> |
986 |
</thead> |
987 |
|
988 |
<tbody> |
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> |
990 |
</tbody> |
991 |
</table><h5>Returns:</h5><p class="returns"><p>Processing element</p></p></div> |
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"><static> </span></span><span class="type-name"><a>_fnFeatureHtmlTable</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {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"> |
993 |
|
994 |
</dl> |
995 |
<h5>Parameters:</h5> |
996 |
|
997 |
<table class="params"> |
998 |
<thead> |
999 |
<tr> |
1000 |
<th width="20"></th> |
1001 |
<th width="12%" class="bottom_border name">Name</th> |
1002 |
<th width="10%" class="bottom_border">Type</th> |
1003 |
<th width="10%" class="bottom_border">Attributes</th> |
1004 |
<th width="10%" class="bottom_border">Default</th> |
1005 |
<th class="last bottom_border">Description</th> |
1006 |
</tr> |
1007 |
</thead> |
1008 |
|
1009 |
<tbody> |
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> |
1011 |
</tbody> |
1012 |
</table><h5>Returns:</h5><p class="returns"><p>Node to add to the DOM</p></p></div> |
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"><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"> |
1014 |
|
1015 |
</dl> |
1016 |
<h5>Parameters:</h5> |
1017 |
|
1018 |
<table class="params"> |
1019 |
<thead> |
1020 |
<tr> |
1021 |
<th width="20"></th> |
1022 |
<th width="12%" class="bottom_border name">Name</th> |
1023 |
<th width="10%" class="bottom_border">Type</th> |
1024 |
<th width="10%" class="bottom_border">Attributes</th> |
1025 |
<th width="10%" class="bottom_border">Default</th> |
1026 |
<th class="last bottom_border">Description</th> |
1027 |
</tr> |
1028 |
</thead> |
1029 |
|
1030 |
<tbody> |
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> |
1032 |
</tbody> |
1033 |
</table></div> |
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"><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"> |
1035 |
|
1036 |
</dl> |
1037 |
<h5>Parameters:</h5> |
1038 |
|
1039 |
<table class="params"> |
1040 |
<thead> |
1041 |
<tr> |
1042 |
<th width="20"></th> |
1043 |
<th width="12%" class="bottom_border name">Name</th> |
1044 |
<th width="10%" class="bottom_border">Type</th> |
1045 |
<th width="10%" class="bottom_border">Attributes</th> |
1046 |
<th width="10%" class="bottom_border">Default</th> |
1047 |
<th class="last bottom_border">Description</th> |
1048 |
</tr> |
1049 |
</thead> |
1050 |
|
1051 |
<tbody> |
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> |
1053 |
</tbody> |
1054 |
</table></div> |
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"><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"> |
1056 |
|
1057 |
</dl> |
1058 |
<h5>Parameters:</h5> |
1059 |
|
1060 |
<table class="params"> |
1061 |
<thead> |
1062 |
<tr> |
1063 |
<th width="20"></th> |
1064 |
<th width="12%" class="bottom_border name">Name</th> |
1065 |
<th width="10%" class="bottom_border">Type</th> |
1066 |
<th width="10%" class="bottom_border">Attributes</th> |
1067 |
<th width="10%" class="bottom_border">Default</th> |
1068 |
<th class="last bottom_border">Description</th> |
1069 |
</tr> |
1070 |
</thead> |
1071 |
|
1072 |
<tbody> |
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> |
1074 |
</tbody> |
1075 |
</table></div> |
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"><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"> → {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"> |
1077 |
|
1078 |
</dl> |
1079 |
<h5>Parameters:</h5> |
1080 |
|
1081 |
<table class="params"> |
1082 |
<thead> |
1083 |
<tr> |
1084 |
<th width="20"></th> |
1085 |
<th width="12%" class="bottom_border name">Name</th> |
1086 |
<th width="10%" class="bottom_border">Type</th> |
1087 |
<th width="10%" class="bottom_border">Attributes</th> |
1088 |
<th width="10%" class="bottom_border">Default</th> |
1089 |
<th class="last bottom_border">Description</th> |
1090 |
</tr> |
1091 |
</thead> |
1092 |
|
1093 |
<tbody> |
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> |
1095 |
</tbody> |
1096 |
</table><h5>Returns:</h5><p class="returns"><p>constructed object</p></p></div> |
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"><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"> |
1098 |
|
1099 |
</dl> |
1100 |
<h5>Parameters:</h5> |
1101 |
|
1102 |
<table class="params"> |
1103 |
<thead> |
1104 |
<tr> |
1105 |
<th width="20"></th> |
1106 |
<th width="12%" class="bottom_border name">Name</th> |
1107 |
<th width="10%" class="bottom_border">Type</th> |
1108 |
<th width="10%" class="bottom_border">Attributes</th> |
1109 |
<th width="10%" class="bottom_border">Default</th> |
1110 |
<th class="last bottom_border">Description</th> |
1111 |
</tr> |
1112 |
</thead> |
1113 |
|
1114 |
<tbody> |
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> |
1116 |
</tbody> |
1117 |
</table></div> |
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"><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"> |
1119 |
|
1120 |
</dl> |
1121 |
<h5>Parameters:</h5> |
1122 |
|
1123 |
<table class="params"> |
1124 |
<thead> |
1125 |
<tr> |
1126 |
<th width="20"></th> |
1127 |
<th width="12%" class="bottom_border name">Name</th> |
1128 |
<th width="10%" class="bottom_border">Type</th> |
1129 |
<th width="10%" class="bottom_border">Attributes</th> |
1130 |
<th width="10%" class="bottom_border">Default</th> |
1131 |
<th class="last bottom_border">Description</th> |
1132 |
</tr> |
1133 |
</thead> |
1134 |
|
1135 |
<tbody> |
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> |
1137 |
</tbody> |
1138 |
</table></div> |
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"><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"> → {*}</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"> |
1140 |
|
1141 |
</dl> |
1142 |
<h5>Parameters:</h5> |
1143 |
|
1144 |
<table class="params"> |
1145 |
<thead> |
1146 |
<tr> |
1147 |
<th width="20"></th> |
1148 |
<th width="12%" class="bottom_border name">Name</th> |
1149 |
<th width="10%" class="bottom_border">Type</th> |
1150 |
<th width="10%" class="bottom_border">Attributes</th> |
1151 |
<th width="10%" class="bottom_border">Default</th> |
1152 |
<th class="last bottom_border">Description</th> |
1153 |
</tr> |
1154 |
</thead> |
1155 |
|
1156 |
<tbody> |
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> |
1158 |
</tbody> |
1159 |
</table><h5>Returns:</h5><p class="returns"><p>Cell data</p></p></div> |
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"><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"> → {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"> |
1161 |
|
1162 |
</dl> |
1163 |
<h5>Parameters:</h5> |
1164 |
|
1165 |
<table class="params"> |
1166 |
<thead> |
1167 |
<tr> |
1168 |
<th width="20"></th> |
1169 |
<th width="12%" class="bottom_border name">Name</th> |
1170 |
<th width="10%" class="bottom_border">Type</th> |
1171 |
<th width="10%" class="bottom_border">Attributes</th> |
1172 |
<th width="10%" class="bottom_border">Default</th> |
1173 |
<th class="last bottom_border">Description</th> |
1174 |
</tr> |
1175 |
</thead> |
1176 |
|
1177 |
<tbody> |
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 |
1179 |
bVisible or bSearchable</p></td></tr> |
1180 |
</tbody> |
1181 |
</table><h5>Returns:</h5><p class="returns"><p>Array of indexes with matched properties</p></p></div> |
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"><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"> |
1183 |
|
1184 |
</dl> |
1185 |
<h5>Parameters:</h5> |
1186 |
|
1187 |
<table class="params"> |
1188 |
<thead> |
1189 |
<tr> |
1190 |
<th width="20"></th> |
1191 |
<th width="12%" class="bottom_border name">Name</th> |
1192 |
<th width="10%" class="bottom_border">Type</th> |
1193 |
<th width="10%" class="bottom_border">Attributes</th> |
1194 |
<th width="10%" class="bottom_border">Default</th> |
1195 |
<th class="last bottom_border">Description</th> |
1196 |
</tr> |
1197 |
</thead> |
1198 |
|
1199 |
<tbody> |
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> |
1201 |
</tbody> |
1202 |
</table><h5>Returns:</h5><p class="returns"><p>array {array} aData Master data array</p></p></div> |
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"><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"> → {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"> |
1204 |
|
1205 |
</dl> |
1206 |
<h5>Parameters:</h5> |
1207 |
|
1208 |
<table class="params"> |
1209 |
<thead> |
1210 |
<tr> |
1211 |
<th width="20"></th> |
1212 |
<th width="12%" class="bottom_border name">Name</th> |
1213 |
<th width="10%" class="bottom_border">Type</th> |
1214 |
<th width="10%" class="bottom_border">Attributes</th> |
1215 |
<th width="10%" class="bottom_border">Default</th> |
1216 |
<th class="last bottom_border">Description</th> |
1217 |
</tr> |
1218 |
</thead> |
1219 |
|
1220 |
<tbody> |
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> |
1222 |
</tbody> |
1223 |
</table><h5>Returns:</h5><p class="returns"><p>max string length for each column</p></p></div> |
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"><static> </span></span><span class="type-name"><a>_fnGetObjectDataFn</a></span><span class="type-sig"><span class="signature">(mSource)</span><span class="type-signature"> → {function}</span></span></span></dt><dd class=" even"><p>Return a function that can be used to get data from a source object, taking |
1225 |
into account the ability to use nested objects as a source</p><div class="collapse_details"><dl class="details"> |
1226 |
|
1227 |
</dl> |
1228 |
<h5>Parameters:</h5> |
1229 |
|
1230 |
<table class="params"> |
1231 |
<thead> |
1232 |
<tr> |
1233 |
<th width="20"></th> |
1234 |
<th width="12%" class="bottom_border name">Name</th> |
1235 |
<th width="10%" class="bottom_border">Type</th> |
1236 |
<th width="10%" class="bottom_border">Attributes</th> |
1237 |
<th width="10%" class="bottom_border">Default</th> |
1238 |
<th class="last bottom_border">Description</th> |
1239 |
</tr> |
1240 |
</thead> |
1241 |
|
1242 |
<tbody> |
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> |
1244 |
</tbody> |
1245 |
</table><h5>Returns:</h5><p class="returns"><p>Data get function</p></p></div> |
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"><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"> → {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"> |
1247 |
|
1248 |
</dl> |
1249 |
<h5>Parameters:</h5> |
1250 |
|
1251 |
<table class="params"> |
1252 |
<thead> |
1253 |
<tr> |
1254 |
<th width="20"></th> |
1255 |
<th width="12%" class="bottom_border name">Name</th> |
1256 |
<th width="10%" class="bottom_border">Type</th> |
1257 |
<th width="10%" class="bottom_border">Attributes</th> |
1258 |
<th width="10%" class="bottom_border">Default</th> |
1259 |
<th class="last bottom_border">Description</th> |
1260 |
</tr> |
1261 |
</thead> |
1262 |
|
1263 |
<tbody> |
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> |
1265 |
</tbody> |
1266 |
</table><h5>Returns:</h5><p class="returns"><p>Data array</p></p></div> |
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"><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"> → {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"> |
1268 |
|
1269 |
</dl> |
1270 |
<h5>Parameters:</h5> |
1271 |
|
1272 |
<table class="params"> |
1273 |
<thead> |
1274 |
<tr> |
1275 |
<th width="20"></th> |
1276 |
<th width="12%" class="bottom_border name">Name</th> |
1277 |
<th width="10%" class="bottom_border">Type</th> |
1278 |
<th width="10%" class="bottom_border">Attributes</th> |
1279 |
<th width="10%" class="bottom_border">Default</th> |
1280 |
<th class="last bottom_border">Description</th> |
1281 |
</tr> |
1282 |
</thead> |
1283 |
|
1284 |
<tbody> |
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 |
1286 |
if not given then the return array will contain all nodes for the table</p></td></tr> |
1287 |
</tbody> |
1288 |
</table><h5>Returns:</h5><p class="returns"><p>TD array</p></p></div> |
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"><static> </span></span><span class="type-name"><a>_fnGetTrNodes</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {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"> |
1290 |
|
1291 |
</dl> |
1292 |
<h5>Parameters:</h5> |
1293 |
|
1294 |
<table class="params"> |
1295 |
<thead> |
1296 |
<tr> |
1297 |
<th width="20"></th> |
1298 |
<th width="12%" class="bottom_border name">Name</th> |
1299 |
<th width="10%" class="bottom_border">Type</th> |
1300 |
<th width="10%" class="bottom_border">Attributes</th> |
1301 |
<th width="10%" class="bottom_border">Default</th> |
1302 |
<th class="last bottom_border">Description</th> |
1303 |
</tr> |
1304 |
</thead> |
1305 |
|
1306 |
<tbody> |
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> |
1308 |
</tbody> |
1309 |
</table><h5>Returns:</h5><p class="returns"><p>TR array</p></p></div> |
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"><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"> |
1311 |
|
1312 |
</dl> |
1313 |
<h5>Parameters:</h5> |
1314 |
|
1315 |
<table class="params"> |
1316 |
<thead> |
1317 |
<tr> |
1318 |
<th width="20"></th> |
1319 |
<th width="12%" class="bottom_border name">Name</th> |
1320 |
<th width="10%" class="bottom_border">Type</th> |
1321 |
<th width="10%" class="bottom_border">Attributes</th> |
1322 |
<th width="10%" class="bottom_border">Default</th> |
1323 |
<th class="last bottom_border">Description</th> |
1324 |
</tr> |
1325 |
</thead> |
1326 |
|
1327 |
<tbody> |
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> |
1329 |
</tbody> |
1330 |
</table><h5>Returns:</h5><p class="returns"><p>array {node} aReturn list of unique th's</p></p></div> |
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"><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"> → {node}</span></span></span></dt><dd class=" odd"><p>Get the widest node</p><div class="collapse_details"><dl class="details"> |
1332 |
|
1333 |
</dl> |
1334 |
<h5>Parameters:</h5> |
1335 |
|
1336 |
<table class="params"> |
1337 |
<thead> |
1338 |
<tr> |
1339 |
<th width="20"></th> |
1340 |
<th width="12%" class="bottom_border name">Name</th> |
1341 |
<th width="10%" class="bottom_border">Type</th> |
1342 |
<th width="10%" class="bottom_border">Attributes</th> |
1343 |
<th width="10%" class="bottom_border">Default</th> |
1344 |
<th class="last bottom_border">Description</th> |
1345 |
</tr> |
1346 |
</thead> |
1347 |
|
1348 |
<tbody> |
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> |
1350 |
</tbody> |
1351 |
</table><h5>Returns:</h5><p class="returns"><p>widest table node</p></p></div> |
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"><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"> |
1353 |
|
1354 |
</dl> |
1355 |
<h5>Parameters:</h5> |
1356 |
|
1357 |
<table class="params"> |
1358 |
<thead> |
1359 |
<tr> |
1360 |
<th width="20"></th> |
1361 |
<th width="12%" class="bottom_border name">Name</th> |
1362 |
<th width="10%" class="bottom_border">Type</th> |
1363 |
<th width="10%" class="bottom_border">Attributes</th> |
1364 |
<th width="10%" class="bottom_border">Default</th> |
1365 |
<th class="last bottom_border">Description</th> |
1366 |
</tr> |
1367 |
</thead> |
1368 |
|
1369 |
<tbody> |
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 |
1371 |
with client-side processing (optional)</p></td></tr> |
1372 |
</tbody> |
1373 |
</table></div> |
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"><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"> |
1375 |
|
1376 |
</dl> |
1377 |
<h5>Parameters:</h5> |
1378 |
|
1379 |
<table class="params"> |
1380 |
<thead> |
1381 |
<tr> |
1382 |
<th width="20"></th> |
1383 |
<th width="12%" class="bottom_border name">Name</th> |
1384 |
<th width="10%" class="bottom_border">Type</th> |
1385 |
<th width="10%" class="bottom_border">Attributes</th> |
1386 |
<th width="10%" class="bottom_border">Default</th> |
1387 |
<th class="last bottom_border">Description</th> |
1388 |
</tr> |
1389 |
</thead> |
1390 |
|
1391 |
<tbody> |
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> |
1393 |
</tbody> |
1394 |
</table></div> |
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"><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 |
1396 |
need to duplicate the values over, in order to provide backwards compatibility |
1397 |
with older language files.</p><div class="collapse_details"><dl class="details"> |
1398 |
|
1399 |
</dl> |
1400 |
<h5>Parameters:</h5> |
1401 |
|
1402 |
<table class="params"> |
1403 |
<thead> |
1404 |
<tr> |
1405 |
<th width="20"></th> |
1406 |
<th width="12%" class="bottom_border name">Name</th> |
1407 |
<th width="10%" class="bottom_border">Type</th> |
1408 |
<th width="10%" class="bottom_border">Attributes</th> |
1409 |
<th width="10%" class="bottom_border">Default</th> |
1410 |
<th class="last bottom_border">Description</th> |
1411 |
</tr> |
1412 |
</thead> |
1413 |
|
1414 |
<tbody> |
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> |
1416 |
</tbody> |
1417 |
</table></div> |
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"><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"> |
1419 |
|
1420 |
</dl> |
1421 |
<h5>Parameters:</h5> |
1422 |
|
1423 |
<table class="params"> |
1424 |
<thead> |
1425 |
<tr> |
1426 |
<th width="20"></th> |
1427 |
<th width="12%" class="bottom_border name">Name</th> |
1428 |
<th width="10%" class="bottom_border">Type</th> |
1429 |
<th width="10%" class="bottom_border">Attributes</th> |
1430 |
<th width="10%" class="bottom_border">Default</th> |
1431 |
<th class="last bottom_border">Description</th> |
1432 |
</tr> |
1433 |
</thead> |
1434 |
|
1435 |
<tbody> |
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> |
1437 |
</tbody> |
1438 |
</table></div> |
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"><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"> |
1440 |
|
1441 |
</dl> |
1442 |
<h5>Parameters:</h5> |
1443 |
|
1444 |
<table class="params"> |
1445 |
<thead> |
1446 |
<tr> |
1447 |
<th width="20"></th> |
1448 |
<th width="12%" class="bottom_border name">Name</th> |
1449 |
<th width="10%" class="bottom_border">Type</th> |
1450 |
<th width="10%" class="bottom_border">Attributes</th> |
1451 |
<th width="10%" class="bottom_border">Default</th> |
1452 |
<th class="last bottom_border">Description</th> |
1453 |
</tr> |
1454 |
</thead> |
1455 |
|
1456 |
<tbody> |
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> |
1458 |
</tbody> |
1459 |
</table></div> |
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"><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"> |
1461 |
|
1462 |
</dl> |
1463 |
<h5>Parameters:</h5> |
1464 |
|
1465 |
<table class="params"> |
1466 |
<thead> |
1467 |
<tr> |
1468 |
<th width="20"></th> |
1469 |
<th width="12%" class="bottom_border name">Name</th> |
1470 |
<th width="10%" class="bottom_border">Type</th> |
1471 |
<th width="10%" class="bottom_border">Attributes</th> |
1472 |
<th width="10%" class="bottom_border">Default</th> |
1473 |
<th class="last bottom_border">Description</th> |
1474 |
</tr> |
1475 |
</thead> |
1476 |
|
1477 |
<tbody> |
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> |
1479 |
</tbody> |
1480 |
</table></div> |
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"><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"> → {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"> |
1482 |
|
1483 |
</dl> |
1484 |
<h5>Parameters:</h5> |
1485 |
|
1486 |
<table class="params"> |
1487 |
<thead> |
1488 |
<tr> |
1489 |
<th width="20"></th> |
1490 |
<th width="12%" class="bottom_border name">Name</th> |
1491 |
<th width="10%" class="bottom_border">Type</th> |
1492 |
<th width="10%" class="bottom_border">Attributes</th> |
1493 |
<th width="10%" class="bottom_border">Default</th> |
1494 |
<th class="last bottom_border">Description</th> |
1495 |
</tr> |
1496 |
</thead> |
1497 |
|
1498 |
<tbody> |
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> |
1500 |
</tbody> |
1501 |
</table><h5>Returns:</h5><p class="returns"><p>index if the node is found, -1 if not</p></p></div> |
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"><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"> → {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"> |
1503 |
|
1504 |
</dl> |
1505 |
<h5>Parameters:</h5> |
1506 |
|
1507 |
<table class="params"> |
1508 |
<thead> |
1509 |
<tr> |
1510 |
<th width="20"></th> |
1511 |
<th width="12%" class="bottom_border name">Name</th> |
1512 |
<th width="10%" class="bottom_border">Type</th> |
1513 |
<th width="10%" class="bottom_border">Attributes</th> |
1514 |
<th width="10%" class="bottom_border">Default</th> |
1515 |
<th class="last bottom_border">Description</th> |
1516 |
</tr> |
1517 |
</thead> |
1518 |
|
1519 |
<tbody> |
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> |
1521 |
</tbody> |
1522 |
</table><h5>Returns:</h5><p class="returns"><p>index if the node is found, null if not</p></p></div> |
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"><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"> → {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"> |
1524 |
|
1525 |
</dl> |
1526 |
<h5>Parameters:</h5> |
1527 |
|
1528 |
<table class="params"> |
1529 |
<thead> |
1530 |
<tr> |
1531 |
<th width="20"></th> |
1532 |
<th width="12%" class="bottom_border name">Name</th> |
1533 |
<th width="10%" class="bottom_border">Type</th> |
1534 |
<th width="10%" class="bottom_border">Attributes</th> |
1535 |
<th width="10%" class="bottom_border">Default</th> |
1536 |
<th class="last bottom_border">Description</th> |
1537 |
</tr> |
1538 |
</thead> |
1539 |
|
1540 |
<tbody> |
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" |
1542 |
or page number to jump to (integer)</p></td></tr> |
1543 |
</tbody> |
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> |
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"><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"> |
1546 |
|
1547 |
</dl> |
1548 |
<h5>Parameters:</h5> |
1549 |
|
1550 |
<table class="params"> |
1551 |
<thead> |
1552 |
<tr> |
1553 |
<th width="20"></th> |
1554 |
<th width="12%" class="bottom_border name">Name</th> |
1555 |
<th width="10%" class="bottom_border">Type</th> |
1556 |
<th width="10%" class="bottom_border">Attributes</th> |
1557 |
<th width="10%" class="bottom_border">Default</th> |
1558 |
<th class="last bottom_border">Description</th> |
1559 |
</tr> |
1560 |
</thead> |
1561 |
|
1562 |
<tbody> |
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> |
1564 |
</tbody> |
1565 |
</table></div> |
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"><static> </span></span><span class="type-name"><a>_fnReadCookie</a></span><span class="type-sig"><span class="signature">(sName)</span><span class="type-signature"> → {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"> |
1567 |
|
1568 |
</dl> |
1569 |
<h5>Parameters:</h5> |
1570 |
|
1571 |
<table class="params"> |
1572 |
<thead> |
1573 |
<tr> |
1574 |
<th width="20"></th> |
1575 |
<th width="12%" class="bottom_border name">Name</th> |
1576 |
<th width="10%" class="bottom_border">Type</th> |
1577 |
<th width="10%" class="bottom_border">Attributes</th> |
1578 |
<th width="10%" class="bottom_border">Default</th> |
1579 |
<th class="last bottom_border">Description</th> |
1580 |
</tr> |
1581 |
</thead> |
1582 |
|
1583 |
<tbody> |
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> |
1585 |
</tbody> |
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> |
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"><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"> |
1588 |
|
1589 |
</dl> |
1590 |
<h5>Parameters:</h5> |
1591 |
|
1592 |
<table class="params"> |
1593 |
<thead> |
1594 |
<tr> |
1595 |
<th width="20"></th> |
1596 |
<th width="12%" class="bottom_border name">Name</th> |
1597 |
<th width="10%" class="bottom_border">Type</th> |
1598 |
<th width="10%" class="bottom_border">Attributes</th> |
1599 |
<th width="10%" class="bottom_border">Default</th> |
1600 |
<th class="last bottom_border">Description</th> |
1601 |
</tr> |
1602 |
</thead> |
1603 |
|
1604 |
<tbody> |
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> |
1606 |
</tbody> |
1607 |
</table></div> |
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"><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"> → {*}</span></span></span></dt><dd class=" even"><p>Call the developer defined fnRender function for a given cell (row/column) with |
1609 |
the required parameters and return the result.</p><div class="collapse_details"><dl class="details"> |
1610 |
|
1611 |
</dl> |
1612 |
<h5>Parameters:</h5> |
1613 |
|
1614 |
<table class="params"> |
1615 |
<thead> |
1616 |
<tr> |
1617 |
<th width="20"></th> |
1618 |
<th width="12%" class="bottom_border name">Name</th> |
1619 |
<th width="10%" class="bottom_border">Type</th> |
1620 |
<th width="10%" class="bottom_border">Attributes</th> |
1621 |
<th width="10%" class="bottom_border">Default</th> |
1622 |
<th class="last bottom_border">Description</th> |
1623 |
</tr> |
1624 |
</thead> |
1625 |
|
1626 |
<tbody> |
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> |
1628 |
</tbody> |
1629 |
</table><h5>Returns:</h5><p class="returns"><p>Return of the developer's fnRender function</p></p></div> |
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"><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"> |
1631 |
|
1632 |
</dl> |
1633 |
<h5>Parameters:</h5> |
1634 |
|
1635 |
<table class="params"> |
1636 |
<thead> |
1637 |
<tr> |
1638 |
<th width="20"></th> |
1639 |
<th width="12%" class="bottom_border name">Name</th> |
1640 |
<th width="10%" class="bottom_border">Type</th> |
1641 |
<th width="10%" class="bottom_border">Attributes</th> |
1642 |
<th width="10%" class="bottom_border">Default</th> |
1643 |
<th class="last bottom_border">Description</th> |
1644 |
</tr> |
1645 |
</thead> |
1646 |
|
1647 |
<tbody> |
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> |
1649 |
</tbody> |
1650 |
</table><h5>Returns:</h5><p class="returns"><p>array {int} aiReturn index list for reordering</p></p></div> |
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"><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"> |
1652 |
|
1653 |
</dl> |
1654 |
<h5>Parameters:</h5> |
1655 |
|
1656 |
<table class="params"> |
1657 |
<thead> |
1658 |
<tr> |
1659 |
<th width="20"></th> |
1660 |
<th width="12%" class="bottom_border name">Name</th> |
1661 |
<th width="10%" class="bottom_border">Type</th> |
1662 |
<th width="10%" class="bottom_border">Attributes</th> |
1663 |
<th width="10%" class="bottom_border">Default</th> |
1664 |
<th class="last bottom_border">Description</th> |
1665 |
</tr> |
1666 |
</thead> |
1667 |
|
1668 |
<tbody> |
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> |
1670 |
</tbody> |
1671 |
</table></div> |
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"><static> </span></span><span class="type-name"><a>_fnScrollBarWidth</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"> → {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"> |
1673 |
|
1674 |
</dl> |
1675 |
<h5>Returns:</h5><p class="returns"><p>width in pixels</p></p></div> |
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"><static> </span></span><span class="type-name"><a>_fnScrollDraw</a></span><span class="type-sig"><span class="signature">(o)</span><span class="type-signature"> → {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 |
1677 |
basically the idea to: |
1678 |
1. Re-create the table inside the scrolling div |
1679 |
2. Take live measurements from the DOM |
1680 |
3. Apply the measurements |
1681 |
4. Clean up</p><div class="collapse_details"><dl class="details"> |
1682 |
|
1683 |
</dl> |
1684 |
<h5>Parameters:</h5> |
1685 |
|
1686 |
<table class="params"> |
1687 |
<thead> |
1688 |
<tr> |
1689 |
<th width="20"></th> |
1690 |
<th width="12%" class="bottom_border name">Name</th> |
1691 |
<th width="10%" class="bottom_border">Type</th> |
1692 |
<th width="10%" class="bottom_border">Attributes</th> |
1693 |
<th width="10%" class="bottom_border">Default</th> |
1694 |
<th class="last bottom_border">Description</th> |
1695 |
</tr> |
1696 |
</thead> |
1697 |
|
1698 |
<tbody> |
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> |
1700 |
</tbody> |
1701 |
</table><h5>Returns:</h5><p class="returns"><p>Node to add to the DOM</p></p></div> |
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"><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"> |
1703 |
|
1704 |
</dl> |
1705 |
<h5>Parameters:</h5> |
1706 |
|
1707 |
<table class="params"> |
1708 |
<thead> |
1709 |
<tr> |
1710 |
<th width="20"></th> |
1711 |
<th width="12%" class="bottom_border name">Name</th> |
1712 |
<th width="10%" class="bottom_border">Type</th> |
1713 |
<th width="10%" class="bottom_border">Attributes</th> |
1714 |
<th width="10%" class="bottom_border">Default</th> |
1715 |
<th class="last bottom_border">Description</th> |
1716 |
</tr> |
1717 |
</thead> |
1718 |
|
1719 |
<tbody> |
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> |
1721 |
</tbody> |
1722 |
</table></div> |
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"><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"> |
1724 |
|
1725 |
</dl> |
1726 |
<h5>Parameters:</h5> |
1727 |
|
1728 |
<table class="params"> |
1729 |
<thead> |
1730 |
<tr> |
1731 |
<th width="20"></th> |
1732 |
<th width="12%" class="bottom_border name">Name</th> |
1733 |
<th width="10%" class="bottom_border">Type</th> |
1734 |
<th width="10%" class="bottom_border">Attributes</th> |
1735 |
<th width="10%" class="bottom_border">Default</th> |
1736 |
<th class="last bottom_border">Description</th> |
1737 |
</tr> |
1738 |
</thead> |
1739 |
|
1740 |
<tbody> |
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> |
1742 |
</tbody> |
1743 |
</table></div> |
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"><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"> |
1745 |
|
1746 |
</dl> |
1747 |
<h5>Parameters:</h5> |
1748 |
|
1749 |
<table class="params"> |
1750 |
<thead> |
1751 |
<tr> |
1752 |
<th width="20"></th> |
1753 |
<th width="12%" class="bottom_border name">Name</th> |
1754 |
<th width="10%" class="bottom_border">Type</th> |
1755 |
<th width="10%" class="bottom_border">Attributes</th> |
1756 |
<th width="10%" class="bottom_border">Default</th> |
1757 |
<th class="last bottom_border">Description</th> |
1758 |
</tr> |
1759 |
</thead> |
1760 |
|
1761 |
<tbody> |
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> |
1763 |
</tbody> |
1764 |
</table></div> |
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"><static> </span></span><span class="type-name"><a>_fnSetObjectDataFn</a></span><span class="type-sig"><span class="signature">(mSource)</span><span class="type-signature"> → {function}</span></span></span></dt><dd class=" even"><p>Return a function that can be used to set data from a source object, taking |
1766 |
into account the ability to use nested objects as a source</p><div class="collapse_details"><dl class="details"> |
1767 |
|
1768 |
</dl> |
1769 |
<h5>Parameters:</h5> |
1770 |
|
1771 |
<table class="params"> |
1772 |
<thead> |
1773 |
<tr> |
1774 |
<th width="20"></th> |
1775 |
<th width="12%" class="bottom_border name">Name</th> |
1776 |
<th width="10%" class="bottom_border">Type</th> |
1777 |
<th width="10%" class="bottom_border">Attributes</th> |
1778 |
<th width="10%" class="bottom_border">Default</th> |
1779 |
<th class="last bottom_border">Description</th> |
1780 |
</tr> |
1781 |
</thead> |
1782 |
|
1783 |
<tbody> |
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> |
1785 |
</tbody> |
1786 |
</table><h5>Returns:</h5><p class="returns"><p>Data set function</p></p></div> |
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"><static> </span></span><span class="type-name"><a>_fnSettingsFromNode</a></span><span class="type-sig"><span class="signature">(nTable)</span><span class="type-signature"> → {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"> |
1788 |
|
1789 |
</dl> |
1790 |
<h5>Parameters:</h5> |
1791 |
|
1792 |
<table class="params"> |
1793 |
<thead> |
1794 |
<tr> |
1795 |
<th width="20"></th> |
1796 |
<th width="12%" class="bottom_border name">Name</th> |
1797 |
<th width="10%" class="bottom_border">Type</th> |
1798 |
<th width="10%" class="bottom_border">Attributes</th> |
1799 |
<th width="10%" class="bottom_border">Default</th> |
1800 |
<th class="last bottom_border">Description</th> |
1801 |
</tr> |
1802 |
</thead> |
1803 |
|
1804 |
<tbody> |
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> |
1806 |
</tbody> |
1807 |
</table><h5>Returns:</h5><p class="returns"><p>Settings object - or null if not found</p></p></div> |
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"><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"> |
1809 |
|
1810 |
</dl> |
1811 |
<h5>Parameters:</h5> |
1812 |
|
1813 |
<table class="params"> |
1814 |
<thead> |
1815 |
<tr> |
1816 |
<th width="20"></th> |
1817 |
<th width="12%" class="bottom_border name">Name</th> |
1818 |
<th width="10%" class="bottom_border">Type</th> |
1819 |
<th width="10%" class="bottom_border">Attributes</th> |
1820 |
<th width="10%" class="bottom_border">Default</th> |
1821 |
<th class="last bottom_border">Description</th> |
1822 |
</tr> |
1823 |
</thead> |
1824 |
|
1825 |
<tbody> |
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> |
1827 |
</tbody> |
1828 |
</table></div> |
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"><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"> |
1830 |
|
1831 |
</dl> |
1832 |
<h5>Parameters:</h5> |
1833 |
|
1834 |
<table class="params"> |
1835 |
<thead> |
1836 |
<tr> |
1837 |
<th width="20"></th> |
1838 |
<th width="12%" class="bottom_border name">Name</th> |
1839 |
<th width="10%" class="bottom_border">Type</th> |
1840 |
<th width="10%" class="bottom_border">Attributes</th> |
1841 |
<th width="10%" class="bottom_border">Default</th> |
1842 |
<th class="last bottom_border">Description</th> |
1843 |
</tr> |
1844 |
</thead> |
1845 |
|
1846 |
<tbody> |
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> |
1848 |
</tbody> |
1849 |
</table></div> |
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"><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 |
1851 |
when bSort and bSortClasses are false</p><div class="collapse_details"><dl class="details"> |
1852 |
|
1853 |
</dl> |
1854 |
<h5>Parameters:</h5> |
1855 |
|
1856 |
<table class="params"> |
1857 |
<thead> |
1858 |
<tr> |
1859 |
<th width="20"></th> |
1860 |
<th width="12%" class="bottom_border name">Name</th> |
1861 |
<th width="10%" class="bottom_border">Type</th> |
1862 |
<th width="10%" class="bottom_border">Attributes</th> |
1863 |
<th width="10%" class="bottom_border">Default</th> |
1864 |
<th class="last bottom_border">Description</th> |
1865 |
</tr> |
1866 |
</thead> |
1867 |
|
1868 |
<tbody> |
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> |
1870 |
</tbody> |
1871 |
</table></div> |
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"><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"> → {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"> |
1873 |
|
1874 |
</dl> |
1875 |
<h5>Parameters:</h5> |
1876 |
|
1877 |
<table class="params"> |
1878 |
<thead> |
1879 |
<tr> |
1880 |
<th width="20"></th> |
1881 |
<th width="12%" class="bottom_border name">Name</th> |
1882 |
<th width="10%" class="bottom_border">Type</th> |
1883 |
<th width="10%" class="bottom_border">Attributes</th> |
1884 |
<th width="10%" class="bottom_border">Default</th> |
1885 |
<th class="last bottom_border">Description</th> |
1886 |
</tr> |
1887 |
</thead> |
1888 |
|
1889 |
<tbody> |
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> |
1891 |
</tbody> |
1892 |
</table><h5>Returns:</h5><p class="returns"><p>0 if match, 1 if length is different, 2 if no match</p></p></div> |
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"><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"> |
1894 |
|
1895 |
</dl> |
1896 |
<h5>Parameters:</h5> |
1897 |
|
1898 |
<table class="params"> |
1899 |
<thead> |
1900 |
<tr> |
1901 |
<th width="20"></th> |
1902 |
<th width="12%" class="bottom_border name">Name</th> |
1903 |
<th width="10%" class="bottom_border">Type</th> |
1904 |
<th width="10%" class="bottom_border">Attributes</th> |
1905 |
<th width="10%" class="bottom_border">Default</th> |
1906 |
<th class="last bottom_border">Description</th> |
1907 |
</tr> |
1908 |
</thead> |
1909 |
|
1910 |
<tbody> |
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> |
1912 |
</tbody> |
1913 |
</table></div> |
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"><static> </span></span><span class="type-name"><a>_fnVisbleColumns</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {int}</span></span></span></dt><dd class=" odd"><p>Get the number of visible columns</p><div class="collapse_details"><dl class="details"> |
1915 |
|
1916 |
</dl> |
1917 |
<h5>Parameters:</h5> |
1918 |
|
1919 |
<table class="params"> |
1920 |
<thead> |
1921 |
<tr> |
1922 |
<th width="20"></th> |
1923 |
<th width="12%" class="bottom_border name">Name</th> |
1924 |
<th width="10%" class="bottom_border">Type</th> |
1925 |
<th width="10%" class="bottom_border">Attributes</th> |
1926 |
<th width="10%" class="bottom_border">Default</th> |
1927 |
<th class="last bottom_border">Description</th> |
1928 |
</tr> |
1929 |
</thead> |
1930 |
|
1931 |
<tbody> |
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> |
1933 |
</tbody> |
1934 |
</table><h5>Returns:</h5><p class="returns"><p>i the number of visible columns</p></p></div> |
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"><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"> → {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 |
1936 |
of hidden columns)</p><div class="collapse_details"><dl class="details"> |
1937 |
|
1938 |
</dl> |
1939 |
<h5>Parameters:</h5> |
1940 |
|
1941 |
<table class="params"> |
1942 |
<thead> |
1943 |
<tr> |
1944 |
<th width="20"></th> |
1945 |
<th width="12%" class="bottom_border name">Name</th> |
1946 |
<th width="10%" class="bottom_border">Type</th> |
1947 |
<th width="10%" class="bottom_border">Attributes</th> |
1948 |
<th width="10%" class="bottom_border">Default</th> |
1949 |
<th class="last bottom_border">Description</th> |
1950 |
</tr> |
1951 |
</thead> |
1952 |
|
1953 |
<tbody> |
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> |
1955 |
</tbody> |
1956 |
</table><h5>Returns:</h5><p class="returns"><p>i the data index</p></p></div> |
1957 |
|
1958 |
</dd> |
1959 |
</div> |
1960 |
</div> |
1961 |
|
1962 |
</div> |
1963 |
|
1964 |
<div class="fw_footer"> |
1965 |
DataTables: Copyright 2008-2012 Allan Jardine, all rights reserved<br> |
1966 |
|
1967 |
Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on |
1968 |
23th Sep 2012 - 14:27 |
1969 |
with the <a href="http://datatables.net/">DataTables</a> template. |
1970 |
</div> |
1971 |
</body> |
1972 |
</html> |