ireport: DataTables-1.9.4/docs/DataTable.models.oSettings.html annotate

annotate DataTables-1.9.4/docs/DataTable.models.oSettings.html @ 3:4a6ebda2a3ae draft

fixed tool dependency issue

author	saskia-hiltemann
date	Tue, 30 Sep 2014 09:56:12 -0400
parents	ac5f9272033b
children

rev	line source
0 ac5f9272033b first upload saskia-hiltemann parents: diff changeset	1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	2 <html>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	3 <head>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	4 <meta http-equiv="Content-type" content="text/html; charset=utf-8">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	5 <title>Namespace: oSettings - documentation</title>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	6
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	7 <style type="text/css" media="screen">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	8 @import "media/css/doc.css";
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	9 @import "media/css/shCore.css";
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	10 @import "media/css/shThemeDataTables.css";
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	11 </style>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	12
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	13 <script type="text/javascript" src="media/js/shCore.js"></script>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	14 <script type="text/javascript" src="media/js/shBrushJScript.js"></script>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	15 <script type="text/javascript" src="media/js/jquery.js"></script>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	16 <script type="text/javascript" src="media/js/doc.js"></script>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	17 </head>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	18 <body>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	19 <div class="fw_container">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	20
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	21 <a name="top"></a>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	22 <div class="fw_header">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	23 <h1 class="page-title">Namespace: oSettings</h1>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	24 <h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a>.</span> » oSettings</h2>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	25 <div class="page-info">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	26 DataTables v1.9.4 documentation
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	27 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	28 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	29
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	30
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	31
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	32 <div class="fw_nav">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	33 <h2>Navigation</h2>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	34 <ul>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	35 <li><a href="#top">Overview</a></li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	36 <li><a href="#summary">Summary</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Classes (0)</td><td><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>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	37 <div style="margin-top: 10px;">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	38 <input type="hidden" name="show_private" value="0">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	39 <span id="private_label">Hiding</span> private elements
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	40 (<a id="private_toggle" href="">toggle</a>)
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	41 </span>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	42 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	43 <div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	44 <input type="hidden" name="show_extended" value="1">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	45 <span id="extended_label">Showing</span> extended elements
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	46 (<a id="extended_toggle" href="">toggle</a>)
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	47 </span>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	48 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	49 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	50
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	51 <div class="fw_content">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	52 <a name="overview"></a>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	53 <div class="doc_overview">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	54 <div class="nav_blocker"></div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	55 <p>DataTables settings object - this holds all the information needed for a
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	56 given table, including configuration, data and current application of the
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	57 table options. DataTables does not have a single instance for each DataTable
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	58 with the settings attached to that instance, but rather instances of the
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	59 DataTable "class" are created on-the-fly as needed (typically by a
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	60 $().dataTable() call) and the settings object is then applied to that
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	61 instance.</p>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	62
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	63 <p>Note that this object is related to <a href="DataTable.defaults.html">DataTable.defaults</a> but this
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	64 one is the internal data store for DataTables's cache of columns. It should
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	65 NOT be manipulated outside of DataTables. Any configuration should be done
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	66 through the initialisation options.</p><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	67
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	68 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	69
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	70 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	71
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	72
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	73 <div class="doc_summary">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	74 <a name="summary"></a>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	75 <h2>Summary</h2>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	76
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	77 <div class="doc_group"><a name="summary_namespaces"></a><h3 class="subsection-title">Namespaces</h3>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	78 <dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	80 research or compare the old search to a new one.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	81 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	83 </dl></div><div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	84
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	85 <dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	87 parameters of this object match what is allowed by sDom - i.e.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	88 <ul>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	89 <li>'l' - Length changing</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	90 <li>'f' - Filtering input</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	91 <li>'t' - The table!</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	92 <li>'i' - Information</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	93 <li>'p' - Pagination</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	94 <li>'r' - pRocessing</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	97 aaSorting).
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	98 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	100 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	106 <a href="DataTable.models.oSearch.html">DataTable.models.oSearch</a> for the format that is used for the
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	109 object with the following parameters:
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	110 <ul>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	111 <li>function:fn - function to call. Takes two parameters, oSettings
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	112 and the object stored. May return false to cancel state loading</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	113 <li>string:sName - name of callback</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	117 object with the following parameters:
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	118 <ul>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	119 <li>function:fn - function to call. Takes two parameters, oSettings
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	120 and the JSON string to save that has been thus far created. Returns
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	121 a JSON string to be inserted into a json object
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	122 (i.e. '"param": [ 0, 1, 2]')</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	123 <li>string:sName - name of callback</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	126 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	128 should be deferred until the second draw.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	129 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	131 callback if filtering has been done in the draw. Deprecated in favour of
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	133 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	135 one unique cell per column, if the top one (true) or bottom one (false)
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	136 should be used for sorting / title by DataTables.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	137 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	139 callback if sorting has been done in the draw. Deprecated in favour of
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	141 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	143 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	145 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	147 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	151 This can be used for working with the XHR information in one of the
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	153 can be an empty string (when not server-side processing), in which case
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	154 it is assumed an an array is given directly.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	155 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	157 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	159 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	161 DataTable.model.oInit.sDom.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	162 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	164 is an ID on the table node, then it takes that value, otherwise an
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	166 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	168 required).
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	169 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	171 </dl></div><div class="doc_group"><a name="summary_methods_static"></a><h3 class="subsection-title">Methods - static</h3>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	172
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	173 <dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	175 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	176 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	177 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	178
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	179
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	180
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	181
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	182 <div class="doc_details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	183 <a name="details"></a>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	184 <h2>Details</h2>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	185 <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	186 <dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	188 parameters of this object match what is allowed by sDom - i.e.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	189 <ul>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	190 <li>'l' - Length changing</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	191 <li>'f' - Filtering input</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	192 <li>'t' - The table!</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	193 <li>'i' - Information</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	194 <li>'p' - Pagination</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	195 <li>'r' - pRocessing</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	196 </ul></p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	197
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	198 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	200 used in the following manner:</p>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	201
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	202 <ul>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	203 <li>Index 0 - column number</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	204 <li>Index 1 - current sorting direction</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	205 <li>Index 2 - index of asSorting for this column</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	206 </ul>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	207
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	208 <p>Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	209 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	210
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	211 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	213 aaSorting).
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	214 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	215 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	216
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	217 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	219
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	220 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	222
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	223 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	225 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	226 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	227
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	228 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	230
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	231 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	233 information.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	234
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	235 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	237 destroy so they can clean up markup and events.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	238
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	239 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	241
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	242 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	244
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	245 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	247
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	248 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	250
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	251 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	253
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	254 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	256
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	257 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	259 'nTr' and 'nParent'</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	260
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	261 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	263 false will be used to cancel the draw.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	264
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	265 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	267 <a href="DataTable.models.oSearch.html">DataTable.models.oSearch</a> for the format that is used for the
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	268 filtering information for each column.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	269
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	270 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	272
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	273 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	275
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	276 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	277 </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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	278 parameters can easily be sent to the server</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	279
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	280 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	282 object with the following parameters:
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	283 <ul>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	284 <li>function:fn - function to call. Takes two parameters, oSettings
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	285 and the object stored. May return false to cancel state loading</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	286 <li>string:sName - name of callback</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	287 </ul></p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	288
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	289 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	291 loaded</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	292
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	293 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	295 prior to using the stored values to restore the state.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	296
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	297 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	299 object with the following parameters:
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	300 <ul>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	301 <li>function:fn - function to call. Takes two parameters, oSettings
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	302 and the JSON string to save that has been thus far created. Returns
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	303 a JSON string to be inserted into a json object
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	304 (i.e. '"param": [ 0, 1, 2]')</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	305 <li>string:sName - name of callback</li>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	306 </ul></p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	307
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	308 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	310 saving state.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	311
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	312 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	314
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	315 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	317
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	318 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	320 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	321 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	322
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	323 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	325
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	326 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	328 should be deferred until the second draw.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	329 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	330 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	331
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	332 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	334
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	335 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	337 callback if filtering has been done in the draw. Deprecated in favour of
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	338 events.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	339 <dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	340 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	342
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	343 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	345 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	346 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	347
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	348 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	350 one unique cell per column, if the top one (true) or bottom one (false)
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	351 should be used for sorting / title by DataTables.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	352 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	353 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	354
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	355 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	357 callback if sorting has been done in the draw. Deprecated in favour of
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	358 events.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	359 <dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	360 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	362 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	363 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	364
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	365 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	366 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	368 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	369 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	370
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	371 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	372 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	374 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	375 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	376
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	377 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	378 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	380 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	381 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	382
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	383 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	385 server-side processing</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	386
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	387 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	389
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	390 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	392 keyboard navigation of the table and its controls.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	393
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	394 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	396 This can be used for working with the XHR information in one of the
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	397 callbacks</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	398
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	399 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	401
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	402 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	404
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	405 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	407
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	408 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	410
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	411 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	413
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	414 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	416
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	417 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	419
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	420 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	422
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	423 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	425
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	426 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	428
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	429 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	431
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	432 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	434 can be an empty string (when not server-side processing), in which case
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	435 it is assumed an an array is given directly.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	436 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	437 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	438
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	439 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	441 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	442 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	443
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	444 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	445 </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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	446 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	447 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	448
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	449 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	451
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	452 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	454 DataTable.model.oInit.sDom.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	455 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	456 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	457
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	458 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	460 is an ID on the table node, then it takes that value, otherwise an
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	461 incrementing internal counter is used.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	462
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	463 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	465 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	466 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	467
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	468 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	470 required).
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	471 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	472 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	473
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	474 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	476
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	477 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	479
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	480 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	482
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	483 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	484 </div></dd>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	485 </dl></div><div class="doc_group"><a name="details_methods"></a><h3 class="subsection-title">Methods - static</h3>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	486 <dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	488
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	489 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	490 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	492
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	493 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	494 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	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">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	496
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	497 </dl>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	498 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	499
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	500 </dd>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	501 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	502 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	503
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	504 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	505
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	506 <div class="fw_footer">
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	507 DataTables: Copyright 2008-2012 Allan Jardine, all rights reserved<br>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	508
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	509 Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	510 23th Sep 2012 - 14:27
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	511 with the <a href="http://datatables.net/">DataTables</a> template.
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	512 </div>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	513 </body>
ac5f9272033b first upload saskia-hiltemann parents: diff changeset	514 </html>

Mercurial > repos > saskia-hiltemann > ireport

annotate DataTables-1.9.4/docs/DataTable.models.oSettings.html @ 3:4a6ebda2a3ae draft