Mercurial > repos > saskia-hiltemann > ireport
view DataTables-1.9.4/docs/34cdb56b2c.html @ 7:0f2b740536fb draft
Uploaded
| author | saskia-hiltemann |
|---|---|
| date | Mon, 21 Aug 2017 09:16:07 -0400 |
| parents | ac5f9272033b |
| children |
line wrap: on
line source
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="Content-type" content="text/html; charset=utf-8"> <title>Namespace: oApi - documentation</title> <style type="text/css" media="screen"> @import "media/css/doc.css"; @import "media/css/shCore.css"; @import "media/css/shThemeDataTables.css"; </style> <script type="text/javascript" src="media/js/shCore.js"></script> <script type="text/javascript" src="media/js/shBrushJScript.js"></script> <script type="text/javascript" src="media/js/jquery.js"></script> <script type="text/javascript" src="media/js/doc.js"></script> </head> <body> <div class="fw_container"> <a name="top"></a> <div class="fw_header"> <h1 class="page-title">Namespace: oApi</h1> <h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a>#</span> ยป oApi</h2> <div class="page-info"> DataTables v1.9.4 documentation </div> </div> <div class="fw_nav"> <h2>Navigation</h2> <ul> <li><a href="#top">Overview</a></li> <li><a href="#summary">Summary</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Classes (0)</td><td>Namespaces (0)</td></tr><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (1)</a></td></tr><tr><td>Methods (0)</td><td><a href="#summary_methods_static">Static methods (85)</a></td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></div></li><li><a href="#details">Details</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (1)</a></td></tr><tr><td>Methods (0)</td><td><a href="#summary_methods_static">Static methods (85)</a></td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></div></li></ul> <div style="margin-top: 10px;"> <input type="hidden" name="show_private" value="0"> <span id="private_label">Hiding</span> private elements (<a id="private_toggle" href="">toggle</a>) </span> </div> <div> <input type="hidden" name="show_extended" value="1"> <span id="extended_label">Showing</span> extended elements (<a id="extended_toggle" href="">toggle</a>) </span> </div> </div> <div class="fw_content"> <a name="overview"></a> <div class="doc_overview"> <div class="nav_blocker"></div> <p>Reference to internal functions for use by plug-in developers. Note that these methods are references to internal functions and are considered to be private. If you use these methods, be aware that they are liable to change between versions (check the upgrade notes).</p><dl class="details"> </dl> </div> <div class="doc_summary"> <a name="summary"></a> <h2>Summary</h2> <div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3> <dl> <dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnJsonString">_fnJsonString</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" even"><p>JSON stringify. If JSON.stringify it provided by the browser, json2.js or any other library, then we use that as it is fast, safe and accurate. If the function isn't available then we need to built it ourselves - the inspiration for this function comes from Craig Buckler ( <a href='http://www.sitepoint.com/javascript-json-serialization/'>http://www.sitepoint.com/javascript-json-serialization/</a> ). It is not perfect and absolutely should not be used as a replacement to json2.js - but it does do what we need, without requiring a dependency for DataTables.</p></dd> </dl></div><div class="doc_group"><a name="summary_methods_static"></a><h3 class="subsection-title">Methods - static</h3> <dl> <dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnAddColumn">_fnAddColumn</a></span><span class="type-sig"><span class="signature">(oSettings, nTh)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Add a column to the list used for the table with default values</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnAddData">_fnAddData</a></span><span class="type-sig"><span class="signature">(oSettings, aData)</span><span class="type-signature"> → {int}</span></span></dt><dd class=" odd"><p>Add a data array to the table, creating DOM node etc. This is the parallel to _fnGatherData, but for adding rows from a Javascript source, rather than a DOM source.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnAddOptionsHtml">_fnAddOptionsHtml</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Add the options to the page HTML for the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnAdjustColumnSizing">_fnAdjustColumnSizing</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Adjust the table column widths for new data. Note: you would probably want to do a redraw after calling this function!</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnAjaxParameters">_fnAjaxParameters</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {bool}</span></span></dt><dd class=" even"><p>Build up the parameters in an object needed for a server-side processing request</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnAjaxUpdate">_fnAjaxUpdate</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {boolean}</span></span></dt><dd class=" odd"><p>Update the table using an Ajax call</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnAjaxUpdateDraw">_fnAjaxUpdateDraw</a></span><span class="type-sig"><span class="signature">(oSettings, json)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Data the data from the server (nuking the old) and redraw the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnApplyColumnDefs">_fnApplyColumnDefs</a></span><span class="type-sig"><span class="signature">(oSettings, aoColDefs, aoCols, fn)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Take the column definitions and static columns arrays and calculate how they relate to column indexes. The callback function will then apply the definition found for a column to a suitable configuration object.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnApplyToChildren">_fnApplyToChildren</a></span><span class="type-sig"><span class="signature">(fn, array, array)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Apply a given function to the display child nodes of an element array (typically TD children of TR rows</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnBindAction">_fnBindAction</a></span><span class="type-sig"><span class="signature">(n, oData, fn)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Bind an event handers to allow a click or return key to activate the callback. This is good for accessibility since a return on the keyboard will have the same effect as a click, if the element has focus.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnBrowserDetect">_fnBrowserDetect</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>From some browsers (specifically IE6/7) we need special handling to work around browser bugs - this function is used to detect when these workarounds are needed.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnBuildHead">_fnBuildHead</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Create the HTML header for the table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnBuildSearchArray">_fnBuildSearchArray</a></span><span class="type-sig"><span class="signature">(oSettings, iMaster)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Create an array which can be quickly search through</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnBuildSearchRow">_fnBuildSearchRow</a></span><span class="type-sig"><span class="signature">(oSettings, aData)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Create a searchable string from a single data row</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnCalculateColumnWidths">_fnCalculateColumnWidths</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Calculate the width of columns for the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnCalculateEnd">_fnCalculateEnd</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Recalculate the end point based on the start point</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnCallbackFire">_fnCallbackFire</a></span><span class="type-sig"><span class="signature">(oSettings, sStore, sTrigger, aArgs)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Fire callback functions and trigger events. Note that the loop over the callback array store is done backwards! Further note that you do not want to fire off triggers in time sensitive applications (for example cell creation) as its slow.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnCallbackReg">_fnCallbackReg</a></span><span class="type-sig"><span class="signature">(oSettings, sStore, fn, sName)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Register a callback function. Easily allows a callback function to be added to an array store of callback functions that can then all be called together.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnClearTable">_fnClearTable</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Nuke the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnColumnIndexToVisible">_fnColumnIndexToVisible</a></span><span class="type-sig"><span class="signature">(iMatch, oSettings)</span><span class="type-signature"> → {int}</span></span></dt><dd class=" odd"><p>Covert the index of an index in the data array and convert it to the visible column index (take account of hidden columns)</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnColumnOptions">_fnColumnOptions</a></span><span class="type-sig"><span class="signature">(oSettings, iCol, oOptions)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Apply options for a column</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnColumnOrdering">_fnColumnOrdering</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {string}</span></span></dt><dd class=" odd"><p>Get the column ordering that DataTables expects</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnConvertToWidth">_fnConvertToWidth</a></span><span class="type-sig"><span class="signature">(sWidth, nParent)</span><span class="type-signature"> → {int}</span></span></dt><dd class=" even"><p>Convert a CSS unit width to pixels (e.g. 2em)</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnCreateCookie">_fnCreateCookie</a></span><span class="type-sig"><span class="signature">(sName, sValue, iSecs, sBaseName, fnCallback)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Create a new cookie with a value to store the state of a table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnCreateTr">_fnCreateTr</a></span><span class="type-sig"><span class="signature">(oSettings, iRow)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Create a new TR element (and it's TD children) for a row</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnDataToSearch">_fnDataToSearch</a></span><span class="type-sig"><span class="signature">(sData, sType)</span><span class="type-signature"> → {string}</span></span></dt><dd class=" odd"><p>Convert raw data into something that the user can search on</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnDeleteIndex">_fnDeleteIndex</a></span><span class="type-sig"><span class="signature">(a, iTarget)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Take an array of integers (index array) and remove a target integer (value - not the key!)</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnDetectHeader">_fnDetectHeader</a></span><span class="type-sig"><span class="signature">(array, nThead)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Use the DOM source to create up an array of header cells. The idea here is to create a layout grid (array) of rows x columns, which contains a reference to the cell that that point in the grid (regardless of col/rowspan), such that any column / row could be removed and the new grid constructed</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnDetectType">_fnDetectType</a></span><span class="type-sig"><span class="signature">(sData)</span><span class="type-signature"> → {string}</span></span></dt><dd class=" even"><p>Get the sort type based on an input string</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnDraw">_fnDraw</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Insert the required TR nodes into the table for display</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnDrawHead">_fnDrawHead</a></span><span class="type-sig"><span class="signature">(oSettings, array, <span class="optional">bIncludeHidden</span>)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Draw the header (or footer) element based on the column visibility states. The methodology here is to use the layout array from _fnDetectHeader, modified for the instantaneous column visibility, to construct the new layout. The grid is traversed over cell at a time in a rows x columns grid fashion, although each cell insert can cover multiple elements in the grid - which is tracks using the aApplied array. Cell inserts in the grid will only occur where there isn't already a cell in that position.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnEscapeRegex">_fnEscapeRegex</a></span><span class="type-sig"><span class="signature">(sVal)</span><span class="type-signature"> → {string}</span></span></dt><dd class=" odd"><p>scape a string such that it can be used in a regular expression</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnExtend">_fnExtend</a></span><span class="type-sig"><span class="signature">(oOut, oExtender)</span><span class="type-signature"> → {object}</span></span></dt><dd class=" even"><p>Extend objects - very similar to jQuery.extend, but deep copy objects, and shallow copy arrays. The reason we need to do this, is that we don't want to deep copy array init values (such as aaSorting) since the dev wouldn't be able to override them, but we do want to deep copy arrays.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnExternApiFunc">_fnExternApiFunc</a></span><span class="type-sig"><span class="signature">(sFunc)</span><span class="type-signature"> → {function}</span></span></dt><dd class=" odd"><p>Create a wrapper function for exporting an internal functions to an external API.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnFeatureHtmlFilter">_fnFeatureHtmlFilter</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></dt><dd class=" even"><p>Generate the node required for filtering text</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnFeatureHtmlInfo">_fnFeatureHtmlInfo</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></dt><dd class=" odd"><p>Generate the node required for the info display</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnFeatureHtmlLength">_fnFeatureHtmlLength</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></dt><dd class=" even"><p>Generate the node required for user display length changing</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnFeatureHtmlPaginate">_fnFeatureHtmlPaginate</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></dt><dd class=" odd"><p>Generate the node required for default pagination</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnFeatureHtmlProcessing">_fnFeatureHtmlProcessing</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></dt><dd class=" even"><p>Generate the node required for the processing node</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnFeatureHtmlTable">_fnFeatureHtmlTable</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></dt><dd class=" odd"><p>Add any control elements for the table - specifically scrolling</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnFilter">_fnFilter</a></span><span class="type-sig"><span class="signature">(oSettings, sInput, iForce, bRegex, bSmart, bCaseInsensitive)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Filter the data table based on user input and draw the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnFilterColumn">_fnFilterColumn</a></span><span class="type-sig"><span class="signature">(oSettings, sInput, iColumn, bRegex, bSmart, bCaseInsensitive)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Filter the table on a per-column basis</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnFilterComplete">_fnFilterComplete</a></span><span class="type-sig"><span class="signature">(oSettings, oSearch, <span class="optional">iForce</span>)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Filter the table using both the global filter and column based filtering</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnFilterCreateSearch">_fnFilterCreateSearch</a></span><span class="type-sig"><span class="signature">(sSearch, bRegex, bSmart, bCaseInsensitive)</span><span class="type-signature"> → {RegExp}</span></span></dt><dd class=" odd"><p>Build a regular expression object suitable for searching a table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnFilterCustom">_fnFilterCustom</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Apply custom filtering functions</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnGatherData">_fnGatherData</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Read in the data from the target table from the DOM</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnGetCellData">_fnGetCellData</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, iCol, sSpecific)</span><span class="type-signature"> → {*}</span></span></dt><dd class=" even"><p>Get the data for a given cell from the internal cache, taking into account data mapping</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnGetColumns">_fnGetColumns</a></span><span class="type-sig"><span class="signature">(oSettings, sParam)</span><span class="type-signature"> → {array}</span></span></dt><dd class=" odd"><p>Get an array of column indexes that match a given property</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnGetDataMaster">_fnGetDataMaster</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Return an array with the full table data</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnGetMaxLenString">_fnGetMaxLenString</a></span><span class="type-sig"><span class="signature">(oSettings, iCol)</span><span class="type-signature"> → {string}</span></span></dt><dd class=" odd"><p>Get the maximum strlen for each data column</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnGetObjectDataFn">_fnGetObjectDataFn</a></span><span class="type-sig"><span class="signature">(mSource)</span><span class="type-signature"> → {function}</span></span></dt><dd class=" even"><p>Return a function that can be used to get data from a source object, taking into account the ability to use nested objects as a source</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnGetRowData">_fnGetRowData</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, sSpecific, aiColumns)</span><span class="type-signature"> → {array}</span></span></dt><dd class=" odd"><p>Get an array of data for a given row from the internal data cache</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnGetTdNodes">_fnGetTdNodes</a></span><span class="type-sig"><span class="signature">(oSettings, <span class="optional">iIndividualRow</span>)</span><span class="type-signature"> → {array}</span></span></dt><dd class=" even"><p>Return an flat array with all TD nodes for the table, or row</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnGetTrNodes">_fnGetTrNodes</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {array}</span></span></dt><dd class=" odd"><p>Return an array with the TR nodes for the table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnGetUniqueThs">_fnGetUniqueThs</a></span><span class="type-sig"><span class="signature">(oSettings, nHeader, aLayout)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Get an array of unique th elements, one for each column</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnGetWidestNode">_fnGetWidestNode</a></span><span class="type-sig"><span class="signature">(oSettings, iCol)</span><span class="type-signature"> → {node}</span></span></dt><dd class=" odd"><p>Get the widest node</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnInitComplete">_fnInitComplete</a></span><span class="type-sig"><span class="signature">(oSettings, <span class="optional">json</span>)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Draw the table for the first time, adding all required features</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnInitialise">_fnInitialise</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Draw the table for the first time, adding all required features</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnLanguageCompat">_fnLanguageCompat</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Language compatibility - when certain options are given, and others aren't, we need to duplicate the values over, in order to provide backwards compatibility with older language files.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnLoadState">_fnLoadState</a></span><span class="type-sig"><span class="signature">(oSettings, oInit)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Attempt to load a saved table state from a cookie</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnLog">_fnLog</a></span><span class="type-sig"><span class="signature">(oSettings, iLevel, sMesg)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Log an error message</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnMap">_fnMap</a></span><span class="type-sig"><span class="signature">(oRet, oSrc, sName, <span class="optional">sMappedName</span>)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>See if a property is defined on one object, if so assign it to the other object</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnNodeToColumnIndex">_fnNodeToColumnIndex</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, n)</span><span class="type-signature"> → {int}</span></span></dt><dd class=" even"><p>Take a TD element and convert it into a column data index (not the visible index)</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnNodeToDataIndex">_fnNodeToDataIndex</a></span><span class="type-sig"><span class="signature">(oSettings, n)</span><span class="type-signature"> → {int}</span></span></dt><dd class=" odd"><p>Take a TR element and convert it to an index in aoData</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnPageChange">_fnPageChange</a></span><span class="type-sig"><span class="signature">(oSettings, mAction)</span><span class="type-signature"> → {bool}</span></span></dt><dd class=" even"><p>Alter the display settings to change the page</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnProcessingDisplay">_fnProcessingDisplay</a></span><span class="type-sig"><span class="signature">(oSettings, bShow)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Display or hide the processing indicator</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnReadCookie">_fnReadCookie</a></span><span class="type-sig"><span class="signature">(sName)</span><span class="type-signature"> → {string}</span></span></dt><dd class=" even"><p>Read an old cookie to get a cookie with an old table state</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnReDraw">_fnReDraw</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Redraw the table - taking account of the various features which are enabled</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnRender">_fnRender</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, iCol)</span><span class="type-signature"> → {*}</span></span></dt><dd class=" even"><p>Call the developer defined fnRender function for a given cell (row/column) with the required parameters and return the result.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnReOrderIndex">_fnReOrderIndex</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Figure out how to reorder a display list</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnSaveState">_fnSaveState</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Save the state of a table in a cookie such that the page can be reloaded</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnScrollBarWidth">_fnScrollBarWidth</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"> → {int}</span></span></dt><dd class=" odd"><p>Get the width of a scroll bar in this browser being used</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnScrollDraw">_fnScrollDraw</a></span><span class="type-sig"><span class="signature">(o)</span><span class="type-signature"> → {node}</span></span></dt><dd class=" even"><p>Update the various tables for resizing. It's a bit of a pig this function, but basically the idea to: 1. Re-create the table inside the scrolling div 2. Take live measurements from the DOM 3. Apply the measurements 4. Clean up</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnScrollingWidthAdjust">_fnScrollingWidthAdjust</a></span><span class="type-sig"><span class="signature">(oSettings, n)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Adjust a table's width to take account of scrolling</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnServerParams">_fnServerParams</a></span><span class="type-sig"><span class="signature">(oSettings, array)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Add Ajax parameters from plug-ins</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnSetCellData">_fnSetCellData</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, iCol, val)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Set the value for a specific cell, into the internal data cache</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnSetObjectDataFn">_fnSetObjectDataFn</a></span><span class="type-sig"><span class="signature">(mSource)</span><span class="type-signature"> → {function}</span></span></dt><dd class=" even"><p>Return a function that can be used to set data from a source object, taking into account the ability to use nested objects as a source</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnSettingsFromNode">_fnSettingsFromNode</a></span><span class="type-sig"><span class="signature">(nTable)</span><span class="type-signature"> → {object}</span></span></dt><dd class=" odd"><p>Return the settings object for a particular table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnSort">_fnSort</a></span><span class="type-sig"><span class="signature">(oSettings, bApplyClasses)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Change the order of the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnSortAttachListener">_fnSortAttachListener</a></span><span class="type-sig"><span class="signature">(oSettings, nNode, iDataIndex, <span class="optional">fnCallback</span>)</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Attach a sort handler (click) to a node</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnSortingClasses">_fnSortingClasses</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Set the sorting classes on the header, Note: it is safe to call this function when bSort and bSortClasses are false</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnStringToCss">_fnStringToCss</a></span><span class="type-sig"><span class="signature">(aArray1, aArray2)</span><span class="type-signature"> → {int}</span></span></dt><dd class=" odd"><p>Append a CSS unit (only if required) to a string</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnUpdateInfo">_fnUpdateInfo</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Update the information elements in the display</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnVisbleColumns">_fnVisbleColumns</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {int}</span></span></dt><dd class=" odd"><p>Get the number of visible columns</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnVisibleToColumnIndex">_fnVisibleToColumnIndex</a></span><span class="type-sig"><span class="signature">(oSettings, iMatch)</span><span class="type-signature"> → {int}</span></span></dt><dd class=" even"><p>Covert the index of a visible column to the index in the data array (take account of hidden columns)</p></dd> </dl> </div> </div> <div class="doc_details"> <a name="details"></a> <h2>Details</h2> <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3> <dl> <dt class=" even"><a name="_fnJsonString"></a><a name="_fnJsonString_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_fnJsonString">_fnJsonString</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" even"><p>JSON stringify. If JSON.stringify it provided by the browser, json2.js or any other library, then we use that as it is fast, safe and accurate. If the function isn't available then we need to built it ourselves - the inspiration for this function comes from Craig Buckler ( <a href='http://www.sitepoint.com/javascript-json-serialization/'>http://www.sitepoint.com/javascript-json-serialization/</a> ). It is not perfect and absolutely should not be used as a replacement to json2.js - but it does do what we need, without requiring a dependency for DataTables.</p><div class="collapse_details"><dl class="details"> </dl> </div></dd> </dl></div><div class="doc_group"><a name="details_methods"></a><h3 class="subsection-title">Methods - static</h3> <dl> <dt id="DataTable#oApi._fnAddColumn" class=" even"><a name="_fnAddColumn"></a><a name="_fnAddColumn_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnAddColumn</a></span><span class="type-sig"><span class="signature">(oSettings, nTh)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Add a column to the list used for the table with default values</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">nTh</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The th element for this column</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnAddData" class=" odd"><a name="_fnAddData"></a><a name="_fnAddData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnAddData</a></span><span class="type-sig"><span class="signature">(oSettings, aData)</span><span class="type-signature"> → {int}</span></span></span></dt><dd class=" odd"><p>Add a data array to the table, creating DOM node etc. This is the parallel to _fnGatherData, but for adding rows from a Javascript source, rather than a DOM source.</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">aData</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>data array to be added</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><blockquote> <p>=0 if successful (index of new aoData entry), -1 if failed</p> </blockquote></p></div> <dt id="DataTable#oApi._fnAddOptionsHtml" class=" even"><a name="_fnAddOptionsHtml"></a><a name="_fnAddOptionsHtml_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnAddOptionsHtml</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Add the options to the page HTML for the table</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnAdjustColumnSizing" class=" odd"><a name="_fnAdjustColumnSizing"></a><a name="_fnAdjustColumnSizing_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnAdjustColumnSizing</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Adjust the table column widths for new data. Note: you would probably want to do a redraw after calling this function!</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnAjaxParameters" class=" even"><a name="_fnAjaxParameters"></a><a name="_fnAjaxParameters_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnAjaxParameters</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {bool}</span></span></span></dt><dd class=" even"><p>Build up the parameters in an object needed for a server-side processing request</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>block the table drawing or not</p></p></div> <dt id="DataTable#oApi._fnAjaxUpdate" class=" odd"><a name="_fnAjaxUpdate"></a><a name="_fnAjaxUpdate_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnAjaxUpdate</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {boolean}</span></span></span></dt><dd class=" odd"><p>Update the table using an Ajax call</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Block the table drawing or not</p></p></div> <dt id="DataTable#oApi._fnAjaxUpdateDraw" class=" even"><a name="_fnAjaxUpdateDraw"></a><a name="_fnAjaxUpdateDraw_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnAjaxUpdateDraw</a></span><span class="type-sig"><span class="signature">(oSettings, json)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Data the data from the server (nuking the old) and redraw the table</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">json</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>json data return from the server.</p></td></tr><tr><td class="number right_border"></td><td class="name">json.sEcho</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Tracking flag for DataTables to match requests</p></td></tr><tr><td class="number right_border"></td><td class="name">json.iTotalRecords</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Number of records in the data set, not accounting for filtering</p></td></tr><tr><td class="number right_border"></td><td class="name">json.iTotalDisplayRecords</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Number of records in the data set, accounting for filtering</p></td></tr><tr><td class="number right_border"></td><td class="name">json.aaData</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data to display on this page</p></td></tr><tr><td class="number right_border"></td><td class="name">json.sColumns</td><td class="type type-param">string</td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Column ordering (sName, comma separated)</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnApplyColumnDefs" class=" odd"><a name="_fnApplyColumnDefs"></a><a name="_fnApplyColumnDefs_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnApplyColumnDefs</a></span><span class="type-sig"><span class="signature">(oSettings, aoColDefs, aoCols, fn)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Take the column definitions and static columns arrays and calculate how they relate to column indexes. The callback function will then apply the definition found for a column to a suitable configuration object.</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">aoColDefs</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The aoColumnDefs array that is to be applied</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">aoCols</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The aoColumns array that defines columns individually</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">fn</td><td class="type type-param">function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Callback function - takes two parameters, the calculated column index and the definition for that column.</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnApplyToChildren" class=" even"><a name="_fnApplyToChildren"></a><a name="_fnApplyToChildren_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnApplyToChildren</a></span><span class="type-sig"><span class="signature">(fn, array, array)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Apply a given function to the display child nodes of an element array (typically TD children of TR rows</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">fn</td><td class="type type-param">function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Method to apply to the objects</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">array</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>{nodes} an1 List of elements to look through for display children</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">array</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>{nodes} an2 Another list (identical structure to the first) - optional</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnBindAction" class=" odd"><a name="_fnBindAction"></a><a name="_fnBindAction_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnBindAction</a></span><span class="type-sig"><span class="signature">(n, oData, fn)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Bind an event handers to allow a click or return key to activate the callback. This is good for accessibility since a return on the keyboard will have the same effect as a click, if the element has focus.</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">n</td><td class="type type-param">element</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Element to bind the action to</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oData</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Data object to pass to the triggered function</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">fn</td><td class="type type-param">function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Callback function for when the event is triggered</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnBrowserDetect" class=" even"><a name="_fnBrowserDetect"></a><a name="_fnBrowserDetect_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnBrowserDetect</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>From some browsers (specifically IE6/7) we need special handling to work around browser bugs - this function is used to detect when these workarounds are needed.</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnBuildHead" class=" odd"><a name="_fnBuildHead"></a><a name="_fnBuildHead_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnBuildHead</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Create the HTML header for the table</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnBuildSearchArray" class=" even"><a name="_fnBuildSearchArray"></a><a name="_fnBuildSearchArray_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnBuildSearchArray</a></span><span class="type-sig"><span class="signature">(oSettings, iMaster)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Create an array which can be quickly search through</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iMaster</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>use the master data array - optional</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnBuildSearchRow" class=" odd"><a name="_fnBuildSearchRow"></a><a name="_fnBuildSearchRow_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnBuildSearchRow</a></span><span class="type-sig"><span class="signature">(oSettings, aData)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Create a searchable string from a single data row</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">aData</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Row data array to use for the data to search</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnCalculateColumnWidths" class=" even"><a name="_fnCalculateColumnWidths"></a><a name="_fnCalculateColumnWidths_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnCalculateColumnWidths</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Calculate the width of columns for the table</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnCalculateEnd" class=" odd"><a name="_fnCalculateEnd"></a><a name="_fnCalculateEnd_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnCalculateEnd</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Recalculate the end point based on the start point</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnCallbackFire" class=" even"><a name="_fnCallbackFire"></a><a name="_fnCallbackFire_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnCallbackFire</a></span><span class="type-sig"><span class="signature">(oSettings, sStore, sTrigger, aArgs)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Fire callback functions and trigger events. Note that the loop over the callback array store is done backwards! Further note that you do not want to fire off triggers in time sensitive applications (for example cell creation) as its slow.</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sStore</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Name of the array storage for the callbacks in oSettings</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">sTrigger</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Name of the jQuery custom event to trigger. If null no trigger is fired</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">aArgs</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Array of arguments to pass to the callback function / trigger</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnCallbackReg" class=" odd"><a name="_fnCallbackReg"></a><a name="_fnCallbackReg_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnCallbackReg</a></span><span class="type-sig"><span class="signature">(oSettings, sStore, fn, sName)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Register a callback function. Easily allows a callback function to be added to an array store of callback functions that can then all be called together.</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sStore</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Name of the array storage for the callbacks in oSettings</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">fn</td><td class="type type-param">function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Function to be called back</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">sName</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Identifying name for the callback (i.e. a label)</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnClearTable" class=" even"><a name="_fnClearTable"></a><a name="_fnClearTable_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnClearTable</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Nuke the table</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnColumnIndexToVisible" class=" odd"><a name="_fnColumnIndexToVisible"></a><a name="_fnColumnIndexToVisible_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnColumnIndexToVisible</a></span><span class="type-sig"><span class="signature">(iMatch, oSettings)</span><span class="type-signature"> → {int}</span></span></span></dt><dd class=" odd"><p>Covert the index of an index in the data array and convert it to the visible column index (take account of hidden columns)</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">iMatch</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Column index to lookup</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>i the data index</p></p></div> <dt id="DataTable#oApi._fnColumnOptions" class=" even"><a name="_fnColumnOptions"></a><a name="_fnColumnOptions_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnColumnOptions</a></span><span class="type-sig"><span class="signature">(oSettings, iCol, oOptions)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Apply options for a column</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iCol</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>column index to consider</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">oOptions</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>object with sType, bVisible and bSearchable etc</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnColumnOrdering" class=" odd"><a name="_fnColumnOrdering"></a><a name="_fnColumnOrdering_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnColumnOrdering</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {string}</span></span></span></dt><dd class=" odd"><p>Get the column ordering that DataTables expects</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>comma separated list of names</p></p></div> <dt id="DataTable#oApi._fnConvertToWidth" class=" even"><a name="_fnConvertToWidth"></a><a name="_fnConvertToWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnConvertToWidth</a></span><span class="type-sig"><span class="signature">(sWidth, nParent)</span><span class="type-signature"> → {int}</span></span></span></dt><dd class=" even"><p>Convert a CSS unit width to pixels (e.g. 2em)</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sWidth</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>width to be converted</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">nParent</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>parent to get the with for (required for relative widths) - optional</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>iWidth width in pixels</p></p></div> <dt id="DataTable#oApi._fnCreateCookie" class=" odd"><a name="_fnCreateCookie"></a><a name="_fnCreateCookie_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnCreateCookie</a></span><span class="type-sig"><span class="signature">(sName, sValue, iSecs, sBaseName, fnCallback)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Create a new cookie with a value to store the state of a table</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sName</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>name of the cookie to create</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sValue</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>the value the cookie should take</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iSecs</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>duration of the cookie</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">sBaseName</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>sName is made up of the base + file name - this is the base</p></td></tr><tr class="even"><td class="number right_border"><div>5</div></td><td class="name">fnCallback</td><td class="type type-param">function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>User definable function to modify the cookie</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnCreateTr" class=" even"><a name="_fnCreateTr"></a><a name="_fnCreateTr_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnCreateTr</a></span><span class="type-sig"><span class="signature">(oSettings, iRow)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Create a new TR element (and it's TD children) for a row</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Row to consider</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnDataToSearch" class=" odd"><a name="_fnDataToSearch"></a><a name="_fnDataToSearch_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnDataToSearch</a></span><span class="type-sig"><span class="signature">(sData, sType)</span><span class="type-signature"> → {string}</span></span></span></dt><dd class=" odd"><p>Convert raw data into something that the user can search on</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sData</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>data to be modified</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sType</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>data type</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>search string</p></p></div> <dt id="DataTable#oApi._fnDeleteIndex" class=" even"><a name="_fnDeleteIndex"></a><a name="_fnDeleteIndex_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnDeleteIndex</a></span><span class="type-sig"><span class="signature">(a, iTarget)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Take an array of integers (index array) and remove a target integer (value - not the key!)</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">a</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Index array to target</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iTarget</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>value to find</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnDetectHeader" class=" odd"><a name="_fnDetectHeader"></a><a name="_fnDetectHeader_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnDetectHeader</a></span><span class="type-sig"><span class="signature">(array, nThead)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Use the DOM source to create up an array of header cells. The idea here is to create a layout grid (array) of rows x columns, which contains a reference to the cell that that point in the grid (regardless of col/rowspan), such that any column / row could be removed and the new grid constructed</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">array</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>{object} aLayout Array to store the calculated layout in</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">nThead</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The header/footer element for the table</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnDetectType" class=" even"><a name="_fnDetectType"></a><a name="_fnDetectType_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnDetectType</a></span><span class="type-sig"><span class="signature">(sData)</span><span class="type-signature"> → {string}</span></span></span></dt><dd class=" even"><p>Get the sort type based on an input string</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sData</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>data we wish to know the type of</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>type (defaults to 'string' if no type can be detected)</p></p></div> <dt id="DataTable#oApi._fnDraw" class=" odd"><a name="_fnDraw"></a><a name="_fnDraw_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnDraw</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Insert the required TR nodes into the table for display</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnDrawHead" class=" even"><a name="_fnDrawHead"></a><a name="_fnDrawHead_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnDrawHead</a></span><span class="type-sig"><span class="signature">(oSettings, array, <span class="optional">bIncludeHidden</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Draw the header (or footer) element based on the column visibility states. The methodology here is to use the layout array from _fnDetectHeader, modified for the instantaneous column visibility, to construct the new layout. The grid is traversed over cell at a time in a rows x columns grid fashion, although each cell insert can cover multiple elements in the grid - which is tracks using the aApplied array. Cell inserts in the grid will only occur where there isn't already a cell in that position.</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">array</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>{objects} aoSource Layout array from _fnDetectHeader</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">bIncludeHidden</td><td class="type type-param">boolean</td><td class="attributes">Optional</td><td class="default">false</td><td class="description last"><p>If true then include the hidden columns in the calc,</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnEscapeRegex" class=" odd"><a name="_fnEscapeRegex"></a><a name="_fnEscapeRegex_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnEscapeRegex</a></span><span class="type-sig"><span class="signature">(sVal)</span><span class="type-signature"> → {string}</span></span></span></dt><dd class=" odd"><p>scape a string such that it can be used in a regular expression</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sVal</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>string to escape</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>escaped string</p></p></div> <dt id="DataTable#oApi._fnExtend" class=" even"><a name="_fnExtend"></a><a name="_fnExtend_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnExtend</a></span><span class="type-sig"><span class="signature">(oOut, oExtender)</span><span class="type-signature"> → {object}</span></span></span></dt><dd class=" even"><p>Extend objects - very similar to jQuery.extend, but deep copy objects, and shallow copy arrays. The reason we need to do this, is that we don't want to deep copy array init values (such as aaSorting) since the dev wouldn't be able to override them, but we do want to deep copy arrays.</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oOut</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Object to extend</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oExtender</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Object from which the properties will be applied to oOut</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>oOut Reference, just for convenience - oOut === the return.</p></p></div> <dt id="DataTable#oApi._fnExternApiFunc" class=" odd"><a name="_fnExternApiFunc"></a><a name="_fnExternApiFunc_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnExternApiFunc</a></span><span class="type-sig"><span class="signature">(sFunc)</span><span class="type-signature"> → {function}</span></span></span></dt><dd class=" odd"><p>Create a wrapper function for exporting an internal functions to an external API.</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sFunc</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>API function name</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>wrapped function</p></p></div> <dt id="DataTable#oApi._fnFeatureHtmlFilter" class=" even"><a name="_fnFeatureHtmlFilter"></a><a name="_fnFeatureHtmlFilter_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnFeatureHtmlFilter</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></span></dt><dd class=" even"><p>Generate the node required for filtering text</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Filter control element</p></p></div> <dt id="DataTable#oApi._fnFeatureHtmlInfo" class=" odd"><a name="_fnFeatureHtmlInfo"></a><a name="_fnFeatureHtmlInfo_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnFeatureHtmlInfo</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></span></dt><dd class=" odd"><p>Generate the node required for the info display</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Information element</p></p></div> <dt id="DataTable#oApi._fnFeatureHtmlLength" class=" even"><a name="_fnFeatureHtmlLength"></a><a name="_fnFeatureHtmlLength_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnFeatureHtmlLength</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></span></dt><dd class=" even"><p>Generate the node required for user display length changing</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Display length feature node</p></p></div> <dt id="DataTable#oApi._fnFeatureHtmlPaginate" class=" odd"><a name="_fnFeatureHtmlPaginate"></a><a name="_fnFeatureHtmlPaginate_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnFeatureHtmlPaginate</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></span></dt><dd class=" odd"><p>Generate the node required for default pagination</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Pagination feature node</p></p></div> <dt id="DataTable#oApi._fnFeatureHtmlProcessing" class=" even"><a name="_fnFeatureHtmlProcessing"></a><a name="_fnFeatureHtmlProcessing_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnFeatureHtmlProcessing</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></span></dt><dd class=" even"><p>Generate the node required for the processing node</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Processing element</p></p></div> <dt id="DataTable#oApi._fnFeatureHtmlTable" class=" odd"><a name="_fnFeatureHtmlTable"></a><a name="_fnFeatureHtmlTable_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnFeatureHtmlTable</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {node}</span></span></span></dt><dd class=" odd"><p>Add any control elements for the table - specifically scrolling</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Node to add to the DOM</p></p></div> <dt id="DataTable#oApi._fnFilter" class=" even"><a name="_fnFilter"></a><a name="_fnFilter_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnFilter</a></span><span class="type-sig"><span class="signature">(oSettings, sInput, iForce, bRegex, bSmart, bCaseInsensitive)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Filter the data table based on user input and draw the table</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sInput</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>string to filter on</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iForce</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>optional - force a research of the master array (1) or not (undefined or 0)</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">bRegex</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>treat as a regular expression or not</p></td></tr><tr class="even"><td class="number right_border"><div>5</div></td><td class="name">bSmart</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>perform smart filtering or not</p></td></tr><tr class="odd"><td class="number right_border"><div>6</div></td><td class="name">bCaseInsensitive</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Do case insenstive matching or not</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnFilterColumn" class=" odd"><a name="_fnFilterColumn"></a><a name="_fnFilterColumn_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnFilterColumn</a></span><span class="type-sig"><span class="signature">(oSettings, sInput, iColumn, bRegex, bSmart, bCaseInsensitive)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Filter the table on a per-column basis</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sInput</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>string to filter on</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iColumn</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>column to filter</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">bRegex</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>treat search string as a regular expression or not</p></td></tr><tr class="even"><td class="number right_border"><div>5</div></td><td class="name">bSmart</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>use smart filtering or not</p></td></tr><tr class="odd"><td class="number right_border"><div>6</div></td><td class="name">bCaseInsensitive</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Do case insenstive matching or not</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnFilterComplete" class=" even"><a name="_fnFilterComplete"></a><a name="_fnFilterComplete_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnFilterComplete</a></span><span class="type-sig"><span class="signature">(oSettings, oSearch, <span class="optional">iForce</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Filter the table using both the global filter and column based filtering</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oSearch</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>search information</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iForce</td><td class="type type-param">int</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>force a research of the master array (1) or not (undefined or 0)</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnFilterCreateSearch" class=" odd"><a name="_fnFilterCreateSearch"></a><a name="_fnFilterCreateSearch_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnFilterCreateSearch</a></span><span class="type-sig"><span class="signature">(sSearch, bRegex, bSmart, bCaseInsensitive)</span><span class="type-signature"> → {RegExp}</span></span></span></dt><dd class=" odd"><p>Build a regular expression object suitable for searching a table</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sSearch</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>string to search for</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">bRegex</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>treat as a regular expression or not</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">bSmart</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>perform smart filtering or not</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">bCaseInsensitive</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Do case insensitive matching or not</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>constructed object</p></p></div> <dt id="DataTable#oApi._fnFilterCustom" class=" even"><a name="_fnFilterCustom"></a><a name="_fnFilterCustom_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnFilterCustom</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Apply custom filtering functions</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnGatherData" class=" odd"><a name="_fnGatherData"></a><a name="_fnGatherData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnGatherData</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Read in the data from the target table from the DOM</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnGetCellData" class=" even"><a name="_fnGetCellData"></a><a name="_fnGetCellData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnGetCellData</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, iCol, sSpecific)</span><span class="type-signature"> → {*}</span></span></span></dt><dd class=" even"><p>Get the data for a given cell from the internal cache, taking into account data mapping</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>aoData row id</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iCol</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Column index</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">sSpecific</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>data get type ('display', 'type' 'filter' 'sort')</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Cell data</p></p></div> <dt id="DataTable#oApi._fnGetColumns" class=" odd"><a name="_fnGetColumns"></a><a name="_fnGetColumns_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnGetColumns</a></span><span class="type-sig"><span class="signature">(oSettings, sParam)</span><span class="type-signature"> → {array}</span></span></span></dt><dd class=" odd"><p>Get an array of column indexes that match a given property</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sParam</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Parameter in aoColumns to look for - typically bVisible or bSearchable</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Array of indexes with matched properties</p></p></div> <dt id="DataTable#oApi._fnGetDataMaster" class=" even"><a name="_fnGetDataMaster"></a><a name="_fnGetDataMaster_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnGetDataMaster</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Return an array with the full table data</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>array {array} aData Master data array</p></p></div> <dt id="DataTable#oApi._fnGetMaxLenString" class=" odd"><a name="_fnGetMaxLenString"></a><a name="_fnGetMaxLenString_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnGetMaxLenString</a></span><span class="type-sig"><span class="signature">(oSettings, iCol)</span><span class="type-signature"> → {string}</span></span></span></dt><dd class=" odd"><p>Get the maximum strlen for each data column</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iCol</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>column of interest</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>max string length for each column</p></p></div> <dt id="DataTable#oApi._fnGetObjectDataFn" class=" even"><a name="_fnGetObjectDataFn"></a><a name="_fnGetObjectDataFn_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnGetObjectDataFn</a></span><span class="type-sig"><span class="signature">(mSource)</span><span class="type-signature"> → {function}</span></span></span></dt><dd class=" even"><p>Return a function that can be used to get data from a source object, taking into account the ability to use nested objects as a source</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">mSource</td><td class="type type-param">string | int | function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data source for the object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Data get function</p></p></div> <dt id="DataTable#oApi._fnGetRowData" class=" odd"><a name="_fnGetRowData"></a><a name="_fnGetRowData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnGetRowData</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, sSpecific, aiColumns)</span><span class="type-signature"> → {array}</span></span></span></dt><dd class=" odd"><p>Get an array of data for a given row from the internal data cache</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>aoData row id</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">sSpecific</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>data get type ('type' 'filter' 'sort')</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">aiColumns</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Array of column indexes to get data from</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Data array</p></p></div> <dt id="DataTable#oApi._fnGetTdNodes" class=" even"><a name="_fnGetTdNodes"></a><a name="_fnGetTdNodes_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnGetTdNodes</a></span><span class="type-sig"><span class="signature">(oSettings, <span class="optional">iIndividualRow</span>)</span><span class="type-signature"> → {array}</span></span></span></dt><dd class=" even"><p>Return an flat array with all TD nodes for the table, or row</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iIndividualRow</td><td class="type type-param">int</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>aoData index to get the nodes for - optional if not given then the return array will contain all nodes for the table</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>TD array</p></p></div> <dt id="DataTable#oApi._fnGetTrNodes" class=" odd"><a name="_fnGetTrNodes"></a><a name="_fnGetTrNodes_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnGetTrNodes</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {array}</span></span></span></dt><dd class=" odd"><p>Return an array with the TR nodes for the table</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>TR array</p></p></div> <dt id="DataTable#oApi._fnGetUniqueThs" class=" even"><a name="_fnGetUniqueThs"></a><a name="_fnGetUniqueThs_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnGetUniqueThs</a></span><span class="type-sig"><span class="signature">(oSettings, nHeader, aLayout)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Get an array of unique th elements, one for each column</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">nHeader</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>automatically detect the layout from this node - optional</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">aLayout</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>thead/tfoot layout from _fnDetectHeader - optional</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>array {node} aReturn list of unique th's</p></p></div> <dt id="DataTable#oApi._fnGetWidestNode" class=" odd"><a name="_fnGetWidestNode"></a><a name="_fnGetWidestNode_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnGetWidestNode</a></span><span class="type-sig"><span class="signature">(oSettings, iCol)</span><span class="type-signature"> → {node}</span></span></span></dt><dd class=" odd"><p>Get the widest node</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iCol</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>column of interest</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>widest table node</p></p></div> <dt id="DataTable#oApi._fnInitComplete" class=" even"><a name="_fnInitComplete"></a><a name="_fnInitComplete_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnInitComplete</a></span><span class="type-sig"><span class="signature">(oSettings, <span class="optional">json</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Draw the table for the first time, adding all required features</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">json</td><td class="type type-param">object</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>JSON from the server that completed the table, if using Ajax source with client-side processing (optional)</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnInitialise" class=" odd"><a name="_fnInitialise"></a><a name="_fnInitialise_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnInitialise</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Draw the table for the first time, adding all required features</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnLanguageCompat" class=" even"><a name="_fnLanguageCompat"></a><a name="_fnLanguageCompat_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnLanguageCompat</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Language compatibility - when certain options are given, and others aren't, we need to duplicate the values over, in order to provide backwards compatibility with older language files.</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnLoadState" class=" odd"><a name="_fnLoadState"></a><a name="_fnLoadState_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnLoadState</a></span><span class="type-sig"><span class="signature">(oSettings, oInit)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Attempt to load a saved table state from a cookie</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oInit</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables init object so we can override settings</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnLog" class=" even"><a name="_fnLog"></a><a name="_fnLog_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnLog</a></span><span class="type-sig"><span class="signature">(oSettings, iLevel, sMesg)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Log an error message</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iLevel</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>log error messages, or display them to the user</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">sMesg</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>error message</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnMap" class=" odd"><a name="_fnMap"></a><a name="_fnMap_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnMap</a></span><span class="type-sig"><span class="signature">(oRet, oSrc, sName, <span class="optional">sMappedName</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>See if a property is defined on one object, if so assign it to the other object</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oRet</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>target object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oSrc</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>source object</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">sName</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>property</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">sMappedName</td><td class="type type-param">string</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>name to map too - optional, sName used if not given</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnNodeToColumnIndex" class=" even"><a name="_fnNodeToColumnIndex"></a><a name="_fnNodeToColumnIndex_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnNodeToColumnIndex</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, n)</span><span class="type-signature"> → {int}</span></span></span></dt><dd class=" even"><p>Take a TD element and convert it into a column data index (not the visible index)</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The row number the TD/TH can be found in</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">n</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The TD/TH element to find</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>index if the node is found, -1 if not</p></p></div> <dt id="DataTable#oApi._fnNodeToDataIndex" class=" odd"><a name="_fnNodeToDataIndex"></a><a name="_fnNodeToDataIndex_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnNodeToDataIndex</a></span><span class="type-sig"><span class="signature">(oSettings, n)</span><span class="type-signature"> → {int}</span></span></span></dt><dd class=" odd"><p>Take a TR element and convert it to an index in aoData</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">n</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>the TR element to find</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>index if the node is found, null if not</p></p></div> <dt id="DataTable#oApi._fnPageChange" class=" even"><a name="_fnPageChange"></a><a name="_fnPageChange_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnPageChange</a></span><span class="type-sig"><span class="signature">(oSettings, mAction)</span><span class="type-signature"> → {bool}</span></span></span></dt><dd class=" even"><p>Alter the display settings to change the page</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">mAction</td><td class="type type-param">string | int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Paging action to take: "first", "previous", "next" or "last" or page number to jump to (integer)</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>true page has changed, false - no change (no effect) eg 'first' on page 1</p></p></div> <dt id="DataTable#oApi._fnProcessingDisplay" class=" odd"><a name="_fnProcessingDisplay"></a><a name="_fnProcessingDisplay_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnProcessingDisplay</a></span><span class="type-sig"><span class="signature">(oSettings, bShow)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Display or hide the processing indicator</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">bShow</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Show the processing indicator (true) or not (false)</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnReadCookie" class=" even"><a name="_fnReadCookie"></a><a name="_fnReadCookie_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnReadCookie</a></span><span class="type-sig"><span class="signature">(sName)</span><span class="type-signature"> → {string}</span></span></span></dt><dd class=" even"><p>Read an old cookie to get a cookie with an old table state</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sName</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>name of the cookie to read</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>contents of the cookie - or null if no cookie with that name found</p></p></div> <dt id="DataTable#oApi._fnReDraw" class=" odd"><a name="_fnReDraw"></a><a name="_fnReDraw_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnReDraw</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Redraw the table - taking account of the various features which are enabled</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnRender" class=" even"><a name="_fnRender"></a><a name="_fnRender_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnRender</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, iCol)</span><span class="type-signature"> → {*}</span></span></span></dt><dd class=" even"><p>Call the developer defined fnRender function for a given cell (row/column) with the required parameters and return the result.</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>aoData index for the row</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iCol</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>aoColumns index for the column</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Return of the developer's fnRender function</p></p></div> <dt id="DataTable#oApi._fnReOrderIndex" class=" odd"><a name="_fnReOrderIndex"></a><a name="_fnReOrderIndex_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnReOrderIndex</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Figure out how to reorder a display list</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>array {int} aiReturn index list for reordering</p></p></div> <dt id="DataTable#oApi._fnSaveState" class=" even"><a name="_fnSaveState"></a><a name="_fnSaveState_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnSaveState</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Save the state of a table in a cookie such that the page can be reloaded</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnScrollBarWidth" class=" odd"><a name="_fnScrollBarWidth"></a><a name="_fnScrollBarWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnScrollBarWidth</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"> → {int}</span></span></span></dt><dd class=" odd"><p>Get the width of a scroll bar in this browser being used</p><div class="collapse_details"><dl class="details"> </dl> <h5>Returns:</h5><p class="returns"><p>width in pixels</p></p></div> <dt id="DataTable#oApi._fnScrollDraw" class=" even"><a name="_fnScrollDraw"></a><a name="_fnScrollDraw_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnScrollDraw</a></span><span class="type-sig"><span class="signature">(o)</span><span class="type-signature"> → {node}</span></span></span></dt><dd class=" even"><p>Update the various tables for resizing. It's a bit of a pig this function, but basically the idea to: 1. Re-create the table inside the scrolling div 2. Take live measurements from the DOM 3. Apply the measurements 4. Clean up</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">o</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Node to add to the DOM</p></p></div> <dt id="DataTable#oApi._fnScrollingWidthAdjust" class=" odd"><a name="_fnScrollingWidthAdjust"></a><a name="_fnScrollingWidthAdjust_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnScrollingWidthAdjust</a></span><span class="type-sig"><span class="signature">(oSettings, n)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Adjust a table's width to take account of scrolling</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">n</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>table node</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnServerParams" class=" even"><a name="_fnServerParams"></a><a name="_fnServerParams_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnServerParams</a></span><span class="type-sig"><span class="signature">(oSettings, array)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Add Ajax parameters from plug-ins</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">array</td><td class="type type-param"></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>{objects} aoData name/value pairs to send to the server</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnSetCellData" class=" odd"><a name="_fnSetCellData"></a><a name="_fnSetCellData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnSetCellData</a></span><span class="type-sig"><span class="signature">(oSettings, iRow, iCol, val)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Set the value for a specific cell, into the internal data cache</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>aoData row id</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iCol</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Column index</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">val</td><td class="type type-param">*</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Value to set</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnSetObjectDataFn" class=" even"><a name="_fnSetObjectDataFn"></a><a name="_fnSetObjectDataFn_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnSetObjectDataFn</a></span><span class="type-sig"><span class="signature">(mSource)</span><span class="type-signature"> → {function}</span></span></span></dt><dd class=" even"><p>Return a function that can be used to set data from a source object, taking into account the ability to use nested objects as a source</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">mSource</td><td class="type type-param">string | int | function</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data source for the object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Data set function</p></p></div> <dt id="DataTable#oApi._fnSettingsFromNode" class=" odd"><a name="_fnSettingsFromNode"></a><a name="_fnSettingsFromNode_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnSettingsFromNode</a></span><span class="type-sig"><span class="signature">(nTable)</span><span class="type-signature"> → {object}</span></span></span></dt><dd class=" odd"><p>Return the settings object for a particular table</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nTable</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>table we are using as a dataTable</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>Settings object - or null if not found</p></p></div> <dt id="DataTable#oApi._fnSort" class=" even"><a name="_fnSort"></a><a name="_fnSort_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnSort</a></span><span class="type-sig"><span class="signature">(oSettings, bApplyClasses)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Change the order of the table</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">bApplyClasses</td><td class="type type-param">bool</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>optional - should we apply classes or not</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnSortAttachListener" class=" odd"><a name="_fnSortAttachListener"></a><a name="_fnSortAttachListener_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnSortAttachListener</a></span><span class="type-sig"><span class="signature">(oSettings, nNode, iDataIndex, <span class="optional">fnCallback</span>)</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Attach a sort handler (click) to a node</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">nNode</td><td class="type type-param">node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>node to attach the handler to</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iDataIndex</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>column sorting index</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">fnCallback</td><td class="type type-param">function</td><td class="attributes">Optional</td><td class="default"></td><td class="description last"><p>callback function</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnSortingClasses" class=" even"><a name="_fnSortingClasses"></a><a name="_fnSortingClasses_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnSortingClasses</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Set the sorting classes on the header, Note: it is safe to call this function when bSort and bSortClasses are false</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnStringToCss" class=" odd"><a name="_fnStringToCss"></a><a name="_fnStringToCss_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnStringToCss</a></span><span class="type-sig"><span class="signature">(aArray1, aArray2)</span><span class="type-signature"> → {int}</span></span></span></dt><dd class=" odd"><p>Append a CSS unit (only if required) to a string</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">aArray1</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>first array</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">aArray2</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>second array</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>0 if match, 1 if length is different, 2 if no match</p></p></div> <dt id="DataTable#oApi._fnUpdateInfo" class=" even"><a name="_fnUpdateInfo"></a><a name="_fnUpdateInfo_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnUpdateInfo</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Update the information elements in the display</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table></div> <dt id="DataTable#oApi._fnVisbleColumns" class=" odd"><a name="_fnVisbleColumns"></a><a name="_fnVisbleColumns_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnVisbleColumns</a></span><span class="type-sig"><span class="signature">(oSettings)</span><span class="type-signature"> → {int}</span></span></span></dt><dd class=" odd"><p>Get the number of visible columns</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>i the number of visible columns</p></p></div> <dt id="DataTable#oApi._fnVisibleToColumnIndex" class=" even"><a name="_fnVisibleToColumnIndex"></a><a name="_fnVisibleToColumnIndex_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>_fnVisibleToColumnIndex</a></span><span class="type-sig"><span class="signature">(oSettings, iMatch)</span><span class="type-signature"> → {int}</span></span></span></dt><dd class=" even"><p>Covert the index of a visible column to the index in the data array (take account of hidden columns)</p><div class="collapse_details"><dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th width="20"></th> <th width="12%" class="bottom_border name">Name</th> <th width="10%" class="bottom_border">Type</th> <th width="10%" class="bottom_border">Attributes</th> <th width="10%" class="bottom_border">Default</th> <th class="last bottom_border">Description</th> </tr> </thead> <tbody> <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>dataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">iMatch</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Visible column index to lookup</p></td></tr> </tbody> </table><h5>Returns:</h5><p class="returns"><p>i the data index</p></p></div> </dd> </div> </div> </div> <div class="fw_footer"> DataTables: Copyright 2008-2012 Allan Jardine, all rights reserved<br> Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on 23th Sep 2012 - 14:27 with the <a href="http://datatables.net/">DataTables</a> template. </div> </body> </html>