| 1 |
torben |
2125 |
<!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: oSettings - 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: oSettings</h1> |
| 24 |
|
|
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a>.</span> » oSettings</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><a href="#summary_namespaces">Namespaces (5)</a></td></tr><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (67)</a></td></tr><tr><td>Methods (0)</td><td><a href="#summary_methods_static">Static methods (3)</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 (67)</a></td></tr><tr><td>Methods (0)</td><td><a href="#summary_methods_static">Static methods (3)</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>DataTables settings object - this holds all the information needed for a |
| 56 |
|
|
given table, including configuration, data and current application of the |
| 57 |
|
|
table options. DataTables does not have a single instance for each DataTable |
| 58 |
|
|
with the settings attached to that instance, but rather instances of the |
| 59 |
|
|
DataTable "class" are created on-the-fly as needed (typically by a |
| 60 |
|
|
$().dataTable() call) and the settings object is then applied to that |
| 61 |
|
|
instance.</p> |
| 62 |
|
|
|
| 63 |
|
|
<p>Note that this object is related to <a href="DataTable.defaults.html">DataTable.defaults</a> but this |
| 64 |
|
|
one is the internal data store for DataTables's cache of columns. It should |
| 65 |
|
|
NOT be manipulated outside of DataTables. Any configuration should be done |
| 66 |
|
|
through the initialisation options.</p><dl class="details"> |
| 67 |
|
|
|
| 68 |
|
|
</dl> |
| 69 |
|
|
|
| 70 |
|
|
</div> |
| 71 |
|
|
|
| 72 |
|
|
|
| 73 |
|
|
<div class="doc_summary"> |
| 74 |
|
|
<a name="summary"></a> |
| 75 |
|
|
<h2>Summary</h2> |
| 76 |
|
|
|
| 77 |
|
|
<div class="doc_group"><a name="summary_namespaces"></a><h3 class="subsection-title">Namespaces</h3> |
| 78 |
|
|
<dl> |
| 79 |
|
|
<dt class="even"><span class="type-name"><a href="DataTable.models.oSettings.oBrowser.html">oBrowser</a></span></dt><dd class="even"><p>Browser support parameters</p></dd><dt class="odd"><span class="type-name"><a href="DataTable.models.oSettings.oFeatures.html">oFeatures</a></span></dt><dd class="odd"><p>Primary features of DataTables and their enablement state.</p></dd><dt class="even"><span class="type-name"><a href="DataTable.models.oSettings.oLanguage.html">oLanguage</a></span></dt><dd class="even"><p>Language information for the table.</p></dd><dt class="odd"><span class="type-name"><a href="DataTable.models.oSettings.oPreviousSearch.html">oPreviousSearch</a></span></dt><dd class="odd"><p>Store the applied global search information in case we want to force a |
| 80 |
|
|
research or compare the old search to a new one. |
| 81 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 82 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class="even"><span class="type-name"><a href="DataTable.models.oSettings.oScroll.html">oScroll</a></span></dt><dd class="even"><p>Scrolling settings for a table.</p></dd> |
| 83 |
|
|
</dl></div><div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3> |
| 84 |
|
|
|
| 85 |
|
|
<dl> |
| 86 |
|
|
<dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aanFeatures">aanFeatures</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Array referencing the nodes which are used for the features. The |
| 87 |
|
|
parameters of this object match what is allowed by sDom - i.e. |
| 88 |
|
|
<ul> |
| 89 |
|
|
<li>'l' - Length changing</li> |
| 90 |
|
|
<li>'f' - Filtering input</li> |
| 91 |
|
|
<li>'t' - The table!</li> |
| 92 |
|
|
<li>'i' - Information</li> |
| 93 |
|
|
<li>'p' - Pagination</li> |
| 94 |
|
|
<li>'r' - pRocessing</li> |
| 95 |
|
|
</ul></p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aaSorting">aaSorting</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Sorting that is applied to the table. Note that the inner arrays are |
| 96 |
|
|
used in the following manner: [<a href-"#aaSorting">...</a>] </p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aaSortingFixed">aaSortingFixed</a></span><span class="type-sig"><span class="type-signature"> :array|null</span></span></dt><dd class=" even"><p>Sorting that is always applied to the table (i.e. prefixed in front of |
| 97 |
|
|
aaSorting). |
| 98 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 99 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aiDisplay">aiDisplay</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of indexes which are in the current display (after filtering etc)</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aiDisplayMaster">aiDisplayMaster</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Array of indexes for display - no filtering</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aLengthMenu">aLengthMenu</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>List of options that can be used for the user selectable length menu. |
| 100 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 101 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoColumns">aoColumns</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Store information about each column that is in use</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoData">aoData</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Store data information - see <a href="DataTable.models.oRow.html">DataTable.models.oRow</a> for detailed |
| 102 |
|
|
information.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoDestroyCallback">aoDestroyCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Destroy callback functions - for plug-ins to attach themselves to the |
| 103 |
|
|
destroy so they can clean up markup and events.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoDrawCallback">aoDrawCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of callback functions for draw callback functions</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoFooter">aoFooter</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Store information about the table's footer</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoFooterCallback">aoFooterCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callback function for the footer on each draw.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoHeader">aoHeader</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Store information about the table's header</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoHeaderCallback">aoHeaderCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callback functions for the header on each draw.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoInitComplete">aoInitComplete</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callback functions for when the table has been initialised.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoOpenRows">aoOpenRows</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Information about open rows. Each object in the array has the parameters |
| 104 |
|
|
'nTr' and 'nParent'</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoPreDrawCallback">aoPreDrawCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callback functions for just before the table is redrawn. A return of |
| 105 |
|
|
false will be used to cancel the draw.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoPreSearchCols">aoPreSearchCols</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Store the applied search for each column - see |
| 106 |
|
|
<a href="DataTable.models.oSearch.html">DataTable.models.oSearch</a> for the format that is used for the |
| 107 |
|
|
filtering information for each column.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoRowCallback">aoRowCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callback functions array for every time a row is inserted (i.e. on a draw).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoRowCreatedCallback">aoRowCreatedCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of callback functions for row created function</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoServerParams">aoServerParams</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Functions which are called prior to sending an Ajax request so extra |
| 108 |
|
|
parameters can easily be sent to the server</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateLoad">aoStateLoad</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of callback functions for state loading. Each array element is an |
| 109 |
|
|
object with the following parameters: |
| 110 |
|
|
<ul> |
| 111 |
|
|
<li>function:fn - function to call. Takes two parameters, oSettings |
| 112 |
|
|
and the object stored. May return false to cancel state loading</li> |
| 113 |
|
|
<li>string:sName - name of callback</li> |
| 114 |
|
|
</ul></p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateLoaded">aoStateLoaded</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callbacks for operating on the settings object once the saved state has been |
| 115 |
|
|
loaded</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateLoadParams">aoStateLoadParams</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callbacks for modifying the settings that have been stored for state saving |
| 116 |
|
|
prior to using the stored values to restore the state.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateSave">aoStateSave</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Array of callback functions for state saving. Each array element is an |
| 117 |
|
|
object with the following parameters: |
| 118 |
|
|
<ul> |
| 119 |
|
|
<li>function:fn - function to call. Takes two parameters, oSettings |
| 120 |
|
|
and the JSON string to save that has been thus far created. Returns |
| 121 |
|
|
a JSON string to be inserted into a json object |
| 122 |
|
|
(i.e. '"param": [ 0, 1, 2]')</li> |
| 123 |
|
|
<li>string:sName - name of callback</li> |
| 124 |
|
|
</ul></p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateSaveParams">aoStateSaveParams</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callbacks for modifying the settings to be stored for state saving, prior to |
| 125 |
|
|
saving state.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asDataSearch">asDataSearch</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Search data array for regular expression searching</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asDestroyStripes">asDestroyStripes</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>If restoring a table - we should restore its striping classes as well</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asStripeClasses">asStripeClasses</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Classes to use for the striping of a table. |
| 126 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 127 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bAjaxDataGet">bAjaxDataGet</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Note if draw should be blocked while getting data</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bDeferLoading">bDeferLoading</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Indicate if when using server-side processing the loading of data |
| 128 |
|
|
should be deferred until the second draw. |
| 129 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 130 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bDrawing">bDrawing</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Indicate if a redraw is being done - useful for Ajax</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bFiltered">bFiltered</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag attached to the settings object so you can check in the draw |
| 131 |
|
|
callback if filtering has been done in the draw. Deprecated in favour of |
| 132 |
|
|
events.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bInitialised">bInitialised</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Indicate if all required information has been read in</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bJUI">bJUI</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to indicate if jQuery UI marking and classes should be used. |
| 133 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 134 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSortCellsTop">bSortCellsTop</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Indicate that if multiple rows are in the header and there is more than |
| 135 |
|
|
one unique cell per column, if the top one (true) or bottom one (false) |
| 136 |
|
|
should be used for sorting / title by DataTables. |
| 137 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 138 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSorted">bSorted</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag attached to the settings object so you can check in the draw |
| 139 |
|
|
callback if sorting has been done in the draw. Deprecated in favour of |
| 140 |
|
|
events.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnCookieCallback">fnCookieCallback</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" odd"><p>Callback function for cookie creation. |
| 141 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 142 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnFormatNumber">fnFormatNumber</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" even"><p>Format numbers for display. |
| 143 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 144 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnServerData">fnServerData</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" odd"><p>Function to get the server-side data. |
| 145 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 146 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iCookieDuration">iCookieDuration</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>The cookie duration (for bStateSave) in seconds. |
| 147 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 148 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iDraw">iDraw</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Counter for the draws that the table does. Also used as a tracker for |
| 149 |
|
|
server-side processing</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iDrawError">iDrawError</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Draw index (iDraw) of the last error when parsing the returned data</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iTabIndex">iTabIndex</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" odd"><p>tabindex attribute value that is added to DataTables control elements, allowing |
| 150 |
|
|
keyboard navigation of the table and its controls.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#jqXHR">jqXHR</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>The last jQuery XHR object that was used for server-side data gathering. |
| 151 |
|
|
This can be used for working with the XHR information in one of the |
| 152 |
|
|
callbacks</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nScrollFoot">nScrollFoot</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" odd"><p>DIV container for the footer scrolling table if scrolling</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nScrollHead">nScrollHead</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" even"><p>DIV container for the footer scrolling table if scrolling</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTable">nTable</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>The TABLE node for the main table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTableWrapper">nTableWrapper</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>Cache the wrapper node (contains all DataTables controlled elements)</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTBody">nTBody</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>Permanent ref to the tbody element</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTFoot">nTFoot</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>Permanent ref to the tfoot element - if it exists</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTHead">nTHead</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>Permanent ref to the thead element</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oClasses">oClasses</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>The classes to use 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="#oInit">oInit</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>Initialisation object that is used 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="#oInstance">oInstance</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>The DataTables object for this table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oLoadedState">oLoadedState</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>State that was loaded from the cookie. Useful for back reference</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sAjaxDataProp">sAjaxDataProp</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Property from a given object from which to read the table data from. This |
| 153 |
|
|
can be an empty string (when not server-side processing), in which case |
| 154 |
|
|
it is assumed an an array is given directly. |
| 155 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 156 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sAjaxSource">sAjaxSource</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Source url for AJAX data for the table. |
| 157 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 158 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sCookiePrefix">sCookiePrefix</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>The cookie name prefix. |
| 159 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 160 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sDestroyWidth">sDestroyWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>If restoring a table - we should restore its width</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sDom">sDom</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Dictate the positioning of DataTables' control elements - see |
| 161 |
|
|
DataTable.model.oInit.sDom. |
| 162 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 163 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInstance">sInstance</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Unique identifier for each instance of the DataTables object. If there |
| 164 |
|
|
is an ID on the table node, then it takes that value, otherwise an |
| 165 |
|
|
incrementing internal counter is used.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sPaginationType">sPaginationType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Which type of pagination should be used. |
| 166 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 167 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sServerMethod">sServerMethod</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Send the XHR HTTP method - GET or POST (could be PUT or DELETE if |
| 168 |
|
|
required). |
| 169 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 170 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sTableId">sTableId</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Cache the table ID for quick access</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_iDisplayLength">_iDisplayLength</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Paging display length</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_iDisplayStart">_iDisplayStart</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Paging start point - aiDisplay index</p></dd> |
| 171 |
|
|
</dl></div><div class="doc_group"><a name="summary_methods_static"></a><h3 class="subsection-title">Methods - static</h3> |
| 172 |
|
|
|
| 173 |
|
|
<dl> |
| 174 |
|
|
<dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnDisplayEnd">fnDisplayEnd</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Set the display end point - aiDisplay index</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnRecordsDisplay">fnRecordsDisplay</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Get the number of records in the current record set, after filtering</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnRecordsTotal">fnRecordsTotal</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Get the number of records in the current record set, before filtering</p></dd> |
| 175 |
|
|
</dl> |
| 176 |
|
|
</div> |
| 177 |
|
|
</div> |
| 178 |
|
|
|
| 179 |
|
|
|
| 180 |
|
|
|
| 181 |
|
|
|
| 182 |
|
|
<div class="doc_details"> |
| 183 |
|
|
<a name="details"></a> |
| 184 |
|
|
<h2>Details</h2> |
| 185 |
|
|
<div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3> |
| 186 |
|
|
<dl> |
| 187 |
|
|
<dt class=" even"><a name="aanFeatures"></a><a name="aanFeatures_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aanFeatures">aanFeatures</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Array referencing the nodes which are used for the features. The |
| 188 |
|
|
parameters of this object match what is allowed by sDom - i.e. |
| 189 |
|
|
<ul> |
| 190 |
|
|
<li>'l' - Length changing</li> |
| 191 |
|
|
<li>'f' - Filtering input</li> |
| 192 |
|
|
<li>'t' - The table!</li> |
| 193 |
|
|
<li>'i' - Information</li> |
| 194 |
|
|
<li>'p' - Pagination</li> |
| 195 |
|
|
<li>'r' - pRocessing</li> |
| 196 |
|
|
</ul></p><div class="collapse_details"><dl class="details"> |
| 197 |
|
|
|
| 198 |
|
|
</dl> |
| 199 |
|
|
</div></dd><dt class=" odd"><a name="aaSorting"></a><a name="aaSorting_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aaSorting">aaSorting</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Sorting that is applied to the table. Note that the inner arrays are |
| 200 |
|
|
used in the following manner:</p> |
| 201 |
|
|
|
| 202 |
|
|
<ul> |
| 203 |
|
|
<li>Index 0 - column number</li> |
| 204 |
|
|
<li>Index 1 - current sorting direction</li> |
| 205 |
|
|
<li>Index 2 - index of asSorting for this column</li> |
| 206 |
|
|
</ul> |
| 207 |
|
|
|
| 208 |
|
|
<p>Note that this parameter will be set by the initialisation routine. To |
| 209 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 210 |
|
|
|
| 211 |
|
|
</dl> |
| 212 |
|
|
</div></dd><dt class=" even"><a name="aaSortingFixed"></a><a name="aaSortingFixed_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aaSortingFixed">aaSortingFixed</a></span><span class="type-sig"><span class="type-signature"> :array|null</span></span></dt><dd class=" even"><p>Sorting that is always applied to the table (i.e. prefixed in front of |
| 213 |
|
|
aaSorting). |
| 214 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 215 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 216 |
|
|
|
| 217 |
|
|
</dl> |
| 218 |
|
|
</div></dd><dt class=" odd"><a name="aiDisplay"></a><a name="aiDisplay_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aiDisplay">aiDisplay</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of indexes which are in the current display (after filtering etc)</p><div class="collapse_details"><dl class="details"> |
| 219 |
|
|
|
| 220 |
|
|
</dl> |
| 221 |
|
|
</div></dd><dt class=" even"><a name="aiDisplayMaster"></a><a name="aiDisplayMaster_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aiDisplayMaster">aiDisplayMaster</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Array of indexes for display - no filtering</p><div class="collapse_details"><dl class="details"> |
| 222 |
|
|
|
| 223 |
|
|
</dl> |
| 224 |
|
|
</div></dd><dt class=" odd"><a name="aLengthMenu"></a><a name="aLengthMenu_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aLengthMenu">aLengthMenu</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>List of options that can be used for the user selectable length menu. |
| 225 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 226 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 227 |
|
|
|
| 228 |
|
|
</dl> |
| 229 |
|
|
</div></dd><dt class=" even"><a name="aoColumns"></a><a name="aoColumns_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoColumns">aoColumns</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Store information about each column that is in use</p><div class="collapse_details"><dl class="details"> |
| 230 |
|
|
|
| 231 |
|
|
</dl> |
| 232 |
|
|
</div></dd><dt class=" odd"><a name="aoData"></a><a name="aoData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoData">aoData</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Store data information - see <a href="DataTable.models.oRow.html">DataTable.models.oRow</a> for detailed |
| 233 |
|
|
information.</p><div class="collapse_details"><dl class="details"> |
| 234 |
|
|
|
| 235 |
|
|
</dl> |
| 236 |
|
|
</div></dd><dt class=" even"><a name="aoDestroyCallback"></a><a name="aoDestroyCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoDestroyCallback">aoDestroyCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Destroy callback functions - for plug-ins to attach themselves to the |
| 237 |
|
|
destroy so they can clean up markup and events.</p><div class="collapse_details"><dl class="details"> |
| 238 |
|
|
|
| 239 |
|
|
</dl> |
| 240 |
|
|
</div></dd><dt class=" odd"><a name="aoDrawCallback"></a><a name="aoDrawCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoDrawCallback">aoDrawCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of callback functions for draw callback functions</p><div class="collapse_details"><dl class="details"> |
| 241 |
|
|
|
| 242 |
|
|
</dl> |
| 243 |
|
|
</div></dd><dt class=" even"><a name="aoFooter"></a><a name="aoFooter_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoFooter">aoFooter</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Store information about the table's footer</p><div class="collapse_details"><dl class="details"> |
| 244 |
|
|
|
| 245 |
|
|
</dl> |
| 246 |
|
|
</div></dd><dt class=" odd"><a name="aoFooterCallback"></a><a name="aoFooterCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoFooterCallback">aoFooterCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callback function for the footer on each draw.</p><div class="collapse_details"><dl class="details"> |
| 247 |
|
|
|
| 248 |
|
|
</dl> |
| 249 |
|
|
</div></dd><dt class=" even"><a name="aoHeader"></a><a name="aoHeader_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoHeader">aoHeader</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Store information about the table's header</p><div class="collapse_details"><dl class="details"> |
| 250 |
|
|
|
| 251 |
|
|
</dl> |
| 252 |
|
|
</div></dd><dt class=" odd"><a name="aoHeaderCallback"></a><a name="aoHeaderCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoHeaderCallback">aoHeaderCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callback functions for the header on each draw.</p><div class="collapse_details"><dl class="details"> |
| 253 |
|
|
|
| 254 |
|
|
</dl> |
| 255 |
|
|
</div></dd><dt class=" even"><a name="aoInitComplete"></a><a name="aoInitComplete_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoInitComplete">aoInitComplete</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callback functions for when the table has been initialised.</p><div class="collapse_details"><dl class="details"> |
| 256 |
|
|
|
| 257 |
|
|
</dl> |
| 258 |
|
|
</div></dd><dt class=" odd"><a name="aoOpenRows"></a><a name="aoOpenRows_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoOpenRows">aoOpenRows</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Information about open rows. Each object in the array has the parameters |
| 259 |
|
|
'nTr' and 'nParent'</p><div class="collapse_details"><dl class="details"> |
| 260 |
|
|
|
| 261 |
|
|
</dl> |
| 262 |
|
|
</div></dd><dt class=" even"><a name="aoPreDrawCallback"></a><a name="aoPreDrawCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoPreDrawCallback">aoPreDrawCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callback functions for just before the table is redrawn. A return of |
| 263 |
|
|
false will be used to cancel the draw.</p><div class="collapse_details"><dl class="details"> |
| 264 |
|
|
|
| 265 |
|
|
</dl> |
| 266 |
|
|
</div></dd><dt class=" odd"><a name="aoPreSearchCols"></a><a name="aoPreSearchCols_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoPreSearchCols">aoPreSearchCols</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Store the applied search for each column - see |
| 267 |
|
|
<a href="DataTable.models.oSearch.html">DataTable.models.oSearch</a> for the format that is used for the |
| 268 |
|
|
filtering information for each column.</p><div class="collapse_details"><dl class="details"> |
| 269 |
|
|
|
| 270 |
|
|
</dl> |
| 271 |
|
|
</div></dd><dt class=" even"><a name="aoRowCallback"></a><a name="aoRowCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoRowCallback">aoRowCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callback functions array for every time a row is inserted (i.e. on a draw).</p><div class="collapse_details"><dl class="details"> |
| 272 |
|
|
|
| 273 |
|
|
</dl> |
| 274 |
|
|
</div></dd><dt class=" odd"><a name="aoRowCreatedCallback"></a><a name="aoRowCreatedCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoRowCreatedCallback">aoRowCreatedCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of callback functions for row created function</p><div class="collapse_details"><dl class="details"> |
| 275 |
|
|
|
| 276 |
|
|
</dl> |
| 277 |
|
|
</div></dd><dt class=" even"><a name="aoServerParams"></a><a name="aoServerParams_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoServerParams">aoServerParams</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Functions which are called prior to sending an Ajax request so extra |
| 278 |
|
|
parameters can easily be sent to the server</p><div class="collapse_details"><dl class="details"> |
| 279 |
|
|
|
| 280 |
|
|
</dl> |
| 281 |
|
|
</div></dd><dt class=" odd"><a name="aoStateLoad"></a><a name="aoStateLoad_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateLoad">aoStateLoad</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of callback functions for state loading. Each array element is an |
| 282 |
|
|
object with the following parameters: |
| 283 |
|
|
<ul> |
| 284 |
|
|
<li>function:fn - function to call. Takes two parameters, oSettings |
| 285 |
|
|
and the object stored. May return false to cancel state loading</li> |
| 286 |
|
|
<li>string:sName - name of callback</li> |
| 287 |
|
|
</ul></p><div class="collapse_details"><dl class="details"> |
| 288 |
|
|
|
| 289 |
|
|
</dl> |
| 290 |
|
|
</div></dd><dt class=" even"><a name="aoStateLoaded"></a><a name="aoStateLoaded_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateLoaded">aoStateLoaded</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callbacks for operating on the settings object once the saved state has been |
| 291 |
|
|
loaded</p><div class="collapse_details"><dl class="details"> |
| 292 |
|
|
|
| 293 |
|
|
</dl> |
| 294 |
|
|
</div></dd><dt class=" odd"><a name="aoStateLoadParams"></a><a name="aoStateLoadParams_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateLoadParams">aoStateLoadParams</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callbacks for modifying the settings that have been stored for state saving |
| 295 |
|
|
prior to using the stored values to restore the state.</p><div class="collapse_details"><dl class="details"> |
| 296 |
|
|
|
| 297 |
|
|
</dl> |
| 298 |
|
|
</div></dd><dt class=" even"><a name="aoStateSave"></a><a name="aoStateSave_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateSave">aoStateSave</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Array of callback functions for state saving. Each array element is an |
| 299 |
|
|
object with the following parameters: |
| 300 |
|
|
<ul> |
| 301 |
|
|
<li>function:fn - function to call. Takes two parameters, oSettings |
| 302 |
|
|
and the JSON string to save that has been thus far created. Returns |
| 303 |
|
|
a JSON string to be inserted into a json object |
| 304 |
|
|
(i.e. '"param": [ 0, 1, 2]')</li> |
| 305 |
|
|
<li>string:sName - name of callback</li> |
| 306 |
|
|
</ul></p><div class="collapse_details"><dl class="details"> |
| 307 |
|
|
|
| 308 |
|
|
</dl> |
| 309 |
|
|
</div></dd><dt class=" odd"><a name="aoStateSaveParams"></a><a name="aoStateSaveParams_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateSaveParams">aoStateSaveParams</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callbacks for modifying the settings to be stored for state saving, prior to |
| 310 |
|
|
saving state.</p><div class="collapse_details"><dl class="details"> |
| 311 |
|
|
|
| 312 |
|
|
</dl> |
| 313 |
|
|
</div></dd><dt class=" even"><a name="asDataSearch"></a><a name="asDataSearch_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asDataSearch">asDataSearch</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Search data array for regular expression searching</p><div class="collapse_details"><dl class="details"> |
| 314 |
|
|
|
| 315 |
|
|
</dl> |
| 316 |
|
|
</div></dd><dt class=" odd"><a name="asDestroyStripes"></a><a name="asDestroyStripes_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asDestroyStripes">asDestroyStripes</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>If restoring a table - we should restore its striping classes as well</p><div class="collapse_details"><dl class="details"> |
| 317 |
|
|
|
| 318 |
|
|
</dl> |
| 319 |
|
|
</div></dd><dt class=" even"><a name="asStripeClasses"></a><a name="asStripeClasses_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asStripeClasses">asStripeClasses</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Classes to use for the striping of a table. |
| 320 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 321 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 322 |
|
|
|
| 323 |
|
|
</dl> |
| 324 |
|
|
</div></dd><dt class=" odd"><a name="bAjaxDataGet"></a><a name="bAjaxDataGet_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bAjaxDataGet">bAjaxDataGet</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Note if draw should be blocked while getting data</p><div class="collapse_details"><dl class="details"> |
| 325 |
|
|
|
| 326 |
|
|
</dl> |
| 327 |
|
|
</div></dd><dt class=" even"><a name="bDeferLoading"></a><a name="bDeferLoading_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bDeferLoading">bDeferLoading</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Indicate if when using server-side processing the loading of data |
| 328 |
|
|
should be deferred until the second draw. |
| 329 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 330 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 331 |
|
|
|
| 332 |
|
|
</dl> |
| 333 |
|
|
</div></dd><dt class=" odd"><a name="bDrawing"></a><a name="bDrawing_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bDrawing">bDrawing</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Indicate if a redraw is being done - useful for Ajax</p><div class="collapse_details"><dl class="details"> |
| 334 |
|
|
|
| 335 |
|
|
</dl> |
| 336 |
|
|
</div></dd><dt class=" even"><a name="bFiltered"></a><a name="bFiltered_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bFiltered">bFiltered</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag attached to the settings object so you can check in the draw |
| 337 |
|
|
callback if filtering has been done in the draw. Deprecated in favour of |
| 338 |
|
|
events.</p><div class="collapse_details"><dl class="details"> |
| 339 |
|
|
<dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd> |
| 340 |
|
|
</dl> |
| 341 |
|
|
</div></dd><dt class=" odd"><a name="bInitialised"></a><a name="bInitialised_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bInitialised">bInitialised</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Indicate if all required information has been read in</p><div class="collapse_details"><dl class="details"> |
| 342 |
|
|
|
| 343 |
|
|
</dl> |
| 344 |
|
|
</div></dd><dt class=" even"><a name="bJUI"></a><a name="bJUI_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bJUI">bJUI</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to indicate if jQuery UI marking and classes should be used. |
| 345 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 346 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 347 |
|
|
|
| 348 |
|
|
</dl> |
| 349 |
|
|
</div></dd><dt class=" odd"><a name="bSortCellsTop"></a><a name="bSortCellsTop_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSortCellsTop">bSortCellsTop</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Indicate that if multiple rows are in the header and there is more than |
| 350 |
|
|
one unique cell per column, if the top one (true) or bottom one (false) |
| 351 |
|
|
should be used for sorting / title by DataTables. |
| 352 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 353 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 354 |
|
|
|
| 355 |
|
|
</dl> |
| 356 |
|
|
</div></dd><dt class=" even"><a name="bSorted"></a><a name="bSorted_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSorted">bSorted</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag attached to the settings object so you can check in the draw |
| 357 |
|
|
callback if sorting has been done in the draw. Deprecated in favour of |
| 358 |
|
|
events.</p><div class="collapse_details"><dl class="details"> |
| 359 |
|
|
<dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd> |
| 360 |
|
|
</dl> |
| 361 |
|
|
</div></dd><dt id="DataTable.models.oSettings.fnCookieCallback" class=" odd"><a name="fnCookieCallback"></a><a name="fnCookieCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnCookieCallback</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" odd"><p>Callback function for cookie creation. |
| 362 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 363 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 364 |
|
|
|
| 365 |
|
|
</dl> |
| 366 |
|
|
</div> |
| 367 |
|
|
<dt id="DataTable.models.oSettings.fnFormatNumber" class=" even"><a name="fnFormatNumber"></a><a name="fnFormatNumber_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnFormatNumber</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" even"><p>Format numbers for display. |
| 368 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 369 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 370 |
|
|
|
| 371 |
|
|
</dl> |
| 372 |
|
|
</div> |
| 373 |
|
|
<dt id="DataTable.models.oSettings.fnServerData" class=" odd"><a name="fnServerData"></a><a name="fnServerData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnServerData</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" odd"><p>Function to get the server-side data. |
| 374 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 375 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 376 |
|
|
|
| 377 |
|
|
</dl> |
| 378 |
|
|
</div> |
| 379 |
|
|
<dt class=" even"><a name="iCookieDuration"></a><a name="iCookieDuration_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iCookieDuration">iCookieDuration</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>The cookie duration (for bStateSave) in seconds. |
| 380 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 381 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 382 |
|
|
|
| 383 |
|
|
</dl> |
| 384 |
|
|
</div></dd><dt class=" odd"><a name="iDraw"></a><a name="iDraw_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iDraw">iDraw</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Counter for the draws that the table does. Also used as a tracker for |
| 385 |
|
|
server-side processing</p><div class="collapse_details"><dl class="details"> |
| 386 |
|
|
|
| 387 |
|
|
</dl> |
| 388 |
|
|
</div></dd><dt class=" even"><a name="iDrawError"></a><a name="iDrawError_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iDrawError">iDrawError</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Draw index (iDraw) of the last error when parsing the returned data</p><div class="collapse_details"><dl class="details"> |
| 389 |
|
|
|
| 390 |
|
|
</dl> |
| 391 |
|
|
</div></dd><dt class=" odd"><a name="iTabIndex"></a><a name="iTabIndex_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iTabIndex">iTabIndex</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" odd"><p>tabindex attribute value that is added to DataTables control elements, allowing |
| 392 |
|
|
keyboard navigation of the table and its controls.</p><div class="collapse_details"><dl class="details"> |
| 393 |
|
|
|
| 394 |
|
|
</dl> |
| 395 |
|
|
</div></dd><dt class=" even"><a name="jqXHR"></a><a name="jqXHR_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#jqXHR">jqXHR</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>The last jQuery XHR object that was used for server-side data gathering. |
| 396 |
|
|
This can be used for working with the XHR information in one of the |
| 397 |
|
|
callbacks</p><div class="collapse_details"><dl class="details"> |
| 398 |
|
|
|
| 399 |
|
|
</dl> |
| 400 |
|
|
</div></dd><dt class=" odd"><a name="nScrollFoot"></a><a name="nScrollFoot_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nScrollFoot">nScrollFoot</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" odd"><p>DIV container for the footer scrolling table if scrolling</p><div class="collapse_details"><dl class="details"> |
| 401 |
|
|
|
| 402 |
|
|
</dl> |
| 403 |
|
|
</div></dd><dt class=" even"><a name="nScrollHead"></a><a name="nScrollHead_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nScrollHead">nScrollHead</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" even"><p>DIV container for the footer scrolling table if scrolling</p><div class="collapse_details"><dl class="details"> |
| 404 |
|
|
|
| 405 |
|
|
</dl> |
| 406 |
|
|
</div></dd><dt class=" odd"><a name="nTable"></a><a name="nTable_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTable">nTable</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>The TABLE node for the main table</p><div class="collapse_details"><dl class="details"> |
| 407 |
|
|
|
| 408 |
|
|
</dl> |
| 409 |
|
|
</div></dd><dt class=" even"><a name="nTableWrapper"></a><a name="nTableWrapper_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTableWrapper">nTableWrapper</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>Cache the wrapper node (contains all DataTables controlled elements)</p><div class="collapse_details"><dl class="details"> |
| 410 |
|
|
|
| 411 |
|
|
</dl> |
| 412 |
|
|
</div></dd><dt class=" odd"><a name="nTBody"></a><a name="nTBody_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTBody">nTBody</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>Permanent ref to the tbody element</p><div class="collapse_details"><dl class="details"> |
| 413 |
|
|
|
| 414 |
|
|
</dl> |
| 415 |
|
|
</div></dd><dt class=" even"><a name="nTFoot"></a><a name="nTFoot_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTFoot">nTFoot</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>Permanent ref to the tfoot element - if it exists</p><div class="collapse_details"><dl class="details"> |
| 416 |
|
|
|
| 417 |
|
|
</dl> |
| 418 |
|
|
</div></dd><dt class=" odd"><a name="nTHead"></a><a name="nTHead_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTHead">nTHead</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>Permanent ref to the thead element</p><div class="collapse_details"><dl class="details"> |
| 419 |
|
|
|
| 420 |
|
|
</dl> |
| 421 |
|
|
</div></dd><dt class=" even"><a name="oClasses"></a><a name="oClasses_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oClasses">oClasses</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>The classes to use for the table</p><div class="collapse_details"><dl class="details"> |
| 422 |
|
|
|
| 423 |
|
|
</dl> |
| 424 |
|
|
</div></dd><dt class=" odd"><a name="oInit"></a><a name="oInit_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oInit">oInit</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>Initialisation object that is used for the table</p><div class="collapse_details"><dl class="details"> |
| 425 |
|
|
|
| 426 |
|
|
</dl> |
| 427 |
|
|
</div></dd><dt class=" even"><a name="oInstance"></a><a name="oInstance_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oInstance">oInstance</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>The DataTables object for this table</p><div class="collapse_details"><dl class="details"> |
| 428 |
|
|
|
| 429 |
|
|
</dl> |
| 430 |
|
|
</div></dd><dt class=" odd"><a name="oLoadedState"></a><a name="oLoadedState_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oLoadedState">oLoadedState</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>State that was loaded from the cookie. Useful for back reference</p><div class="collapse_details"><dl class="details"> |
| 431 |
|
|
|
| 432 |
|
|
</dl> |
| 433 |
|
|
</div></dd><dt class=" even"><a name="sAjaxDataProp"></a><a name="sAjaxDataProp_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sAjaxDataProp">sAjaxDataProp</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Property from a given object from which to read the table data from. This |
| 434 |
|
|
can be an empty string (when not server-side processing), in which case |
| 435 |
|
|
it is assumed an an array is given directly. |
| 436 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 437 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 438 |
|
|
|
| 439 |
|
|
</dl> |
| 440 |
|
|
</div></dd><dt class=" odd"><a name="sAjaxSource"></a><a name="sAjaxSource_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sAjaxSource">sAjaxSource</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Source url for AJAX data for the table. |
| 441 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 442 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 443 |
|
|
|
| 444 |
|
|
</dl> |
| 445 |
|
|
</div></dd><dt class=" even"><a name="sCookiePrefix"></a><a name="sCookiePrefix_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sCookiePrefix">sCookiePrefix</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>The cookie name prefix. |
| 446 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 447 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 448 |
|
|
|
| 449 |
|
|
</dl> |
| 450 |
|
|
</div></dd><dt class=" odd"><a name="sDestroyWidth"></a><a name="sDestroyWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sDestroyWidth">sDestroyWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>If restoring a table - we should restore its width</p><div class="collapse_details"><dl class="details"> |
| 451 |
|
|
|
| 452 |
|
|
</dl> |
| 453 |
|
|
</div></dd><dt class=" even"><a name="sDom"></a><a name="sDom_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sDom">sDom</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Dictate the positioning of DataTables' control elements - see |
| 454 |
|
|
DataTable.model.oInit.sDom. |
| 455 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 456 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 457 |
|
|
|
| 458 |
|
|
</dl> |
| 459 |
|
|
</div></dd><dt class=" odd"><a name="sInstance"></a><a name="sInstance_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInstance">sInstance</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Unique identifier for each instance of the DataTables object. If there |
| 460 |
|
|
is an ID on the table node, then it takes that value, otherwise an |
| 461 |
|
|
incrementing internal counter is used.</p><div class="collapse_details"><dl class="details"> |
| 462 |
|
|
|
| 463 |
|
|
</dl> |
| 464 |
|
|
</div></dd><dt class=" even"><a name="sPaginationType"></a><a name="sPaginationType_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sPaginationType">sPaginationType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Which type of pagination should be used. |
| 465 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 466 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 467 |
|
|
|
| 468 |
|
|
</dl> |
| 469 |
|
|
</div></dd><dt class=" odd"><a name="sServerMethod"></a><a name="sServerMethod_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sServerMethod">sServerMethod</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Send the XHR HTTP method - GET or POST (could be PUT or DELETE if |
| 470 |
|
|
required). |
| 471 |
|
|
Note that this parameter will be set by the initialisation routine. To |
| 472 |
|
|
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details"> |
| 473 |
|
|
|
| 474 |
|
|
</dl> |
| 475 |
|
|
</div></dd><dt class=" even"><a name="sTableId"></a><a name="sTableId_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sTableId">sTableId</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Cache the table ID for quick access</p><div class="collapse_details"><dl class="details"> |
| 476 |
|
|
|
| 477 |
|
|
</dl> |
| 478 |
|
|
</div></dd><dt class=" odd"><a name="_iDisplayLength"></a><a name="_iDisplayLength_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_iDisplayLength">_iDisplayLength</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Paging display length</p><div class="collapse_details"><dl class="details"> |
| 479 |
|
|
|
| 480 |
|
|
</dl> |
| 481 |
|
|
</div></dd><dt class=" even"><a name="_iDisplayStart"></a><a name="_iDisplayStart_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_iDisplayStart">_iDisplayStart</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Paging start point - aiDisplay index</p><div class="collapse_details"><dl class="details"> |
| 482 |
|
|
|
| 483 |
|
|
</dl> |
| 484 |
|
|
</div></dd> |
| 485 |
|
|
</dl></div><div class="doc_group"><a name="details_methods"></a><h3 class="subsection-title">Methods - static</h3> |
| 486 |
|
|
<dl> |
| 487 |
|
|
<dt id="DataTable.models.oSettings.fnDisplayEnd" class=" even"><a name="fnDisplayEnd"></a><a name="fnDisplayEnd_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnDisplayEnd</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Set the display end point - aiDisplay index</p><div class="collapse_details"><dl class="details"> |
| 488 |
|
|
|
| 489 |
|
|
</dl> |
| 490 |
|
|
</div> |
| 491 |
|
|
<dt id="DataTable.models.oSettings.fnRecordsDisplay" class=" odd"><a name="fnRecordsDisplay"></a><a name="fnRecordsDisplay_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnRecordsDisplay</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Get the number of records in the current record set, after filtering</p><div class="collapse_details"><dl class="details"> |
| 492 |
|
|
|
| 493 |
|
|
</dl> |
| 494 |
|
|
</div> |
| 495 |
|
|
<dt id="DataTable.models.oSettings.fnRecordsTotal" class=" even"><a name="fnRecordsTotal"></a><a name="fnRecordsTotal_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnRecordsTotal</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Get the number of records in the current record set, before filtering</p><div class="collapse_details"><dl class="details"> |
| 496 |
|
|
|
| 497 |
|
|
</dl> |
| 498 |
|
|
</div> |
| 499 |
|
|
|
| 500 |
|
|
</dd> |
| 501 |
|
|
</div> |
| 502 |
|
|
</div> |
| 503 |
|
|
|
| 504 |
|
|
</div> |
| 505 |
|
|
|
| 506 |
|
|
<div class="fw_footer"> |
| 507 |
|
|
DataTables: Copyright 2008-2012 Allan Jardine, all rights reserved<br> |
| 508 |
|
|
|
| 509 |
|
|
Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on |
| 510 |
|
|
23th Sep 2012 - 14:27 |
| 511 |
|
|
with the <a href="http://datatables.net/">DataTables</a> template. |
| 512 |
|
|
</div> |
| 513 |
|
|
</body> |
| 514 |
|
|
</html> |
Parent Directory
| 
Revision Log