First Initial
This commit is contained in:
Nakorn Rientrakrunchai
1972
wwwroot/BackendScript/assets/advanced-datatable/docs/34cdb56b2c.html
Normal file
1972
wwwroot/BackendScript/assets/advanced-datatable/docs/34cdb56b2c.html
Normal file
File diff suppressed because one or more lines are too long
@@ -0,0 +1,912 @@
|
||||
<!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: columns - 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: columns</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.defaults.html">.defaults</a>.</span> » columns</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 (21)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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 (21)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Column options that can be given to DataTables at initialisation time.</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="#aDataSort">aDataSort</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Allows a column's sorting to take multiple columns into account when
|
||||
doing a sort. For example first name / last name columns make sense to
|
||||
do a multi-column sort over the two columns.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asSorting">asSorting</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>You can control the default sorting direction, and even alter the behaviour
|
||||
of the sort handler (i.e. only allow ascending sorting etc) using this
|
||||
parameter.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSearchable">bSearchable</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Enable or disable filtering on the data in this column.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSortable">bSortable</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Enable or disable sorting on this column.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bUseRendered">bUseRendered</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p><code>Deprecated</code> When using fnRender() for a column, you may wish
|
||||
to use the original data (before rendering) for sorting and filtering
|
||||
(the default is to used the rendered data that the user can see). This
|
||||
may be useful for dates etc. [<a href-"#bUseRendered">...</a>] </p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bVisible">bVisible</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Enable or disable the display of this column.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnCreatedCell">fnCreatedCell</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" even"><p>Developer definable function that is called whenever a cell is created (Ajax source,
|
||||
etc) or processed for input (DOM source). This can be used as a compliment to mRender
|
||||
allowing you to modify the DOM element (add background colour for example) when the
|
||||
element is available.</p></dd><dt class=" odd"><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="type-signature"> :function</span></span></dt><dd class=" odd"><p><code>Deprecated</code> Custom display function that will be called for the
|
||||
display of each cell in this column. [<a href-"#fnRender">...</a>] </p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iDataSort">iDataSort</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>The column index (starting from 0!) that you wish a sort to be performed
|
||||
upon when this column is selected for sorting. This can be used for sorting
|
||||
on hidden columns for example.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#mData">mData</a></span><span class="type-sig"><span class="type-signature"> :string|int|function|null</span></span></dt><dd class=" odd"><p>This property can be used to read data from any JSON data source property,
|
||||
including deeply nested objects / properties. mData can be given in a
|
||||
number of different ways which effect its behaviour:
|
||||
<ul>
|
||||
<li>integer - treated as an array index for the data source. This is the
|
||||
default that DataTables uses (incrementally increased for each column).</li>
|
||||
<li>string - read an object property from the data source. Note that you can
|
||||
use Javascript dotted notation to read deep properties / arrays from the
|
||||
data source.</li>
|
||||
<li>null - the sDefaultContent option will be used for the cell (null
|
||||
by default, so you will need to specify the default content you want -
|
||||
typically an empty string). This can be useful on generated columns such
|
||||
as edit / delete action columns.</li>
|
||||
<li>function - the function given will be executed whenever DataTables
|
||||
needs to set or get the data for a cell in the column. The function
|
||||
takes three parameters:
|
||||
<ul>
|
||||
<li>{array|object} The data source for the row</li>
|
||||
<li>{string} The type call data requested - this will be 'set' when
|
||||
setting data or 'filter', 'display', 'type', 'sort' or undefined when
|
||||
gathering data. Note that when <i>undefined</i> is given for the type
|
||||
DataTables expects to get the raw data for the object back</li>
|
||||
<li>{*} Data to set when the second parameter is 'set'.</li>
|
||||
</ul>
|
||||
The return value from the function is not required when 'set' is the type
|
||||
of call, but otherwise the return is what will be used for the data
|
||||
requested.</li>
|
||||
</ul> [<a href-"#mData">...</a>] </p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#mDataProp">mDataProp</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" even"><p>This parameter has been replaced by mData in DataTables to ensure naming
|
||||
consistency. mDataProp can still be used, as there is backwards compatibility
|
||||
in DataTables for this option, but it is strongly recommended that you use
|
||||
mData in preference to mDataProp.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#mRender">mRender</a></span><span class="type-sig"><span class="type-signature"> :string|int|function|null</span></span></dt><dd class=" odd"><p>This property is the rendering partner to mData and it is suggested that
|
||||
when you want to manipulate data for display (including filtering, sorting etc)
|
||||
but not altering the underlying data for the table, use this property. mData
|
||||
can actually do everything this property can and more, but this parameter is
|
||||
easier to use since there is no 'set' option. Like mData is can be given
|
||||
in a number of different ways to effect its behaviour, with the addition of
|
||||
supporting array syntax for easy outputting of arrays (including arrays of
|
||||
objects):
|
||||
<ul>
|
||||
<li>integer - treated as an array index for the data source. This is the
|
||||
default that DataTables uses (incrementally increased for each column).</li>
|
||||
<li>string - read an object property from the data source. Note that you can
|
||||
use Javascript dotted notation to read deep properties / arrays from the
|
||||
data source and also array brackets to indicate that the data reader should
|
||||
loop over the data source array. When characters are given between the array
|
||||
brackets, these characters are used to join the data source array together.
|
||||
For example: "accounts[, ].name" would result in a comma separated list with
|
||||
the 'name' value from the 'accounts' array of objects.</li>
|
||||
<li>function - the function given will be executed whenever DataTables
|
||||
needs to set or get the data for a cell in the column. The function
|
||||
takes three parameters:
|
||||
<ul>
|
||||
<li>{array|object} The data source for the row (based on mData)</li>
|
||||
<li>{string} The type call data requested - this will be 'filter', 'display',
|
||||
'type' or 'sort'.</li>
|
||||
<li>{array|object} The full data source for the row (not based on mData)</li>
|
||||
</ul>
|
||||
The return value from the function is what will be used for the data
|
||||
requested.</li>
|
||||
</ul></p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sCellType">sCellType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Change the cell type created for the column - either TD cells or TH cells. This
|
||||
can be useful as TH cells have semantic meaning in the table body, allowing them
|
||||
to act as a header for a row (you may wish to add scope='row' to the TH elements).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sClass">sClass</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Class to give to each cell in this column.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sContentPadding">sContentPadding</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>When DataTables calculates the column widths to assign to each column,
|
||||
it finds the longest string in each column and then constructs a
|
||||
temporary table and reads the widths from that. The problem with this
|
||||
is that "mmm" is much wider then "iiii", but the latter is a longer
|
||||
string - thus the calculation can go wrong (doing it properly and putting
|
||||
it into an DOM object and measuring that is horribly(!) slow). Thus as
|
||||
a "work around" we provide this option. It will append its value to the
|
||||
text that is found to be the longest string for the column - i.e. padding.
|
||||
Generally you shouldn't need this, and it is not documented on the
|
||||
general DataTables.net documentation</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sDefaultContent">sDefaultContent</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Allows a default value to be given for a column's data, and will be used
|
||||
whenever a null data source is encountered (this can be because mData
|
||||
is set to null, or because the data source itself is null).</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sName">sName</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>This parameter is only used in DataTables' server-side processing. It can
|
||||
be exceptionally useful to know what columns are being displayed on the
|
||||
client side, and to map these to database fields. When defined, the names
|
||||
also allow DataTables to reorder information from the server if it comes
|
||||
back in an unexpected order (i.e. if you switch your columns around on the
|
||||
client-side, your server-side code does not also need updating).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSortDataType">sSortDataType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Defines a data source type for the sorting which can be used to read
|
||||
real-time information from the table (updating the internally cached
|
||||
version) prior to sorting. This allows sorting to occur on user editable
|
||||
elements such as form inputs.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sTitle">sTitle</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>The title of this column.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sType">sType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>The type allows you to specify how the data for this column will be sorted.
|
||||
Four types (string, numeric, date and html (which will strip HTML tags
|
||||
before sorting)) are currently available. Note that only date formats
|
||||
understood by Javascript's Date() object will be accepted as type date. For
|
||||
example: "Mar 26, 2008 5:03 PM". May take the values: 'string', 'numeric',
|
||||
'date' or 'html' (by default). Further types can be adding through
|
||||
plug-ins.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sWidth">sWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Defining the width of the column, this parameter may take any CSS value
|
||||
(3em, 20px etc). DataTables apples 'smart' widths to columns which have not
|
||||
been given a specific width through this interface ensuring that the table
|
||||
remains readable.</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="aDataSort"></a><a name="aDataSort_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aDataSort">aDataSort</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Allows a column's sorting to take multiple columns into account when
|
||||
doing a sort. For example first name / last name columns make sense to
|
||||
do a multi-column sort over the two columns.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{ "aDataSort": [ 0, 1 ], "aTargets": [ 0 ] },
|
||||
{ "aDataSort": [ 1, 0 ], "aTargets": [ 1 ] },
|
||||
{ "aDataSort": [ 2, 3, 4 ], "aTargets": [ 2 ] }
|
||||
]
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
{ "aDataSort": [ 0, 1 ] },
|
||||
{ "aDataSort": [ 1, 0 ] },
|
||||
{ "aDataSort": [ 2, 3, 4 ] },
|
||||
null,
|
||||
null
|
||||
]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="asSorting"></a><a name="asSorting_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asSorting">asSorting</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>You can control the default sorting direction, and even alter the behaviour
|
||||
of the sort handler (i.e. only allow ascending sorting etc) using this
|
||||
parameter.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{ "asSorting": [ "asc" ], "aTargets": [ 1 ] },
|
||||
{ "asSorting": [ "desc", "asc", "asc" ], "aTargets": [ 2 ] },
|
||||
{ "asSorting": [ "desc" ], "aTargets": [ 3 ] }
|
||||
]
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
null,
|
||||
{ "asSorting": [ "asc" ] },
|
||||
{ "asSorting": [ "desc", "asc", "asc" ] },
|
||||
{ "asSorting": [ "desc" ] },
|
||||
null
|
||||
]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="bSearchable"></a><a name="bSearchable_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSearchable">bSearchable</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Enable or disable filtering on the data in this column.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{ "bSearchable": false, "aTargets": [ 0 ] }
|
||||
] } );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
{ "bSearchable": false },
|
||||
null,
|
||||
null,
|
||||
null,
|
||||
null
|
||||
] } );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="bSortable"></a><a name="bSortable_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSortable">bSortable</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Enable or disable sorting on this column.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{ "bSortable": false, "aTargets": [ 0 ] }
|
||||
] } );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
{ "bSortable": false },
|
||||
null,
|
||||
null,
|
||||
null,
|
||||
null
|
||||
] } );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="bUseRendered"></a><a name="bUseRendered_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bUseRendered">bUseRendered</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p><code>Deprecated</code> When using fnRender() for a column, you may wish
|
||||
to use the original data (before rendering) for sorting and filtering
|
||||
(the default is to used the rendered data that the user can see). This
|
||||
may be useful for dates etc.</p>
|
||||
|
||||
<p>Please note that this option has now been deprecated and will be removed
|
||||
in the next version of DataTables. Please use mRender / mData rather than
|
||||
fnRender.</p><div class="collapse_details"><dl class="details">
|
||||
<dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bVisible"></a><a name="bVisible_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bVisible">bVisible</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Enable or disable the display of this column.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{ "bVisible": false, "aTargets": [ 0 ] }
|
||||
] } );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
{ "bVisible": false },
|
||||
null,
|
||||
null,
|
||||
null,
|
||||
null
|
||||
] } );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt id="DataTable.defaults.columns.fnCreatedCell" class=" even"><a name="fnCreatedCell"></a><a name="fnCreatedCell_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnCreatedCell</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" even"><p>Developer definable function that is called whenever a cell is created (Ajax source,
|
||||
etc) or processed for input (DOM source). This can be used as a compliment to mRender
|
||||
allowing you to modify the DOM element (add background colour for example) when the
|
||||
element is available.</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">nTd</td><td class="type type-param">element</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The TD node that has been created</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sData</td><td class="type type-param">*</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The Data for the cell</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">oData</td><td class="type type-param">array | object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data for the whole row</p></td></tr><tr class="odd"><td class="number right_border"><div>4</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 index for the aoData data store</p></td></tr><tr class="even"><td class="number right_border"><div>5</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>The column index for aoColumns</p></td></tr>
|
||||
</tbody>
|
||||
</table><h5>Example:</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [ {
|
||||
"aTargets": [3],
|
||||
"fnCreatedCell": function (nTd, sData, oData, iRow, iCol) {
|
||||
if ( sData == "1.7" ) {
|
||||
$(nTd).css('color', 'blue')
|
||||
}
|
||||
}
|
||||
} ]
|
||||
});
|
||||
} );</pre>
|
||||
</div>
|
||||
</div>
|
||||
<dt id="DataTable.defaults.columns.fnRender" class=" odd"><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="type-signature"> :function</span></span></span></dt><dd class=" odd"><p><code>Deprecated</code> Custom display function that will be called for the
|
||||
display of each cell in this column.</p>
|
||||
|
||||
<p>Please note that this option has now been deprecated and will be removed
|
||||
in the next version of DataTables. Please use mRender / mData rather than
|
||||
fnRender.</p><div class="collapse_details"><dl class="details">
|
||||
<dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
|
||||
</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>Object with the following parameters:</p></td></tr><tr><td class="number right_border"></td><td class="name">o.iDataRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The row in aoData</p></td></tr><tr><td class="number right_border"></td><td class="name">o.iDataColumn</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The column in question</p></td></tr><tr><td class="number right_border"></td><td class="name">o.aData</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data for the row in question</p></td></tr><tr><td class="number right_border"></td><td class="name">o.oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The settings object for this DataTables instance</p></td></tr><tr><td class="number right_border"></td><td class="name">o.mDataProp</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data property used for this column</p></td></tr><tr class="even"><td class="number right_border"><div>7</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>The current cell value</p></td></tr>
|
||||
</tbody>
|
||||
</table><h5>Returns:</h5><p class="returns"><p>The string you which to use in the display</p></p></div>
|
||||
<dt class=" even"><a name="iDataSort"></a><a name="iDataSort_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iDataSort">iDataSort</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>The column index (starting from 0!) that you wish a sort to be performed
|
||||
upon when this column is selected for sorting. This can be used for sorting
|
||||
on hidden columns for example.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{ "iDataSort": 1, "aTargets": [ 0 ] }
|
||||
]
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
{ "iDataSort": 1 },
|
||||
null,
|
||||
null,
|
||||
null,
|
||||
null
|
||||
]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="mData"></a><a name="mData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#mData">mData</a></span><span class="type-sig"><span class="type-signature"> :string|int|function|null</span></span></dt><dd class=" odd"><p>This property can be used to read data from any JSON data source property,
|
||||
including deeply nested objects / properties. mData can be given in a
|
||||
number of different ways which effect its behaviour:
|
||||
<ul>
|
||||
<li>integer - treated as an array index for the data source. This is the
|
||||
default that DataTables uses (incrementally increased for each column).</li>
|
||||
<li>string - read an object property from the data source. Note that you can
|
||||
use Javascript dotted notation to read deep properties / arrays from the
|
||||
data source.</li>
|
||||
<li>null - the sDefaultContent option will be used for the cell (null
|
||||
by default, so you will need to specify the default content you want -
|
||||
typically an empty string). This can be useful on generated columns such
|
||||
as edit / delete action columns.</li>
|
||||
<li>function - the function given will be executed whenever DataTables
|
||||
needs to set or get the data for a cell in the column. The function
|
||||
takes three parameters:
|
||||
<ul>
|
||||
<li>{array|object} The data source for the row</li>
|
||||
<li>{string} The type call data requested - this will be 'set' when
|
||||
setting data or 'filter', 'display', 'type', 'sort' or undefined when
|
||||
gathering data. Note that when <i>undefined</i> is given for the type
|
||||
DataTables expects to get the raw data for the object back</li>
|
||||
<li>{*} Data to set when the second parameter is 'set'.</li>
|
||||
</ul>
|
||||
The return value from the function is not required when 'set' is the type
|
||||
of call, but otherwise the return is what will be used for the data
|
||||
requested.</li>
|
||||
</ul></p>
|
||||
|
||||
<p>Note that prior to DataTables 1.9.2 mData was called mDataProp. The name change
|
||||
reflects the flexibility of this property and is consistent with the naming of
|
||||
mRender. If 'mDataProp' is given, then it will still be used by DataTables, as
|
||||
it automatically maps the old name to the new if required.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Read table data from objects
|
||||
$(document).ready( function() {
|
||||
var oTable = $('#example').dataTable( {
|
||||
"sAjaxSource": "sources/deep.txt",
|
||||
"aoColumns": [
|
||||
{ "mData": "engine" },
|
||||
{ "mData": "browser" },
|
||||
{ "mData": "platform.inner" },
|
||||
{ "mData": "platform.details.0" },
|
||||
{ "mData": "platform.details.1" }
|
||||
]
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using mData as a function to provide different information for
|
||||
// sorting, filtering and display. In this case, currency (price)
|
||||
$(document).ready( function() {
|
||||
var oTable = $('#example').dataTable( {
|
||||
"aoColumnDefs": [ {
|
||||
"aTargets": [ 0 ],
|
||||
"mData": function ( source, type, val ) {
|
||||
if (type === 'set') {
|
||||
source.price = val;
|
||||
// Store the computed dislay and filter values for efficiency
|
||||
source.price_display = val=="" ? "" : "$"+numberFormat(val);
|
||||
source.price_filter = val=="" ? "" : "$"+numberFormat(val)+" "+val;
|
||||
return;
|
||||
}
|
||||
else if (type === 'display') {
|
||||
return source.price_display;
|
||||
}
|
||||
else if (type === 'filter') {
|
||||
return source.price_filter;
|
||||
}
|
||||
// 'sort', 'type' and undefined all just use the integer
|
||||
return source.price;
|
||||
}
|
||||
} ]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="mDataProp"></a><a name="mDataProp_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#mDataProp">mDataProp</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" even"><p>This parameter has been replaced by mData in DataTables to ensure naming
|
||||
consistency. mDataProp can still be used, as there is backwards compatibility
|
||||
in DataTables for this option, but it is strongly recommended that you use
|
||||
mData in preference to mDataProp.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="mRender"></a><a name="mRender_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#mRender">mRender</a></span><span class="type-sig"><span class="type-signature"> :string|int|function|null</span></span></dt><dd class=" odd"><p>This property is the rendering partner to mData and it is suggested that
|
||||
when you want to manipulate data for display (including filtering, sorting etc)
|
||||
but not altering the underlying data for the table, use this property. mData
|
||||
can actually do everything this property can and more, but this parameter is
|
||||
easier to use since there is no 'set' option. Like mData is can be given
|
||||
in a number of different ways to effect its behaviour, with the addition of
|
||||
supporting array syntax for easy outputting of arrays (including arrays of
|
||||
objects):
|
||||
<ul>
|
||||
<li>integer - treated as an array index for the data source. This is the
|
||||
default that DataTables uses (incrementally increased for each column).</li>
|
||||
<li>string - read an object property from the data source. Note that you can
|
||||
use Javascript dotted notation to read deep properties / arrays from the
|
||||
data source and also array brackets to indicate that the data reader should
|
||||
loop over the data source array. When characters are given between the array
|
||||
brackets, these characters are used to join the data source array together.
|
||||
For example: "accounts[, ].name" would result in a comma separated list with
|
||||
the 'name' value from the 'accounts' array of objects.</li>
|
||||
<li>function - the function given will be executed whenever DataTables
|
||||
needs to set or get the data for a cell in the column. The function
|
||||
takes three parameters:
|
||||
<ul>
|
||||
<li>{array|object} The data source for the row (based on mData)</li>
|
||||
<li>{string} The type call data requested - this will be 'filter', 'display',
|
||||
'type' or 'sort'.</li>
|
||||
<li>{array|object} The full data source for the row (not based on mData)</li>
|
||||
</ul>
|
||||
The return value from the function is what will be used for the data
|
||||
requested.</li>
|
||||
</ul></p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Create a comma separated list from an array of objects
|
||||
$(document).ready( function() {
|
||||
var oTable = $('#example').dataTable( {
|
||||
"sAjaxSource": "sources/deep.txt",
|
||||
"aoColumns": [
|
||||
{ "mData": "engine" },
|
||||
{ "mData": "browser" },
|
||||
{
|
||||
"mData": "platform",
|
||||
"mRender": "[, ].name"
|
||||
}
|
||||
]
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Use as a function to create a link from the data source
|
||||
$(document).ready( function() {
|
||||
var oTable = $('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{
|
||||
"aTargets": [ 0 ],
|
||||
"mData": "download_link",
|
||||
"mRender": function ( data, type, full ) {
|
||||
return '<a href="'+data+'">Download</a>';
|
||||
}
|
||||
]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="sCellType"></a><a name="sCellType_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sCellType">sCellType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Change the cell type created for the column - either TD cells or TH cells. This
|
||||
can be useful as TH cells have semantic meaning in the table body, allowing them
|
||||
to act as a header for a row (you may wish to add scope='row' to the TH elements).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Make the first column use TH cells
|
||||
$(document).ready( function() {
|
||||
var oTable = $('#example').dataTable( {
|
||||
"aoColumnDefs": [ {
|
||||
"aTargets": [ 0 ],
|
||||
"sCellType": "th"
|
||||
} ]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sClass"></a><a name="sClass_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sClass">sClass</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Class to give to each cell in this column.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{ "sClass": "my_class", "aTargets": [ 0 ] }
|
||||
]
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
{ "sClass": "my_class" },
|
||||
null,
|
||||
null,
|
||||
null,
|
||||
null
|
||||
]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="sContentPadding"></a><a name="sContentPadding_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sContentPadding">sContentPadding</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>When DataTables calculates the column widths to assign to each column,
|
||||
it finds the longest string in each column and then constructs a
|
||||
temporary table and reads the widths from that. The problem with this
|
||||
is that "mmm" is much wider then "iiii", but the latter is a longer
|
||||
string - thus the calculation can go wrong (doing it properly and putting
|
||||
it into an DOM object and measuring that is horribly(!) slow). Thus as
|
||||
a "work around" we provide this option. It will append its value to the
|
||||
text that is found to be the longest string for the column - i.e. padding.
|
||||
Generally you shouldn't need this, and it is not documented on the
|
||||
general DataTables.net documentation</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
null,
|
||||
null,
|
||||
null,
|
||||
{
|
||||
"sContentPadding": "mmm"
|
||||
}
|
||||
]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sDefaultContent"></a><a name="sDefaultContent_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sDefaultContent">sDefaultContent</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Allows a default value to be given for a column's data, and will be used
|
||||
whenever a null data source is encountered (this can be because mData
|
||||
is set to null, or because the data source itself is null).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{
|
||||
"mData": null,
|
||||
"sDefaultContent": "Edit",
|
||||
"aTargets": [ -1 ]
|
||||
}
|
||||
]
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
null,
|
||||
null,
|
||||
null,
|
||||
{
|
||||
"mData": null,
|
||||
"sDefaultContent": "Edit"
|
||||
}
|
||||
]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="sName"></a><a name="sName_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sName">sName</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>This parameter is only used in DataTables' server-side processing. It can
|
||||
be exceptionally useful to know what columns are being displayed on the
|
||||
client side, and to map these to database fields. When defined, the names
|
||||
also allow DataTables to reorder information from the server if it comes
|
||||
back in an unexpected order (i.e. if you switch your columns around on the
|
||||
client-side, your server-side code does not also need updating).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{ "sName": "engine", "aTargets": [ 0 ] },
|
||||
{ "sName": "browser", "aTargets": [ 1 ] },
|
||||
{ "sName": "platform", "aTargets": [ 2 ] },
|
||||
{ "sName": "version", "aTargets": [ 3 ] },
|
||||
{ "sName": "grade", "aTargets": [ 4 ] }
|
||||
]
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
{ "sName": "engine" },
|
||||
{ "sName": "browser" },
|
||||
{ "sName": "platform" },
|
||||
{ "sName": "version" },
|
||||
{ "sName": "grade" }
|
||||
]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sSortDataType"></a><a name="sSortDataType_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSortDataType">sSortDataType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Defines a data source type for the sorting which can be used to read
|
||||
real-time information from the table (updating the internally cached
|
||||
version) prior to sorting. This allows sorting to occur on user editable
|
||||
elements such as form inputs.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{ "sSortDataType": "dom-text", "aTargets": [ 2, 3 ] },
|
||||
{ "sType": "numeric", "aTargets": [ 3 ] },
|
||||
{ "sSortDataType": "dom-select", "aTargets": [ 4 ] },
|
||||
{ "sSortDataType": "dom-checkbox", "aTargets": [ 5 ] }
|
||||
]
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
null,
|
||||
null,
|
||||
{ "sSortDataType": "dom-text" },
|
||||
{ "sSortDataType": "dom-text", "sType": "numeric" },
|
||||
{ "sSortDataType": "dom-select" },
|
||||
{ "sSortDataType": "dom-checkbox" }
|
||||
]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="sTitle"></a><a name="sTitle_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sTitle">sTitle</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>The title of this column.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{ "sTitle": "My column title", "aTargets": [ 0 ] }
|
||||
]
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
{ "sTitle": "My column title" },
|
||||
null,
|
||||
null,
|
||||
null,
|
||||
null
|
||||
]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sType"></a><a name="sType_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sType">sType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>The type allows you to specify how the data for this column will be sorted.
|
||||
Four types (string, numeric, date and html (which will strip HTML tags
|
||||
before sorting)) are currently available. Note that only date formats
|
||||
understood by Javascript's Date() object will be accepted as type date. For
|
||||
example: "Mar 26, 2008 5:03 PM". May take the values: 'string', 'numeric',
|
||||
'date' or 'html' (by default). Further types can be adding through
|
||||
plug-ins.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{ "sType": "html", "aTargets": [ 0 ] }
|
||||
]
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
{ "sType": "html" },
|
||||
null,
|
||||
null,
|
||||
null,
|
||||
null
|
||||
]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="sWidth"></a><a name="sWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sWidth">sWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Defining the width of the column, this parameter may take any CSS value
|
||||
(3em, 20px etc). DataTables apples 'smart' widths to columns which have not
|
||||
been given a specific width through this interface ensuring that the table
|
||||
remains readable.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumnDefs
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumnDefs": [
|
||||
{ "sWidth": "20%", "aTargets": [ 0 ] }
|
||||
]
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Using aoColumns
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"aoColumns": [
|
||||
{ "sWidth": "20%" },
|
||||
null,
|
||||
null,
|
||||
null,
|
||||
null
|
||||
]
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd>
|
||||
</dl></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>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,362 @@
|
||||
<!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: oLanguage - 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: oLanguage</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.defaults.html">.defaults</a>.</span> » oLanguage</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><a href="#summary_namespaces">Namespaces (2)</a></td></tr><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (12)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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 (12)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>All strings that DataTables uses in the user interface that it creates
|
||||
are defined in this object, allowing you to modified them individually or
|
||||
completely replace them all as required.</p><dl class="details">
|
||||
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="doc_summary">
|
||||
<a name="summary"></a>
|
||||
<h2>Summary</h2>
|
||||
|
||||
<div class="doc_group"><a name="summary_namespaces"></a><h3 class="subsection-title">Namespaces</h3>
|
||||
<dl>
|
||||
<dt class="even"><span class="type-name"><a href="DataTable.defaults.oLanguage.oAria.html">oAria</a></span></dt><dd class="even"><p>Strings that are used for WAI-ARIA labels and controls only (these are not
|
||||
actually visible on the page, but will be read by screenreaders, and thus
|
||||
must be internationalised as well).</p></dd><dt class="odd"><span class="type-name"><a href="DataTable.defaults.oLanguage.oPaginate.html">oPaginate</a></span></dt><dd class="odd"><p>Pagination string used by DataTables for the two built-in pagination
|
||||
control types ("two_button" and "full_numbers")</p></dd>
|
||||
</dl></div><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="#sEmptyTable">sEmptyTable</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>This string is shown in preference to sZeroRecords when the table is
|
||||
empty of data (regardless of filtering). Note that this is an optional
|
||||
parameter - if it is not given, the value of sZeroRecords will be used
|
||||
instead (either the default or given value).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInfo">sInfo</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>This string gives information to the end user about the information that
|
||||
is current on display on the page. The <em>START</em>, <em>END</em> and <em>TOTAL</em>
|
||||
variables are all dynamically replaced as the table display updates, and
|
||||
can be freely moved or removed as the language requirements change.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInfoEmpty">sInfoEmpty</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Display information string for when the table is empty. Typically the
|
||||
format of this string should match sInfo.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInfoFiltered">sInfoFiltered</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>When a user filters the information in a table, this string is appended
|
||||
to the information (sInfo) to give an idea of how strong the filtering
|
||||
is. The variable <em>MAX</em> is dynamically updated.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInfoPostFix">sInfoPostFix</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>If can be useful to append extra information to the info string at times,
|
||||
and this variable does exactly that. This information will be appended to
|
||||
the sInfo (sInfoEmpty and sInfoFiltered in whatever combination they are
|
||||
being used) at all times.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInfoThousands">sInfoThousands</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>DataTables has a build in number formatter (fnFormatNumber) which is used
|
||||
to format large numbers that are used in the table information. By
|
||||
default a comma is used, but this can be trivially changed to any
|
||||
character you wish with this parameter.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sLengthMenu">sLengthMenu</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Detail the action that will be taken when the drop down menu for the
|
||||
pagination length option is changed. The '<em>MENU</em>' variable is replaced
|
||||
with a default select list of 10, 25, 50 and 100, and can be replaced
|
||||
with a custom select box if required.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sLoadingRecords">sLoadingRecords</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>When using Ajax sourced data and during the first draw when DataTables is
|
||||
gathering the data, this message is shown in an empty row in the table to
|
||||
indicate to the end user the the data is being loaded. Note that this
|
||||
parameter is not used when loading data by server-side processing, just
|
||||
Ajax sourced data with client-side processing.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sProcessing">sProcessing</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Text which is displayed when the table is processing a user action
|
||||
(usually a sort command or similar).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSearch">sSearch</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Details the actions that will be taken when the user types into the
|
||||
filtering input text box. The variable "<em>INPUT</em>", if used in the string,
|
||||
is replaced with the HTML text box for the filtering input allowing
|
||||
control over where it appears in the string. If "<em>INPUT</em>" is not given
|
||||
then the input box is appended to the string automatically.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sUrl">sUrl</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>All of the language information can be stored in a file on the
|
||||
server-side, which DataTables will look up if this parameter is passed.
|
||||
It must store the URL of the language file, which is in a JSON format,
|
||||
and the object has the same properties as the oLanguage object in the
|
||||
initialiser object (i.e. the above parameters). Please refer to one of
|
||||
the example language files to see how this works in action.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sZeroRecords">sZeroRecords</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Text shown inside the table records when the is no information to be
|
||||
displayed after filtering. sEmptyTable is shown when there is simply no
|
||||
information in the table at all (regardless of filtering).</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="sEmptyTable"></a><a name="sEmptyTable_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sEmptyTable">sEmptyTable</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>This string is shown in preference to sZeroRecords when the table is
|
||||
empty of data (regardless of filtering). Note that this is an optional
|
||||
parameter - if it is not given, the value of sZeroRecords will be used
|
||||
instead (either the default or given value).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sEmptyTable": "No data available in table"
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sInfo"></a><a name="sInfo_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInfo">sInfo</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>This string gives information to the end user about the information that
|
||||
is current on display on the page. The <em>START</em>, <em>END</em> and <em>TOTAL</em>
|
||||
variables are all dynamically replaced as the table display updates, and
|
||||
can be freely moved or removed as the language requirements change.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sInfo": "Got a total of _TOTAL_ entries to show (_START_ to _END_)"
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="sInfoEmpty"></a><a name="sInfoEmpty_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInfoEmpty">sInfoEmpty</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Display information string for when the table is empty. Typically the
|
||||
format of this string should match sInfo.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sInfoEmpty": "No entries to show"
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sInfoFiltered"></a><a name="sInfoFiltered_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInfoFiltered">sInfoFiltered</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>When a user filters the information in a table, this string is appended
|
||||
to the information (sInfo) to give an idea of how strong the filtering
|
||||
is. The variable <em>MAX</em> is dynamically updated.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sInfoFiltered": " - filtering from _MAX_ records"
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="sInfoPostFix"></a><a name="sInfoPostFix_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInfoPostFix">sInfoPostFix</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>If can be useful to append extra information to the info string at times,
|
||||
and this variable does exactly that. This information will be appended to
|
||||
the sInfo (sInfoEmpty and sInfoFiltered in whatever combination they are
|
||||
being used) at all times.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sInfoPostFix": "All records shown are derived from real information."
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sInfoThousands"></a><a name="sInfoThousands_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInfoThousands">sInfoThousands</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>DataTables has a build in number formatter (fnFormatNumber) which is used
|
||||
to format large numbers that are used in the table information. By
|
||||
default a comma is used, but this can be trivially changed to any
|
||||
character you wish with this parameter.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sInfoThousands": "'"
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="sLengthMenu"></a><a name="sLengthMenu_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sLengthMenu">sLengthMenu</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Detail the action that will be taken when the drop down menu for the
|
||||
pagination length option is changed. The '<em>MENU</em>' variable is replaced
|
||||
with a default select list of 10, 25, 50 and 100, and can be replaced
|
||||
with a custom select box if required.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Language change only
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sLengthMenu": "Display _MENU_ records"
|
||||
}
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Language and options change
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sLengthMenu": 'Display <select>'+
|
||||
'<option value="10">10</option>'+
|
||||
'<option value="20">20</option>'+
|
||||
'<option value="30">30</option>'+
|
||||
'<option value="40">40</option>'+
|
||||
'<option value="50">50</option>'+
|
||||
'<option value="-1">All</option>'+
|
||||
'</select> records'
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sLoadingRecords"></a><a name="sLoadingRecords_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sLoadingRecords">sLoadingRecords</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>When using Ajax sourced data and during the first draw when DataTables is
|
||||
gathering the data, this message is shown in an empty row in the table to
|
||||
indicate to the end user the the data is being loaded. Note that this
|
||||
parameter is not used when loading data by server-side processing, just
|
||||
Ajax sourced data with client-side processing.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sLoadingRecords": "Please wait - loading..."
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="sProcessing"></a><a name="sProcessing_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sProcessing">sProcessing</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Text which is displayed when the table is processing a user action
|
||||
(usually a sort command or similar).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sProcessing": "DataTables is currently busy"
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sSearch"></a><a name="sSearch_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSearch">sSearch</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Details the actions that will be taken when the user types into the
|
||||
filtering input text box. The variable "<em>INPUT</em>", if used in the string,
|
||||
is replaced with the HTML text box for the filtering input allowing
|
||||
control over where it appears in the string. If "<em>INPUT</em>" is not given
|
||||
then the input box is appended to the string automatically.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Input text box will be appended at the end automatically
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sSearch": "Filter records:"
|
||||
}
|
||||
} );
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Specify where the filter should appear
|
||||
$(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sSearch": "Apply filter _INPUT_ to table"
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="sUrl"></a><a name="sUrl_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sUrl">sUrl</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>All of the language information can be stored in a file on the
|
||||
server-side, which DataTables will look up if this parameter is passed.
|
||||
It must store the URL of the language file, which is in a JSON format,
|
||||
and the object has the same properties as the oLanguage object in the
|
||||
initialiser object (i.e. the above parameters). Please refer to one of
|
||||
the example language files to see how this works in action.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sUrl": "http://www.sprymedia.co.uk/dataTables/lang.txt"
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sZeroRecords"></a><a name="sZeroRecords_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sZeroRecords">sZeroRecords</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Text shown inside the table records when the is no information to be
|
||||
displayed after filtering. sEmptyTable is shown when there is simply no
|
||||
information in the table at all (regardless of filtering).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"sZeroRecords": "No records to display"
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd>
|
||||
</dl></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>
|
||||
@@ -0,0 +1,135 @@
|
||||
<!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: oAria - 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: oAria</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.defaults.html">.defaults</a> » <a href="DataTable.defaults.oLanguage.html">.oLanguage</a>.</span> » oAria</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 (2)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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 (2)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Strings that are used for WAI-ARIA labels and controls only (these are not
|
||||
actually visible on the page, but will be read by screenreaders, and thus
|
||||
must be internationalised as well).</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="#sSortAscending">sSortAscending</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>ARIA label that is added to the table headers when the column may be
|
||||
sorted ascending by activing the column (click or return when focused).
|
||||
Note that the column header is prefixed to this string.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSortDescending">sSortDescending</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>ARIA label that is added to the table headers when the column may be
|
||||
sorted descending by activing the column (click or return when focused).
|
||||
Note that the column header is prefixed to this string.</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="sSortAscending"></a><a name="sSortAscending_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSortAscending">sSortAscending</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>ARIA label that is added to the table headers when the column may be
|
||||
sorted ascending by activing the column (click or return when focused).
|
||||
Note that the column header is prefixed to this string.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"oAria": {
|
||||
"sSortAscending": " - click/return to sort ascending"
|
||||
}
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sSortDescending"></a><a name="sSortDescending_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSortDescending">sSortDescending</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>ARIA label that is added to the table headers when the column may be
|
||||
sorted descending by activing the column (click or return when focused).
|
||||
Note that the column header is prefixed to this string.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"oAria": {
|
||||
"sSortDescending": " - click/return to sort descending"
|
||||
}
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd>
|
||||
</dl></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>
|
||||
@@ -0,0 +1,164 @@
|
||||
<!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: oPaginate - 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: oPaginate</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.defaults.html">.defaults</a> » <a href="DataTable.defaults.oLanguage.html">.oLanguage</a>.</span> » oPaginate</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 (4)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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 (4)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Pagination string used by DataTables for the two built-in pagination
|
||||
control types ("two_button" and "full_numbers")</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="#sFirst">sFirst</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Text to use when using the 'full_numbers' type of pagination for the
|
||||
button to take the user to the first page.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sLast">sLast</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Text to use when using the 'full_numbers' type of pagination for the
|
||||
button to take the user to the last page.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sNext">sNext</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Text to use for the 'next' pagination button (to take the user to the
|
||||
next page).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sPrevious">sPrevious</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Text to use for the 'previous' pagination button (to take the user to <br />
|
||||
the previous page).</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="sFirst"></a><a name="sFirst_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sFirst">sFirst</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Text to use when using the 'full_numbers' type of pagination for the
|
||||
button to take the user to the first page.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"oPaginate": {
|
||||
"sFirst": "First page"
|
||||
}
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sLast"></a><a name="sLast_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sLast">sLast</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Text to use when using the 'full_numbers' type of pagination for the
|
||||
button to take the user to the last page.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"oPaginate": {
|
||||
"sLast": "Last page"
|
||||
}
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="sNext"></a><a name="sNext_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sNext">sNext</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Text to use for the 'next' pagination button (to take the user to the
|
||||
next page).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"oPaginate": {
|
||||
"sNext": "Next page"
|
||||
}
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="sPrevious"></a><a name="sPrevious_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sPrevious">sPrevious</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Text to use for the 'previous' pagination button (to take the user to <br />
|
||||
the previous page).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oLanguage": {
|
||||
"oPaginate": {
|
||||
"sPrevious": "Previous page"
|
||||
}
|
||||
}
|
||||
} );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd>
|
||||
</dl></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>
|
||||
@@ -0,0 +1,93 @@
|
||||
<!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: oSearch - 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: oSearch</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.defaults.html">.defaults</a>.</span> » oSearch</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>Static properties (0)</td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Static properties (0)</td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>This parameter allows you to have define the global filtering state at
|
||||
initialisation time. As an object the "sSearch" parameter must be
|
||||
defined, but all other parameters are optional. When "bRegex" is true,
|
||||
the search string will be treated as a regular expression, when false
|
||||
(default) it will be treated as a straight string. When "bSmart"
|
||||
DataTables will use it's smart filtering methods (to word match at
|
||||
any point in the data), when false this will not be done.</p><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h3>Example</h3>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready( function() {
|
||||
$('#example').dataTable( {
|
||||
"oSearch": {"sSearch": "Initial search"}
|
||||
} );
|
||||
} )</pre>
|
||||
</div>
|
||||
<h3 class="subsection-title">Extends</h3>
|
||||
<ul>
|
||||
<li><a href="DataTable.models.oSearch.html">DataTable.models.oSearch</a></li>
|
||||
</ul>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,83 @@
|
||||
<!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: ext - 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: ext</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a>.</span> » ext</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>Static properties (0)</td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Static properties (0)</td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Extension object for DataTables that is used to provide all extension options.</p>
|
||||
|
||||
<p>Note that the <i>DataTable.ext</i> object is available through
|
||||
<i>jQuery.fn.dataTable.ext</i> where it may be accessed and manipulated. It is
|
||||
also aliased to <i>jQuery.fn.dataTableExt</i> for historic reasons.</p><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h3 class="subsection-title">Extends</h3>
|
||||
<ul>
|
||||
<li><a href="DataTable.models.ext.html">DataTable.models.ext</a></li>
|
||||
</ul>
|
||||
|
||||
</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>
|
||||
1371
wwwroot/BackendScript/assets/advanced-datatable/docs/DataTable.html
Normal file
1371
wwwroot/BackendScript/assets/advanced-datatable/docs/DataTable.html
Normal file
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,754 @@
|
||||
<!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: ext - 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: ext</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a>.</span> » ext</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 (14)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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 (14)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>DataTables extension options and plug-ins. This namespace acts as a collection "area"
|
||||
for plug-ins that can be used to extend the default DataTables behaviour - indeed many
|
||||
of the build in methods use this method to provide their own capabilities (sorting methods
|
||||
for example).</p>
|
||||
|
||||
<p>Note that this namespace is aliased to jQuery.fn.dataTableExt so it can be readily accessed
|
||||
and modified by plug-ins.</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="#afnFiltering">afnFiltering</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Plug-in filtering functions - this method of filtering is complimentary to the default
|
||||
type based filtering, and a lot more comprehensive as it allows you complete control
|
||||
over the filtering logic. Each element in this array is a function (parameters
|
||||
described below) that is called for every row in the table, and your logic decides if
|
||||
it should be included in the filtered data set or not.
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{object} DataTables settings object: see <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a>.</li>
|
||||
<li>{array|object} Data for the row to be processed (same as the original format
|
||||
that was passed in as the data source, or an array from a DOM data source</li>
|
||||
<li>{int} Row index in aoData (<a href="DataTable.models.oSettings.html#aoData">DataTable.models.oSettings.aoData</a>), which can
|
||||
be useful to retrieve the TR element if you need DOM interaction.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>{boolean} Include the row in the filtered result set (true) or not (false)</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul></p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#afnSortData">afnSortData</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Plug-in sorting functions - this method of sorting is complimentary to the default type
|
||||
based sorting that DataTables does automatically, allowing much greater control over the
|
||||
the data that is being used to sort a column. This is useful if you want to do sorting
|
||||
based on live data (for example the contents of an 'input' element) rather than just the
|
||||
static string that DataTables knows of. The way these plug-ins work is that you create
|
||||
an array of the values you wish to be sorted for the column in question and then return
|
||||
that array. Which pre-sorting function is run here depends on the sSortDataType parameter
|
||||
that is used for the column (if any). This is the corollary of <i>ofnSearch</i> for sort
|
||||
data.
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{object} DataTables settings object: see <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a>.</li>
|
||||
<li>{int} Target column index</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>{array} Data for the column to be sorted upon</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul> [<a href-"#afnSortData">...</a>] </p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoFeatures">aoFeatures</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Feature plug-ins - This is an array of objects which describe the feature plug-ins that are
|
||||
available to DataTables. These feature plug-ins are accessible through the sDom initialisation
|
||||
option. As such, each feature plug-in must describe a function that is used to initialise
|
||||
itself (fnInit), a character so the feature can be enabled by sDom (cFeature) and the name
|
||||
of the feature (sFeature). Thus the objects attached to this method must provide:
|
||||
<ul>
|
||||
<li>{function} fnInit Initialisation of the plug-in
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{object} DataTables settings object: see <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>{node|null} The element which contains your feature. Note that the return
|
||||
may also be void if your plug-in does not require to inject any DOM elements
|
||||
into DataTables control (sDom) - for example this might be useful when
|
||||
developing a plug-in which allows table control via keyboard entry.</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul>
|
||||
</li>
|
||||
<li>{character} cFeature Character that will be matched in sDom - case sensitive</li>
|
||||
<li>{string} sFeature Feature name</li>
|
||||
</ul></p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aTypes">aTypes</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Type detection plug-in functions - DataTables utilises types to define how sorting and
|
||||
filtering behave, and types can be either be defined by the developer (sType for the
|
||||
column) or they can be automatically detected by the methods in this array. The functions
|
||||
defined in the array are quite simple, taking a single parameter (the data to analyse)
|
||||
and returning the type if it is a known type, or null otherwise.
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{*} Data from the column cell to be analysed</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>{string|null} Data type detected, or null if unknown (and thus pass it
|
||||
on to the other type detection functions.</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul></p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnVersionCheck">fnVersionCheck</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" even"><p>Provide a common method for plug-ins to check the version of DataTables being used,
|
||||
in order to ensure compatibility.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iApiIndex">iApiIndex</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Index for what 'this' index API functions should use</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oApi">oApi</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>Container for all private functions in DataTables so they can be exposed externally</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#ofnSearch">ofnSearch</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>Pre-processing of filtering data plug-ins - When you assign the sType for a column
|
||||
(or have it automatically detected for you by DataTables or a type detection plug-in),
|
||||
you will typically be using this for custom sorting, but it can also be used to provide
|
||||
custom filtering by allowing you to pre-processing the data and returning the data in
|
||||
the format that should be filtered upon. This is done by adding functions this object
|
||||
with a parameter name which matches the sType for that target column. This is the
|
||||
corollary of <i>afnSortData</i> for filtering data.
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{*} Data from the column cell to be prepared for filtering</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>{string|null} Formatted string that will be used for the filtering.</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul> [<a href-"#ofnSearch">...</a>] </p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oJUIClasses">oJUIClasses</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>Storage for the various classes that DataTables uses - jQuery UI suitable</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oPagination">oPagination</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>Pagination plug-in methods - The style and controls of the pagination can significantly
|
||||
impact on how the end user interacts with the data in your table, and DataTables allows
|
||||
the addition of pagination controls by extending this object, which can then be enabled
|
||||
through the <i>sPaginationType</i> initialisation parameter. Each pagination type that
|
||||
is added is an object (the property name of which is what <i>sPaginationType</i> refers
|
||||
to) that has two properties, both methods that are used by DataTables to update the
|
||||
control's state.
|
||||
<ul>
|
||||
<li>
|
||||
fnInit - Initialisation of the paging controls. Called only during initialisation
|
||||
of the table. It is expected that this function will add the required DOM elements
|
||||
to the page for the paging controls to work. The element pointer
|
||||
'oSettings.aanFeatures.p' array is provided by DataTables to contain the paging
|
||||
controls (note that this is a 2D array to allow for multiple instances of each
|
||||
DataTables DOM element). It is suggested that you add the controls to this element
|
||||
as children
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{object} DataTables settings object: see <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a>.</li>
|
||||
<li>{node} Container into which the pagination controls must be inserted</li>
|
||||
<li>{function} Draw callback function - whenever the controls cause a page
|
||||
change, this method must be called to redraw the table.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>No return required</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul>
|
||||
</il>
|
||||
<li>
|
||||
fnInit - This function is called whenever the paging status of the table changes and is
|
||||
typically used to update classes and/or text of the paging controls to reflex the new
|
||||
status.
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{object} DataTables settings object: see <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a>.</li>
|
||||
<li>{function} Draw callback function - in case you need to redraw the table again
|
||||
or attach new event listeners</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>No return required</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul>
|
||||
</il>
|
||||
</ul></p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oSort">oSort</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>Sorting plug-in methods - Sorting in DataTables is based on the detected type of the
|
||||
data column (you can add your own type detection functions, or override automatic
|
||||
detection using sType). With this specific type given to the column, DataTables will
|
||||
apply the required sort from the functions in the object. Each sort type must provide
|
||||
two mandatory methods, one each for ascending and descending sorting, and can optionally
|
||||
provide a pre-formatting method that will help speed up sorting by allowing DataTables
|
||||
to pre-format the sort data only once (rather than every time the actual sort functions
|
||||
are run). The two sorting functions are typical Javascript sort methods:
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{<em>} Data to compare to the second parameter</li>
|
||||
<li>{</em>} Data to compare to the first parameter</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>{int} Sorting match: <0 if first parameter should be sorted lower than
|
||||
the second parameter, ===0 if the two parameters are equal and >0 if
|
||||
the first parameter should be sorted height than the second parameter.</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul></p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oStdClasses">oStdClasses</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>Storage for the various classes that DataTables uses</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sErrMode">sErrMode</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>How should DataTables report an error. Can take the value 'alert' or 'throw'</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sVersion">sVersion</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Version string for plug-ins to check compatibility. Allowed format is
|
||||
a.b.c.d.e where: a:int, b:int, c:int, d:string(dev|beta), e:int. d and
|
||||
e are optional</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="afnFiltering"></a><a name="afnFiltering_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#afnFiltering">afnFiltering</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Plug-in filtering functions - this method of filtering is complimentary to the default
|
||||
type based filtering, and a lot more comprehensive as it allows you complete control
|
||||
over the filtering logic. Each element in this array is a function (parameters
|
||||
described below) that is called for every row in the table, and your logic decides if
|
||||
it should be included in the filtered data set or not.
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{object} DataTables settings object: see <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a>.</li>
|
||||
<li>{array|object} Data for the row to be processed (same as the original format
|
||||
that was passed in as the data source, or an array from a DOM data source</li>
|
||||
<li>{int} Row index in aoData (<a href="DataTable.models.oSettings.html#aoData">DataTable.models.oSettings.aoData</a>), which can
|
||||
be useful to retrieve the TR element if you need DOM interaction.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>{boolean} Include the row in the filtered result set (true) or not (false)</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul></p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // The following example shows custom filtering being applied to the fourth column (i.e.
|
||||
// the aData[3] index) based on two input values from the end-user, matching the data in
|
||||
// a certain range.
|
||||
$.fn.dataTableExt.afnFiltering.push(
|
||||
function( oSettings, aData, iDataIndex ) {
|
||||
var iMin = document.getElementById('min').value * 1;
|
||||
var iMax = document.getElementById('max').value * 1;
|
||||
var iVersion = aData[3] == "-" ? 0 : aData[3]*1;
|
||||
if ( iMin == "" && iMax == "" ) {
|
||||
return true;
|
||||
}
|
||||
else if ( iMin == "" && iVersion < iMax ) {
|
||||
return true;
|
||||
}
|
||||
else if ( iMin < iVersion && "" == iMax ) {
|
||||
return true;
|
||||
}
|
||||
else if ( iMin < iVersion && iVersion < iMax ) {
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
);</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="afnSortData"></a><a name="afnSortData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#afnSortData">afnSortData</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Plug-in sorting functions - this method of sorting is complimentary to the default type
|
||||
based sorting that DataTables does automatically, allowing much greater control over the
|
||||
the data that is being used to sort a column. This is useful if you want to do sorting
|
||||
based on live data (for example the contents of an 'input' element) rather than just the
|
||||
static string that DataTables knows of. The way these plug-ins work is that you create
|
||||
an array of the values you wish to be sorted for the column in question and then return
|
||||
that array. Which pre-sorting function is run here depends on the sSortDataType parameter
|
||||
that is used for the column (if any). This is the corollary of <i>ofnSearch</i> for sort
|
||||
data.
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{object} DataTables settings object: see <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a>.</li>
|
||||
<li>{int} Target column index</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>{array} Data for the column to be sorted upon</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul></p>
|
||||
|
||||
<p>Note that as of v1.9, it is typically preferable to use <i>mData</i> to prepare data for
|
||||
the different uses that DataTables can put the data to. Specifically <i>mData</i> when
|
||||
used as a function will give you a 'type' (sorting, filtering etc) that you can use to
|
||||
prepare the data as required for the different types. As such, this method is deprecated.</p><div class="collapse_details"><dl class="details">
|
||||
<dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Updating the cached sorting information with user entered values in HTML input elements
|
||||
jQuery.fn.dataTableExt.afnSortData['dom-text'] = function ( oSettings, iColumn )
|
||||
{
|
||||
var aData = [];
|
||||
$( 'td:eq('+iColumn+') input', oSettings.oApi._fnGetTrNodes(oSettings) ).each( function () {
|
||||
aData.push( this.value );
|
||||
} );
|
||||
return aData;
|
||||
}</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="aoFeatures"></a><a name="aoFeatures_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoFeatures">aoFeatures</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Feature plug-ins - This is an array of objects which describe the feature plug-ins that are
|
||||
available to DataTables. These feature plug-ins are accessible through the sDom initialisation
|
||||
option. As such, each feature plug-in must describe a function that is used to initialise
|
||||
itself (fnInit), a character so the feature can be enabled by sDom (cFeature) and the name
|
||||
of the feature (sFeature). Thus the objects attached to this method must provide:
|
||||
<ul>
|
||||
<li>{function} fnInit Initialisation of the plug-in
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{object} DataTables settings object: see <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a>.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>{node|null} The element which contains your feature. Note that the return
|
||||
may also be void if your plug-in does not require to inject any DOM elements
|
||||
into DataTables control (sDom) - for example this might be useful when
|
||||
developing a plug-in which allows table control via keyboard entry.</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul>
|
||||
</li>
|
||||
<li>{character} cFeature Character that will be matched in sDom - case sensitive</li>
|
||||
<li>{string} sFeature Feature name</li>
|
||||
</ul></p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // How TableTools initialises itself.
|
||||
$.fn.dataTableExt.aoFeatures.push( {
|
||||
"fnInit": function( oSettings ) {
|
||||
return new TableTools( { "oDTSettings": oSettings } );
|
||||
},
|
||||
"cFeature": "T",
|
||||
"sFeature": "TableTools"
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="aTypes"></a><a name="aTypes_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aTypes">aTypes</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Type detection plug-in functions - DataTables utilises types to define how sorting and
|
||||
filtering behave, and types can be either be defined by the developer (sType for the
|
||||
column) or they can be automatically detected by the methods in this array. The functions
|
||||
defined in the array are quite simple, taking a single parameter (the data to analyse)
|
||||
and returning the type if it is a known type, or null otherwise.
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{*} Data from the column cell to be analysed</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>{string|null} Data type detected, or null if unknown (and thus pass it
|
||||
on to the other type detection functions.</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul></p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Currency type detection plug-in:
|
||||
jQuery.fn.dataTableExt.aTypes.push(
|
||||
function ( sData ) {
|
||||
var sValidChars = "0123456789.-";
|
||||
var Char;
|
||||
|
||||
// Check the numeric part
|
||||
for ( i=1 ; i<sData.length ; i++ ) {
|
||||
Char = sData.charAt(i);
|
||||
if (sValidChars.indexOf(Char) == -1) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
// Check prefixed by currency
|
||||
if ( sData.charAt(0) == '$' || sData.charAt(0) == '£' ) {
|
||||
return 'currency';
|
||||
}
|
||||
return null;
|
||||
}
|
||||
);</pre>
|
||||
</div>
|
||||
</div></dd><dt id="DataTable.models.ext.fnVersionCheck" class=" even"><a name="fnVersionCheck"></a><a name="fnVersionCheck_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnVersionCheck</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" even"><p>Provide a common method for plug-ins to check the version of DataTables being used,
|
||||
in order to ensure compatibility.</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">sVersion</td><td class="type type-param">string</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Version string to check for, in the format "X.Y.Z". Note
|
||||
that the formats "X" and "X.Y" are also acceptable.</p></td></tr>
|
||||
</tbody>
|
||||
</table><h5>Returns:</h5><p class="returns"><p>true if this version of DataTables is greater or equal to the
|
||||
required version, or false if this version of DataTales is not suitable</p></p><h5>Example:</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $(document).ready(function() {
|
||||
var oTable = $('#example').dataTable();
|
||||
alert( oTable.fnVersionCheck( '1.9.0' ) );
|
||||
} );</pre>
|
||||
</div>
|
||||
</div>
|
||||
<dt class=" odd"><a name="iApiIndex"></a><a name="iApiIndex_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iApiIndex">iApiIndex</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Index for what 'this' index API functions should use</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="oApi"></a><a name="oApi_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oApi">oApi</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>Container for all private functions in DataTables so they can be exposed externally</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="ofnSearch"></a><a name="ofnSearch_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#ofnSearch">ofnSearch</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>Pre-processing of filtering data plug-ins - When you assign the sType for a column
|
||||
(or have it automatically detected for you by DataTables or a type detection plug-in),
|
||||
you will typically be using this for custom sorting, but it can also be used to provide
|
||||
custom filtering by allowing you to pre-processing the data and returning the data in
|
||||
the format that should be filtered upon. This is done by adding functions this object
|
||||
with a parameter name which matches the sType for that target column. This is the
|
||||
corollary of <i>afnSortData</i> for filtering data.
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{*} Data from the column cell to be prepared for filtering</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>{string|null} Formatted string that will be used for the filtering.</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul></p>
|
||||
|
||||
<p>Note that as of v1.9, it is typically preferable to use <i>mData</i> to prepare data for
|
||||
the different uses that DataTables can put the data to. Specifically <i>mData</i> when
|
||||
used as a function will give you a 'type' (sorting, filtering etc) that you can use to
|
||||
prepare the data as required for the different types. As such, this method is deprecated.</p><div class="collapse_details"><dl class="details">
|
||||
<dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $.fn.dataTableExt.ofnSearch['title-numeric'] = function ( sData ) {
|
||||
return sData.replace(/\n/g," ").replace( /<.*?>/g, "" );
|
||||
}</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="oJUIClasses"></a><a name="oJUIClasses_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oJUIClasses">oJUIClasses</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>Storage for the various classes that DataTables uses - jQuery UI suitable</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="oPagination"></a><a name="oPagination_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oPagination">oPagination</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>Pagination plug-in methods - The style and controls of the pagination can significantly
|
||||
impact on how the end user interacts with the data in your table, and DataTables allows
|
||||
the addition of pagination controls by extending this object, which can then be enabled
|
||||
through the <i>sPaginationType</i> initialisation parameter. Each pagination type that
|
||||
is added is an object (the property name of which is what <i>sPaginationType</i> refers
|
||||
to) that has two properties, both methods that are used by DataTables to update the
|
||||
control's state.
|
||||
<ul>
|
||||
<li>
|
||||
fnInit - Initialisation of the paging controls. Called only during initialisation
|
||||
of the table. It is expected that this function will add the required DOM elements
|
||||
to the page for the paging controls to work. The element pointer
|
||||
'oSettings.aanFeatures.p' array is provided by DataTables to contain the paging
|
||||
controls (note that this is a 2D array to allow for multiple instances of each
|
||||
DataTables DOM element). It is suggested that you add the controls to this element
|
||||
as children
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{object} DataTables settings object: see <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a>.</li>
|
||||
<li>{node} Container into which the pagination controls must be inserted</li>
|
||||
<li>{function} Draw callback function - whenever the controls cause a page
|
||||
change, this method must be called to redraw the table.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>No return required</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul>
|
||||
</il>
|
||||
<li>
|
||||
fnInit - This function is called whenever the paging status of the table changes and is
|
||||
typically used to update classes and/or text of the paging controls to reflex the new
|
||||
status.
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{object} DataTables settings object: see <a href="DataTable.models.oSettings.html">DataTable.models.oSettings</a>.</li>
|
||||
<li>{function} Draw callback function - in case you need to redraw the table again
|
||||
or attach new event listeners</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>No return required</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul>
|
||||
</il>
|
||||
</ul></p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Example</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> $.fn.dataTableExt.oPagination.four_button = {
|
||||
"fnInit": function ( oSettings, nPaging, fnCallbackDraw ) {
|
||||
nFirst = document.createElement( 'span' );
|
||||
nPrevious = document.createElement( 'span' );
|
||||
nNext = document.createElement( 'span' );
|
||||
nLast = document.createElement( 'span' );
|
||||
|
||||
nFirst.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sFirst ) );
|
||||
nPrevious.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sPrevious ) );
|
||||
nNext.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sNext ) );
|
||||
nLast.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sLast ) );
|
||||
|
||||
nFirst.className = "paginate_button first";
|
||||
nPrevious.className = "paginate_button previous";
|
||||
nNext.className="paginate_button next";
|
||||
nLast.className = "paginate_button last";
|
||||
|
||||
nPaging.appendChild( nFirst );
|
||||
nPaging.appendChild( nPrevious );
|
||||
nPaging.appendChild( nNext );
|
||||
nPaging.appendChild( nLast );
|
||||
|
||||
$(nFirst).click( function () {
|
||||
oSettings.oApi._fnPageChange( oSettings, "first" );
|
||||
fnCallbackDraw( oSettings );
|
||||
} );
|
||||
|
||||
$(nPrevious).click( function() {
|
||||
oSettings.oApi._fnPageChange( oSettings, "previous" );
|
||||
fnCallbackDraw( oSettings );
|
||||
} );
|
||||
|
||||
$(nNext).click( function() {
|
||||
oSettings.oApi._fnPageChange( oSettings, "next" );
|
||||
fnCallbackDraw( oSettings );
|
||||
} );
|
||||
|
||||
$(nLast).click( function() {
|
||||
oSettings.oApi._fnPageChange( oSettings, "last" );
|
||||
fnCallbackDraw( oSettings );
|
||||
} );
|
||||
|
||||
$(nFirst).bind( 'selectstart', function () { return false; } );
|
||||
$(nPrevious).bind( 'selectstart', function () { return false; } );
|
||||
$(nNext).bind( 'selectstart', function () { return false; } );
|
||||
$(nLast).bind( 'selectstart', function () { return false; } );
|
||||
},
|
||||
|
||||
"fnUpdate": function ( oSettings, fnCallbackDraw ) {
|
||||
if ( !oSettings.aanFeatures.p ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Loop over each instance of the pager
|
||||
var an = oSettings.aanFeatures.p;
|
||||
for ( var i=0, iLen=an.length ; i<iLen ; i++ ) {
|
||||
var buttons = an[i].getElementsByTagName('span');
|
||||
if ( oSettings._iDisplayStart === 0 ) {
|
||||
buttons[0].className = "paginate_disabled_previous";
|
||||
buttons[1].className = "paginate_disabled_previous";
|
||||
}
|
||||
else {
|
||||
buttons[0].className = "paginate_enabled_previous";
|
||||
buttons[1].className = "paginate_enabled_previous";
|
||||
}
|
||||
|
||||
if ( oSettings.fnDisplayEnd() == oSettings.fnRecordsDisplay() ) {
|
||||
buttons[2].className = "paginate_disabled_next";
|
||||
buttons[3].className = "paginate_disabled_next";
|
||||
}
|
||||
else {
|
||||
buttons[2].className = "paginate_enabled_next";
|
||||
buttons[3].className = "paginate_enabled_next";
|
||||
}
|
||||
}
|
||||
}
|
||||
};</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" even"><a name="oSort"></a><a name="oSort_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oSort">oSort</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>Sorting plug-in methods - Sorting in DataTables is based on the detected type of the
|
||||
data column (you can add your own type detection functions, or override automatic
|
||||
detection using sType). With this specific type given to the column, DataTables will
|
||||
apply the required sort from the functions in the object. Each sort type must provide
|
||||
two mandatory methods, one each for ascending and descending sorting, and can optionally
|
||||
provide a pre-formatting method that will help speed up sorting by allowing DataTables
|
||||
to pre-format the sort data only once (rather than every time the actual sort functions
|
||||
are run). The two sorting functions are typical Javascript sort methods:
|
||||
<ul>
|
||||
<li>
|
||||
Function input parameters:
|
||||
<ul>
|
||||
<li>{<em>} Data to compare to the second parameter</li>
|
||||
<li>{</em>} Data to compare to the first parameter</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Function return:
|
||||
<ul>
|
||||
<li>{int} Sorting match: <0 if first parameter should be sorted lower than
|
||||
the second parameter, ===0 if the two parameters are equal and >0 if
|
||||
the first parameter should be sorted height than the second parameter.</li>
|
||||
</ul>
|
||||
</il>
|
||||
</ul></p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h5>Examples</h5>
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Case-sensitive string sorting, with no pre-formatting method
|
||||
$.extend( $.fn.dataTableExt.oSort, {
|
||||
"string-case-asc": function(x,y) {
|
||||
return ((x < y) ? -1 : ((x > y) ? 1 : 0));
|
||||
},
|
||||
"string-case-desc": function(x,y) {
|
||||
return ((x < y) ? 1 : ((x > y) ? -1 : 0));
|
||||
}
|
||||
} );
|
||||
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="example-code">
|
||||
<pre class="brush: js"> // Case-insensitive string sorting, with pre-formatting
|
||||
$.extend( $.fn.dataTableExt.oSort, {
|
||||
"string-pre": function(x) {
|
||||
return x.toLowerCase();
|
||||
},
|
||||
"string-asc": function(x,y) {
|
||||
return ((x < y) ? -1 : ((x > y) ? 1 : 0));
|
||||
},
|
||||
"string-desc": function(x,y) {
|
||||
return ((x < y) ? 1 : ((x > y) ? -1 : 0));
|
||||
}
|
||||
} );</pre>
|
||||
</div>
|
||||
</div></dd><dt class=" odd"><a name="oStdClasses"></a><a name="oStdClasses_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oStdClasses">oStdClasses</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>Storage for the various classes that DataTables uses</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sErrMode"></a><a name="sErrMode_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sErrMode">sErrMode</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>How should DataTables report an error. Can take the value 'alert' or 'throw'</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sVersion"></a><a name="sVersion_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sVersion">sVersion</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Version string for plug-ins to check compatibility. Allowed format is
|
||||
a.b.c.d.e where: a:int, b:int, c:int, d:string(dev|beta), e:int. d and
|
||||
e are optional</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd>
|
||||
</dl></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>
|
||||
@@ -0,0 +1,101 @@
|
||||
<!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: models - 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: models</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a>.</span> » models</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><a href="#summary_namespaces">Namespaces (5)</a></td></tr><tr><td>Properties (0)</td><td>Static properties (0)</td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Static properties (0)</td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Object models container, for the various models that DataTables has available
|
||||
to it. These models define the objects that are used to hold the active state
|
||||
and configuration of the table.</p><dl class="details">
|
||||
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="doc_summary">
|
||||
<a name="summary"></a>
|
||||
<h2>Summary</h2>
|
||||
|
||||
<div class="doc_group"><a name="summary_namespaces"></a><h3 class="subsection-title">Namespaces</h3>
|
||||
<dl>
|
||||
<dt class="even"><span class="type-name"><a href="DataTable.models.ext.html">ext</a></span></dt><dd class="even"><p>DataTables extension options and plug-ins. This namespace acts as a collection "area"
|
||||
for plug-ins that can be used to extend the default DataTables behaviour - indeed many
|
||||
of the build in methods use this method to provide their own capabilities (sorting methods
|
||||
for example). [<a href="DataTable.models.ext.html">...</a>] </p></dd><dt class="odd"><span class="type-name"><a href="DataTable.models.oColumn.html">oColumn</a></span></dt><dd class="odd"><p>Template object for the column information object in DataTables. This object
|
||||
is held in the settings aoColumns array and contains all the information that
|
||||
DataTables needs about each individual column. [<a href="DataTable.models.oColumn.html">...</a>] </p></dd><dt class="even"><span class="type-name"><a href="DataTable.models.oRow.html">oRow</a></span></dt><dd class="even"><p>Template object for the way in which DataTables holds information about
|
||||
each individual row. This is the object format used for the settings
|
||||
aoData array.</p></dd><dt class="odd"><span class="type-name"><a href="DataTable.models.oSearch.html">oSearch</a></span></dt><dd class="odd"><p>Template object for the way in which DataTables holds information about
|
||||
search information for the global filter and individual column filters.</p></dd><dt class="even"><span class="type-name"><a href="DataTable.models.oSettings.html">oSettings</a></span></dt><dd class="even"><p>DataTables settings object - this holds all the information needed for a
|
||||
given table, including configuration, data and current application of the
|
||||
table options. DataTables does not have a single instance for each DataTable
|
||||
with the settings attached to that instance, but rather instances of the
|
||||
DataTable "class" are created on-the-fly as needed (typically by a
|
||||
$().dataTable() call) and the settings object is then applied to that
|
||||
instance. [<a href="DataTable.models.oSettings.html">...</a>] </p></dd>
|
||||
</dl></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>
|
||||
@@ -0,0 +1,348 @@
|
||||
<!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: oColumn - 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: oColumn</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a>.</span> » oColumn</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 (25)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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 (25)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Template object for the column information object in DataTables. This object
|
||||
is held in the settings aoColumns array and contains all the information that
|
||||
DataTables needs about each individual column.</p>
|
||||
|
||||
<p>Note that this object is related to <a href="DataTable.defaults.columns.html">DataTable.defaults.columns</a>
|
||||
but this one is the internal data store for DataTables's cache of columns.
|
||||
It should NOT be manipulated outside of DataTables. Any configuration should
|
||||
be done through the initialisation options.</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="#aDataSort">aDataSort</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>A list of the columns that sorting should occur on when this column
|
||||
is sorted. That this property is an array allows multi-column sorting
|
||||
to be defined for a column (for example first name / last name columns
|
||||
would benefit from this). The values are integers pointing to the
|
||||
columns to be sorted on (typically it will be a single integer pointing
|
||||
at itself, but that doesn't need to be the case).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asSorting">asSorting</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Define the sorting directions that are applied to the column, in sequence
|
||||
as the column is repeatedly sorted upon - i.e. the first value is used
|
||||
as the sorting direction when the column if first sorted (clicked on).
|
||||
Sort it again (click again) and it will move on to the next index.
|
||||
Repeat until loop.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSearchable">bSearchable</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to indicate if the column is searchable, and thus should be included
|
||||
in the filtering or not.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSortable">bSortable</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Flag to indicate if the column is sortable or not.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bUseRendered">bUseRendered</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p><code>Deprecated</code> When using fnRender, you have two options for what
|
||||
to do with the data, and this property serves as the switch. Firstly, you
|
||||
can have the sorting and filtering use the rendered value (true - default),
|
||||
or you can have the sorting and filtering us the original value (false). [<a href-"#bUseRendered">...</a>] </p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bVisible">bVisible</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Flag to indicate if the column is currently visible in the table or not</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnCreatedCell">fnCreatedCell</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" even"><p>Developer definable function that is called whenever a cell is created (Ajax source,
|
||||
etc) or processed for input (DOM source). This can be used as a compliment to mRender
|
||||
allowing you to modify the DOM element (add background colour for example) when the
|
||||
element is available.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnGetData">fnGetData</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" odd"><p>Function to get data from a cell in a column. You should <b>never</b>
|
||||
access data directly through _aData internally in DataTables - always use
|
||||
the method attached to this property. It allows mData to function as
|
||||
required. This function is automatically assigned by the column
|
||||
initialisation method</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="type-signature"> :function</span></span></dt><dd class=" even"><p><code>Deprecated</code> Custom display function that will be called for the
|
||||
display of each cell in this column. [<a href-"#fnRender">...</a>] </p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnSetData">fnSetData</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" odd"><p>Function to set data for a cell in the column. You should <b>never</b>
|
||||
set the data directly to _aData internally in DataTables - always use
|
||||
this method. It allows mData to function as required. This function
|
||||
is automatically assigned by the column initialisation method</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#mData">mData</a></span><span class="type-sig"><span class="type-signature"> :function|int|string|null</span></span></dt><dd class=" even"><p>Property to read the value for the cells in the column from the data
|
||||
source array / object. If null, then the default content is used, if a
|
||||
function is given then the return from the function is used.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#mRender">mRender</a></span><span class="type-sig"><span class="type-signature"> :function|int|string|null</span></span></dt><dd class=" odd"><p>Partner property to mData which is used (only when defined) to get
|
||||
the data - i.e. it is basically the same as mData, but without the
|
||||
'set' option, and also the data fed to it is the result from mData.
|
||||
This is the rendering method to match the data method of mData.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTf">nTf</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>Unique footer TH/TD element for this column (if there is one). Not used
|
||||
in DataTables as such, but can be used for plug-ins to reference the
|
||||
footer 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="#nTh">nTh</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>Unique header TH/TD element for this column - this is what the sorting
|
||||
listener is attached to (if sorting is enabled.)</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sClass">sClass</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>The class to apply to all TD elements in the table's TBODY for the column</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sContentPadding">sContentPadding</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>When DataTables calculates the column widths to assign to each column,
|
||||
it finds the longest string in each column and then constructs a
|
||||
temporary table and reads the widths from that. The problem with this
|
||||
is that "mmm" is much wider then "iiii", but the latter is a longer
|
||||
string - thus the calculation can go wrong (doing it properly and putting
|
||||
it into an DOM object and measuring that is horribly(!) slow). Thus as
|
||||
a "work around" we provide this option. It will append its value to the
|
||||
text that is found to be the longest string for the column - i.e. padding.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sDefaultContent">sDefaultContent</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Allows a default value to be given for a column's data, and will be used
|
||||
whenever a null data source is encountered (this can be because mData
|
||||
is set to null, or because the data source itself is null).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sName">sName</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Name for the column, allowing reference to the column by name as well as
|
||||
by index (needs a lookup to work by name).</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSortDataType">sSortDataType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Custom sorting data type - defines which of the available plug-ins in
|
||||
afnSortData the custom sorting will use - if any is defined.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSortingClass">sSortingClass</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Class to be applied to the header element when sorting on this column</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSortingClassJUI">sSortingClassJUI</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Class to be applied to the header element when sorting on this column -
|
||||
when jQuery UI theming is used.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sTitle">sTitle</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Title of the column - what is seen in the TH element (nTh).</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sType">sType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Column sorting and filtering type</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sWidth">sWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Width of the column</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sWidthOrig">sWidthOrig</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Width of the column when it was first "encountered"</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="aDataSort"></a><a name="aDataSort_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aDataSort">aDataSort</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>A list of the columns that sorting should occur on when this column
|
||||
is sorted. That this property is an array allows multi-column sorting
|
||||
to be defined for a column (for example first name / last name columns
|
||||
would benefit from this). The values are integers pointing to the
|
||||
columns to be sorted on (typically it will be a single integer pointing
|
||||
at itself, but that doesn't need to be the case).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="asSorting"></a><a name="asSorting_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asSorting">asSorting</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Define the sorting directions that are applied to the column, in sequence
|
||||
as the column is repeatedly sorted upon - i.e. the first value is used
|
||||
as the sorting direction when the column if first sorted (clicked on).
|
||||
Sort it again (click again) and it will move on to the next index.
|
||||
Repeat until loop.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bSearchable"></a><a name="bSearchable_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSearchable">bSearchable</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to indicate if the column is searchable, and thus should be included
|
||||
in the filtering or not.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bSortable"></a><a name="bSortable_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSortable">bSortable</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Flag to indicate if the column is sortable or not.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bUseRendered"></a><a name="bUseRendered_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bUseRendered">bUseRendered</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p><code>Deprecated</code> When using fnRender, you have two options for what
|
||||
to do with the data, and this property serves as the switch. Firstly, you
|
||||
can have the sorting and filtering use the rendered value (true - default),
|
||||
or you can have the sorting and filtering us the original value (false).</p>
|
||||
|
||||
<p>Please note that this option has now been deprecated and will be removed
|
||||
in the next version of DataTables. Please use mRender / mData rather than
|
||||
fnRender.</p><div class="collapse_details"><dl class="details">
|
||||
<dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bVisible"></a><a name="bVisible_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bVisible">bVisible</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Flag to indicate if the column is currently visible in the table or not</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt id="DataTable.models.oColumn.fnCreatedCell" class=" even"><a name="fnCreatedCell"></a><a name="fnCreatedCell_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnCreatedCell</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" even"><p>Developer definable function that is called whenever a cell is created (Ajax source,
|
||||
etc) or processed for input (DOM source). This can be used as a compliment to mRender
|
||||
allowing you to modify the DOM element (add background colour for example) when the
|
||||
element is available.</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">nTd</td><td class="type type-param">element</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The TD node that has been created</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sData</td><td class="type type-param">*</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The Data for the cell</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">oData</td><td class="type type-param">array | object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data for the whole row</p></td></tr><tr class="odd"><td class="number right_border"><div>4</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 index for the aoData data store</p></td></tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
<dt id="DataTable.models.oColumn.fnGetData" class=" odd"><a name="fnGetData"></a><a name="fnGetData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnGetData</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" odd"><p>Function to get data from a cell in a column. You should <b>never</b>
|
||||
access data directly through _aData internally in DataTables - always use
|
||||
the method attached to this property. It allows mData to function as
|
||||
required. This function is automatically assigned by the column
|
||||
initialisation method</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">oData</td><td class="type type-param">array | object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data array/object for the array
|
||||
(i.e. aoData[]._aData)</p></td></tr><tr class="odd"><td class="number right_border"><div>2</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>The specific data type you want to get -
|
||||
'display', 'type' 'filter' 'sort'</p></td></tr>
|
||||
</tbody>
|
||||
</table><h5>Returns:</h5><p class="returns"><p>The data for the cell from the given row's data</p></p></div>
|
||||
<dt id="DataTable.models.oColumn.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="type-signature"> :function</span></span></span></dt><dd class=" even"><p><code>Deprecated</code> Custom display function that will be called for the
|
||||
display of each cell in this column.</p>
|
||||
|
||||
<p>Please note that this option has now been deprecated and will be removed
|
||||
in the next version of DataTables. Please use mRender / mData rather than
|
||||
fnRender.</p><div class="collapse_details"><dl class="details">
|
||||
<dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
|
||||
</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>Object with the following parameters:</p></td></tr><tr><td class="number right_border"></td><td class="name">o.iDataRow</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The row in aoData</p></td></tr><tr><td class="number right_border"></td><td class="name">o.iDataColumn</td><td class="type type-param">int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The column in question</p></td></tr><tr><td class="number right_border"></td><td class="name">o.aData</td><td class="type type-param">array</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data for the row in question</p></td></tr><tr><td class="number right_border"></td><td class="name">o.oSettings</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The settings object for this DataTables instance</p></td></tr>
|
||||
</tbody>
|
||||
</table><h5>Returns:</h5><p class="returns"><p>The string you which to use in the display</p></p></div>
|
||||
<dt id="DataTable.models.oColumn.fnSetData" class=" odd"><a name="fnSetData"></a><a name="fnSetData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnSetData</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" odd"><p>Function to set data for a cell in the column. You should <b>never</b>
|
||||
set the data directly to _aData internally in DataTables - always use
|
||||
this method. It allows mData to function as required. This function
|
||||
is automatically assigned by the column initialisation method</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">oData</td><td class="type type-param">array | object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>The data array/object for the array
|
||||
(i.e. aoData[]._aData)</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">*</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Value to set</p></td></tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
<dt class=" even"><a name="mData"></a><a name="mData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#mData">mData</a></span><span class="type-sig"><span class="type-signature"> :function|int|string|null</span></span></dt><dd class=" even"><p>Property to read the value for the cells in the column from the data
|
||||
source array / object. If null, then the default content is used, if a
|
||||
function is given then the return from the function is used.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="mRender"></a><a name="mRender_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#mRender">mRender</a></span><span class="type-sig"><span class="type-signature"> :function|int|string|null</span></span></dt><dd class=" odd"><p>Partner property to mData which is used (only when defined) to get
|
||||
the data - i.e. it is basically the same as mData, but without the
|
||||
'set' option, and also the data fed to it is the result from mData.
|
||||
This is the rendering method to match the data method of mData.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="nTf"></a><a name="nTf_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTf">nTf</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>Unique footer TH/TD element for this column (if there is one). Not used
|
||||
in DataTables as such, but can be used for plug-ins to reference the
|
||||
footer for each column.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="nTh"></a><a name="nTh_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTh">nTh</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>Unique header TH/TD element for this column - this is what the sorting
|
||||
listener is attached to (if sorting is enabled.)</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sClass"></a><a name="sClass_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sClass">sClass</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>The class to apply to all TD elements in the table's TBODY for the column</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sContentPadding"></a><a name="sContentPadding_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sContentPadding">sContentPadding</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>When DataTables calculates the column widths to assign to each column,
|
||||
it finds the longest string in each column and then constructs a
|
||||
temporary table and reads the widths from that. The problem with this
|
||||
is that "mmm" is much wider then "iiii", but the latter is a longer
|
||||
string - thus the calculation can go wrong (doing it properly and putting
|
||||
it into an DOM object and measuring that is horribly(!) slow). Thus as
|
||||
a "work around" we provide this option. It will append its value to the
|
||||
text that is found to be the longest string for the column - i.e. padding.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sDefaultContent"></a><a name="sDefaultContent_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sDefaultContent">sDefaultContent</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Allows a default value to be given for a column's data, and will be used
|
||||
whenever a null data source is encountered (this can be because mData
|
||||
is set to null, or because the data source itself is null).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sName"></a><a name="sName_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sName">sName</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Name for the column, allowing reference to the column by name as well as
|
||||
by index (needs a lookup to work by name).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sSortDataType"></a><a name="sSortDataType_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSortDataType">sSortDataType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Custom sorting data type - defines which of the available plug-ins in
|
||||
afnSortData the custom sorting will use - if any is defined.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sSortingClass"></a><a name="sSortingClass_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSortingClass">sSortingClass</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Class to be applied to the header element when sorting on this column</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sSortingClassJUI"></a><a name="sSortingClassJUI_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSortingClassJUI">sSortingClassJUI</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Class to be applied to the header element when sorting on this column -
|
||||
when jQuery UI theming is used.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sTitle"></a><a name="sTitle_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sTitle">sTitle</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Title of the column - what is seen in the TH element (nTh).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sType"></a><a name="sType_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sType">sType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Column sorting and filtering type</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sWidth"></a><a name="sWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sWidth">sWidth</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Width of the column</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sWidthOrig"></a><a name="sWidthOrig_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sWidthOrig">sWidthOrig</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Width of the column when it was first "encountered"</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd>
|
||||
</dl></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>
|
||||
@@ -0,0 +1,111 @@
|
||||
<!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: oRow - 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: oRow</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a>.</span> » oRow</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 (2)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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 (2)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Template object for the way in which DataTables holds information about
|
||||
each individual row. This is the object format used for the settings
|
||||
aoData array.</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="#nTr">nTr</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>TR element for the row</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_aData">_aData</a></span><span class="type-sig"><span class="type-signature"> :array|object</span></span></dt><dd class=" odd"><p>Data object from the original data source for the row. This is either
|
||||
an array if using the traditional form of DataTables, or an object if
|
||||
using mData options. The exact type will depend on the passed in
|
||||
data from the data source, or will be an array if using DOM a data
|
||||
source.</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="nTr"></a><a name="nTr_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTr">nTr</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>TR element for the row</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="_aData"></a><a name="_aData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_aData">_aData</a></span><span class="type-sig"><span class="type-signature"> :array|object</span></span></dt><dd class=" odd"><p>Data object from the original data source for the row. This is either
|
||||
an array if using the traditional form of DataTables, or an object if
|
||||
using mData options. The exact type will depend on the passed in
|
||||
data from the data source, or will be an array if using DOM a data
|
||||
source.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd>
|
||||
</dl></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>
|
||||
@@ -0,0 +1,112 @@
|
||||
<!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: oSearch - 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: oSearch</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a>.</span> » oSearch</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 (4)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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 (4)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Template object for the way in which DataTables holds information about
|
||||
search information for the global filter and individual column filters.</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="#bCaseInsensitive">bCaseInsensitive</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to indicate if the filtering should be case insensitive or not</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bRegex">bRegex</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Flag to indicate if the search term should be interpreted as a
|
||||
regular expression (true) or not (false) and therefore and special
|
||||
regex characters escaped.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSmart">bSmart</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to indicate if DataTables is to use its smart filtering or not.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSearch">sSearch</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Applied search term</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="bCaseInsensitive"></a><a name="bCaseInsensitive_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bCaseInsensitive">bCaseInsensitive</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to indicate if the filtering should be case insensitive or not</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bRegex"></a><a name="bRegex_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bRegex">bRegex</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Flag to indicate if the search term should be interpreted as a
|
||||
regular expression (true) or not (false) and therefore and special
|
||||
regex characters escaped.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bSmart"></a><a name="bSmart_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSmart">bSmart</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to indicate if DataTables is to use its smart filtering or not.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sSearch"></a><a name="sSearch_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sSearch">sSearch</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Applied search term</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd>
|
||||
</dl></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>
|
||||
@@ -0,0 +1,514 @@
|
||||
<!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: oSettings - 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: oSettings</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a>.</span> » oSettings</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><a href="#summary_namespaces">Namespaces (5)</a></td></tr><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (67)</a></td></tr><tr><td>Methods (0)</td><td><a href="#summary_methods_static">Static methods (3)</a></td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></div></li><li><a href="#details">Details</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (67)</a></td></tr><tr><td>Methods (0)</td><td><a href="#summary_methods_static">Static methods (3)</a></td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></div></li></ul>
|
||||
<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>DataTables settings object - this holds all the information needed for a
|
||||
given table, including configuration, data and current application of the
|
||||
table options. DataTables does not have a single instance for each DataTable
|
||||
with the settings attached to that instance, but rather instances of the
|
||||
DataTable "class" are created on-the-fly as needed (typically by a
|
||||
$().dataTable() call) and the settings object is then applied to that
|
||||
instance.</p>
|
||||
|
||||
<p>Note that this object is related to <a href="DataTable.defaults.html">DataTable.defaults</a> but this
|
||||
one is the internal data store for DataTables's cache of columns. It should
|
||||
NOT be manipulated outside of DataTables. Any configuration should be done
|
||||
through the initialisation options.</p><dl class="details">
|
||||
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="doc_summary">
|
||||
<a name="summary"></a>
|
||||
<h2>Summary</h2>
|
||||
|
||||
<div class="doc_group"><a name="summary_namespaces"></a><h3 class="subsection-title">Namespaces</h3>
|
||||
<dl>
|
||||
<dt class="even"><span class="type-name"><a href="DataTable.models.oSettings.oBrowser.html">oBrowser</a></span></dt><dd class="even"><p>Browser support parameters</p></dd><dt class="odd"><span class="type-name"><a href="DataTable.models.oSettings.oFeatures.html">oFeatures</a></span></dt><dd class="odd"><p>Primary features of DataTables and their enablement state.</p></dd><dt class="even"><span class="type-name"><a href="DataTable.models.oSettings.oLanguage.html">oLanguage</a></span></dt><dd class="even"><p>Language information for the table.</p></dd><dt class="odd"><span class="type-name"><a href="DataTable.models.oSettings.oPreviousSearch.html">oPreviousSearch</a></span></dt><dd class="odd"><p>Store the applied global search information in case we want to force a
|
||||
research or compare the old search to a new one.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class="even"><span class="type-name"><a href="DataTable.models.oSettings.oScroll.html">oScroll</a></span></dt><dd class="even"><p>Scrolling settings for a table.</p></dd>
|
||||
</dl></div><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="#aanFeatures">aanFeatures</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Array referencing the nodes which are used for the features. The
|
||||
parameters of this object match what is allowed by sDom - i.e.
|
||||
<ul>
|
||||
<li>'l' - Length changing</li>
|
||||
<li>'f' - Filtering input</li>
|
||||
<li>'t' - The table!</li>
|
||||
<li>'i' - Information</li>
|
||||
<li>'p' - Pagination</li>
|
||||
<li>'r' - pRocessing</li>
|
||||
</ul></p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aaSorting">aaSorting</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Sorting that is applied to the table. Note that the inner arrays are
|
||||
used in the following manner: [<a href-"#aaSorting">...</a>] </p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aaSortingFixed">aaSortingFixed</a></span><span class="type-sig"><span class="type-signature"> :array|null</span></span></dt><dd class=" even"><p>Sorting that is always applied to the table (i.e. prefixed in front of
|
||||
aaSorting).
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aiDisplay">aiDisplay</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of indexes which are in the current display (after filtering etc)</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aiDisplayMaster">aiDisplayMaster</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Array of indexes for display - no filtering</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aLengthMenu">aLengthMenu</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>List of options that can be used for the user selectable length menu.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoColumns">aoColumns</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Store information about each column that is in use</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoData">aoData</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Store data information - see <a href="DataTable.models.oRow.html">DataTable.models.oRow</a> for detailed
|
||||
information.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoDestroyCallback">aoDestroyCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Destroy callback functions - for plug-ins to attach themselves to the
|
||||
destroy so they can clean up markup and events.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoDrawCallback">aoDrawCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of callback functions for draw callback functions</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoFooter">aoFooter</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Store information about the table's footer</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoFooterCallback">aoFooterCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callback function for the footer on each draw.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoHeader">aoHeader</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Store information about the table's header</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoHeaderCallback">aoHeaderCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callback functions for the header on each draw.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoInitComplete">aoInitComplete</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callback functions for when the table has been initialised.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoOpenRows">aoOpenRows</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Information about open rows. Each object in the array has the parameters
|
||||
'nTr' and 'nParent'</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoPreDrawCallback">aoPreDrawCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callback functions for just before the table is redrawn. A return of
|
||||
false will be used to cancel the draw.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoPreSearchCols">aoPreSearchCols</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Store the applied search for each column - see
|
||||
<a href="DataTable.models.oSearch.html">DataTable.models.oSearch</a> for the format that is used for the
|
||||
filtering information for each column.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoRowCallback">aoRowCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callback functions array for every time a row is inserted (i.e. on a draw).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoRowCreatedCallback">aoRowCreatedCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of callback functions for row created function</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoServerParams">aoServerParams</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Functions which are called prior to sending an Ajax request so extra
|
||||
parameters can easily be sent to the server</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateLoad">aoStateLoad</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of callback functions for state loading. Each array element is an
|
||||
object with the following parameters:
|
||||
<ul>
|
||||
<li>function:fn - function to call. Takes two parameters, oSettings
|
||||
and the object stored. May return false to cancel state loading</li>
|
||||
<li>string:sName - name of callback</li>
|
||||
</ul></p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateLoaded">aoStateLoaded</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callbacks for operating on the settings object once the saved state has been
|
||||
loaded</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateLoadParams">aoStateLoadParams</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callbacks for modifying the settings that have been stored for state saving
|
||||
prior to using the stored values to restore the state.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateSave">aoStateSave</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Array of callback functions for state saving. Each array element is an
|
||||
object with the following parameters:
|
||||
<ul>
|
||||
<li>function:fn - function to call. Takes two parameters, oSettings
|
||||
and the JSON string to save that has been thus far created. Returns
|
||||
a JSON string to be inserted into a json object
|
||||
(i.e. '"param": [ 0, 1, 2]')</li>
|
||||
<li>string:sName - name of callback</li>
|
||||
</ul></p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateSaveParams">aoStateSaveParams</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callbacks for modifying the settings to be stored for state saving, prior to
|
||||
saving state.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asDataSearch">asDataSearch</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Search data array for regular expression searching</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asDestroyStripes">asDestroyStripes</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>If restoring a table - we should restore its striping classes as well</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asStripeClasses">asStripeClasses</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Classes to use for the striping of a table.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bAjaxDataGet">bAjaxDataGet</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Note if draw should be blocked while getting data</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bDeferLoading">bDeferLoading</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Indicate if when using server-side processing the loading of data
|
||||
should be deferred until the second draw.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bDrawing">bDrawing</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Indicate if a redraw is being done - useful for Ajax</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bFiltered">bFiltered</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag attached to the settings object so you can check in the draw
|
||||
callback if filtering has been done in the draw. Deprecated in favour of
|
||||
events.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bInitialised">bInitialised</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Indicate if all required information has been read in</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bJUI">bJUI</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to indicate if jQuery UI marking and classes should be used.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSortCellsTop">bSortCellsTop</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Indicate that if multiple rows are in the header and there is more than
|
||||
one unique cell per column, if the top one (true) or bottom one (false)
|
||||
should be used for sorting / title by DataTables.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSorted">bSorted</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag attached to the settings object so you can check in the draw
|
||||
callback if sorting has been done in the draw. Deprecated in favour of
|
||||
events.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnCookieCallback">fnCookieCallback</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" odd"><p>Callback function for cookie creation.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnFormatNumber">fnFormatNumber</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" even"><p>Format numbers for display.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnServerData">fnServerData</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" odd"><p>Function to get the server-side data.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iCookieDuration">iCookieDuration</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>The cookie duration (for bStateSave) in seconds.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iDraw">iDraw</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Counter for the draws that the table does. Also used as a tracker for
|
||||
server-side processing</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iDrawError">iDrawError</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Draw index (iDraw) of the last error when parsing the returned data</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iTabIndex">iTabIndex</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" odd"><p>tabindex attribute value that is added to DataTables control elements, allowing
|
||||
keyboard navigation of the table and its controls.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#jqXHR">jqXHR</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>The last jQuery XHR object that was used for server-side data gathering.
|
||||
This can be used for working with the XHR information in one of the
|
||||
callbacks</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nScrollFoot">nScrollFoot</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" odd"><p>DIV container for the footer scrolling table if scrolling</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nScrollHead">nScrollHead</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" even"><p>DIV container for the footer scrolling table if scrolling</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTable">nTable</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>The TABLE node for the main table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTableWrapper">nTableWrapper</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>Cache the wrapper node (contains all DataTables controlled elements)</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTBody">nTBody</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>Permanent ref to the tbody element</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTFoot">nTFoot</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>Permanent ref to the tfoot element - if it exists</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTHead">nTHead</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>Permanent ref to the thead element</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oClasses">oClasses</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>The classes to use for the table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oInit">oInit</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>Initialisation object that is used for the table</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oInstance">oInstance</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>The DataTables object for this table</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oLoadedState">oLoadedState</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>State that was loaded from the cookie. Useful for back reference</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sAjaxDataProp">sAjaxDataProp</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Property from a given object from which to read the table data from. This
|
||||
can be an empty string (when not server-side processing), in which case
|
||||
it is assumed an an array is given directly.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sAjaxSource">sAjaxSource</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Source url for AJAX data for the table.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sCookiePrefix">sCookiePrefix</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>The cookie name prefix.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sDestroyWidth">sDestroyWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>If restoring a table - we should restore its width</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sDom">sDom</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Dictate the positioning of DataTables' control elements - see
|
||||
DataTable.model.oInit.sDom.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInstance">sInstance</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Unique identifier for each instance of the DataTables object. If there
|
||||
is an ID on the table node, then it takes that value, otherwise an
|
||||
incrementing internal counter is used.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sPaginationType">sPaginationType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Which type of pagination should be used.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sServerMethod">sServerMethod</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Send the XHR HTTP method - GET or POST (could be PUT or DELETE if
|
||||
required).
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sTableId">sTableId</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Cache the table ID for quick access</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_iDisplayLength">_iDisplayLength</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Paging display length</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_iDisplayStart">_iDisplayStart</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Paging start point - aiDisplay index</p></dd>
|
||||
</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="#fnDisplayEnd">fnDisplayEnd</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Set the display end point - aiDisplay index</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnRecordsDisplay">fnRecordsDisplay</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></dt><dd class=" odd"><p>Get the number of records in the current record set, after filtering</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#fnRecordsTotal">fnRecordsTotal</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></dt><dd class=" even"><p>Get the number of records in the current record set, before filtering</p></dd>
|
||||
</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="aanFeatures"></a><a name="aanFeatures_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aanFeatures">aanFeatures</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Array referencing the nodes which are used for the features. The
|
||||
parameters of this object match what is allowed by sDom - i.e.
|
||||
<ul>
|
||||
<li>'l' - Length changing</li>
|
||||
<li>'f' - Filtering input</li>
|
||||
<li>'t' - The table!</li>
|
||||
<li>'i' - Information</li>
|
||||
<li>'p' - Pagination</li>
|
||||
<li>'r' - pRocessing</li>
|
||||
</ul></p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aaSorting"></a><a name="aaSorting_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aaSorting">aaSorting</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Sorting that is applied to the table. Note that the inner arrays are
|
||||
used in the following manner:</p>
|
||||
|
||||
<ul>
|
||||
<li>Index 0 - column number</li>
|
||||
<li>Index 1 - current sorting direction</li>
|
||||
<li>Index 2 - index of asSorting for this column</li>
|
||||
</ul>
|
||||
|
||||
<p>Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="aaSortingFixed"></a><a name="aaSortingFixed_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aaSortingFixed">aaSortingFixed</a></span><span class="type-sig"><span class="type-signature"> :array|null</span></span></dt><dd class=" even"><p>Sorting that is always applied to the table (i.e. prefixed in front of
|
||||
aaSorting).
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aiDisplay"></a><a name="aiDisplay_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aiDisplay">aiDisplay</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of indexes which are in the current display (after filtering etc)</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="aiDisplayMaster"></a><a name="aiDisplayMaster_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aiDisplayMaster">aiDisplayMaster</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Array of indexes for display - no filtering</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aLengthMenu"></a><a name="aLengthMenu_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aLengthMenu">aLengthMenu</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>List of options that can be used for the user selectable length menu.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="aoColumns"></a><a name="aoColumns_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoColumns">aoColumns</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Store information about each column that is in use</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aoData"></a><a name="aoData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoData">aoData</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Store data information - see <a href="DataTable.models.oRow.html">DataTable.models.oRow</a> for detailed
|
||||
information.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="aoDestroyCallback"></a><a name="aoDestroyCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoDestroyCallback">aoDestroyCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Destroy callback functions - for plug-ins to attach themselves to the
|
||||
destroy so they can clean up markup and events.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aoDrawCallback"></a><a name="aoDrawCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoDrawCallback">aoDrawCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of callback functions for draw callback functions</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="aoFooter"></a><a name="aoFooter_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoFooter">aoFooter</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Store information about the table's footer</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aoFooterCallback"></a><a name="aoFooterCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoFooterCallback">aoFooterCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callback function for the footer on each draw.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="aoHeader"></a><a name="aoHeader_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoHeader">aoHeader</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Store information about the table's header</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aoHeaderCallback"></a><a name="aoHeaderCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoHeaderCallback">aoHeaderCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callback functions for the header on each draw.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="aoInitComplete"></a><a name="aoInitComplete_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoInitComplete">aoInitComplete</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callback functions for when the table has been initialised.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aoOpenRows"></a><a name="aoOpenRows_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoOpenRows">aoOpenRows</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Information about open rows. Each object in the array has the parameters
|
||||
'nTr' and 'nParent'</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="aoPreDrawCallback"></a><a name="aoPreDrawCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoPreDrawCallback">aoPreDrawCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callback functions for just before the table is redrawn. A return of
|
||||
false will be used to cancel the draw.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aoPreSearchCols"></a><a name="aoPreSearchCols_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoPreSearchCols">aoPreSearchCols</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Store the applied search for each column - see
|
||||
<a href="DataTable.models.oSearch.html">DataTable.models.oSearch</a> for the format that is used for the
|
||||
filtering information for each column.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="aoRowCallback"></a><a name="aoRowCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoRowCallback">aoRowCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callback functions array for every time a row is inserted (i.e. on a draw).</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aoRowCreatedCallback"></a><a name="aoRowCreatedCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoRowCreatedCallback">aoRowCreatedCallback</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of callback functions for row created function</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="aoServerParams"></a><a name="aoServerParams_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoServerParams">aoServerParams</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Functions which are called prior to sending an Ajax request so extra
|
||||
parameters can easily be sent to the server</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aoStateLoad"></a><a name="aoStateLoad_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateLoad">aoStateLoad</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Array of callback functions for state loading. Each array element is an
|
||||
object with the following parameters:
|
||||
<ul>
|
||||
<li>function:fn - function to call. Takes two parameters, oSettings
|
||||
and the object stored. May return false to cancel state loading</li>
|
||||
<li>string:sName - name of callback</li>
|
||||
</ul></p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="aoStateLoaded"></a><a name="aoStateLoaded_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateLoaded">aoStateLoaded</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Callbacks for operating on the settings object once the saved state has been
|
||||
loaded</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aoStateLoadParams"></a><a name="aoStateLoadParams_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateLoadParams">aoStateLoadParams</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callbacks for modifying the settings that have been stored for state saving
|
||||
prior to using the stored values to restore the state.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="aoStateSave"></a><a name="aoStateSave_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateSave">aoStateSave</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Array of callback functions for state saving. Each array element is an
|
||||
object with the following parameters:
|
||||
<ul>
|
||||
<li>function:fn - function to call. Takes two parameters, oSettings
|
||||
and the JSON string to save that has been thus far created. Returns
|
||||
a JSON string to be inserted into a json object
|
||||
(i.e. '"param": [ 0, 1, 2]')</li>
|
||||
<li>string:sName - name of callback</li>
|
||||
</ul></p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="aoStateSaveParams"></a><a name="aoStateSaveParams_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#aoStateSaveParams">aoStateSaveParams</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>Callbacks for modifying the settings to be stored for state saving, prior to
|
||||
saving state.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="asDataSearch"></a><a name="asDataSearch_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asDataSearch">asDataSearch</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Search data array for regular expression searching</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="asDestroyStripes"></a><a name="asDestroyStripes_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asDestroyStripes">asDestroyStripes</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" odd"><p>If restoring a table - we should restore its striping classes as well</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="asStripeClasses"></a><a name="asStripeClasses_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#asStripeClasses">asStripeClasses</a></span><span class="type-sig"><span class="type-signature"> :array</span></span></dt><dd class=" even"><p>Classes to use for the striping of a table.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bAjaxDataGet"></a><a name="bAjaxDataGet_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bAjaxDataGet">bAjaxDataGet</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Note if draw should be blocked while getting data</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bDeferLoading"></a><a name="bDeferLoading_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bDeferLoading">bDeferLoading</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Indicate if when using server-side processing the loading of data
|
||||
should be deferred until the second draw.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bDrawing"></a><a name="bDrawing_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bDrawing">bDrawing</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Indicate if a redraw is being done - useful for Ajax</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bFiltered"></a><a name="bFiltered_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bFiltered">bFiltered</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag attached to the settings object so you can check in the draw
|
||||
callback if filtering has been done in the draw. Deprecated in favour of
|
||||
events.</p><div class="collapse_details"><dl class="details">
|
||||
<dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bInitialised"></a><a name="bInitialised_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bInitialised">bInitialised</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Indicate if all required information has been read in</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bJUI"></a><a name="bJUI_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bJUI">bJUI</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to indicate if jQuery UI marking and classes should be used.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bSortCellsTop"></a><a name="bSortCellsTop_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSortCellsTop">bSortCellsTop</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Indicate that if multiple rows are in the header and there is more than
|
||||
one unique cell per column, if the top one (true) or bottom one (false)
|
||||
should be used for sorting / title by DataTables.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bSorted"></a><a name="bSorted_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSorted">bSorted</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag attached to the settings object so you can check in the draw
|
||||
callback if sorting has been done in the draw. Deprecated in favour of
|
||||
events.</p><div class="collapse_details"><dl class="details">
|
||||
<dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
|
||||
</dl>
|
||||
</div></dd><dt id="DataTable.models.oSettings.fnCookieCallback" class=" odd"><a name="fnCookieCallback"></a><a name="fnCookieCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnCookieCallback</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" odd"><p>Callback function for cookie creation.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div>
|
||||
<dt id="DataTable.models.oSettings.fnFormatNumber" class=" even"><a name="fnFormatNumber"></a><a name="fnFormatNumber_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnFormatNumber</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" even"><p>Format numbers for display.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div>
|
||||
<dt id="DataTable.models.oSettings.fnServerData" class=" odd"><a name="fnServerData"></a><a name="fnServerData_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnServerData</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" odd"><p>Function to get the server-side data.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div>
|
||||
<dt class=" even"><a name="iCookieDuration"></a><a name="iCookieDuration_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iCookieDuration">iCookieDuration</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>The cookie duration (for bStateSave) in seconds.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="iDraw"></a><a name="iDraw_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iDraw">iDraw</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Counter for the draws that the table does. Also used as a tracker for
|
||||
server-side processing</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="iDrawError"></a><a name="iDrawError_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iDrawError">iDrawError</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Draw index (iDraw) of the last error when parsing the returned data</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="iTabIndex"></a><a name="iTabIndex_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iTabIndex">iTabIndex</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" odd"><p>tabindex attribute value that is added to DataTables control elements, allowing
|
||||
keyboard navigation of the table and its controls.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="jqXHR"></a><a name="jqXHR_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#jqXHR">jqXHR</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>The last jQuery XHR object that was used for server-side data gathering.
|
||||
This can be used for working with the XHR information in one of the
|
||||
callbacks</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="nScrollFoot"></a><a name="nScrollFoot_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nScrollFoot">nScrollFoot</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" odd"><p>DIV container for the footer scrolling table if scrolling</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="nScrollHead"></a><a name="nScrollHead_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nScrollHead">nScrollHead</a></span><span class="type-sig"><span class="type-signature"></span></span></dt><dd class=" even"><p>DIV container for the footer scrolling table if scrolling</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="nTable"></a><a name="nTable_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTable">nTable</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>The TABLE node for the main table</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="nTableWrapper"></a><a name="nTableWrapper_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTableWrapper">nTableWrapper</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>Cache the wrapper node (contains all DataTables controlled elements)</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="nTBody"></a><a name="nTBody_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTBody">nTBody</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>Permanent ref to the tbody element</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="nTFoot"></a><a name="nTFoot_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTFoot">nTFoot</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" even"><p>Permanent ref to the tfoot element - if it exists</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="nTHead"></a><a name="nTHead_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#nTHead">nTHead</a></span><span class="type-sig"><span class="type-signature"> :node</span></span></dt><dd class=" odd"><p>Permanent ref to the thead element</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="oClasses"></a><a name="oClasses_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oClasses">oClasses</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>The classes to use for the table</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="oInit"></a><a name="oInit_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oInit">oInit</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>Initialisation object that is used for the table</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="oInstance"></a><a name="oInstance_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oInstance">oInstance</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" even"><p>The DataTables object for this table</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="oLoadedState"></a><a name="oLoadedState_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#oLoadedState">oLoadedState</a></span><span class="type-sig"><span class="type-signature"> :object</span></span></dt><dd class=" odd"><p>State that was loaded from the cookie. Useful for back reference</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sAjaxDataProp"></a><a name="sAjaxDataProp_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sAjaxDataProp">sAjaxDataProp</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Property from a given object from which to read the table data from. This
|
||||
can be an empty string (when not server-side processing), in which case
|
||||
it is assumed an an array is given directly.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sAjaxSource"></a><a name="sAjaxSource_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sAjaxSource">sAjaxSource</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Source url for AJAX data for the table.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sCookiePrefix"></a><a name="sCookiePrefix_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sCookiePrefix">sCookiePrefix</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>The cookie name prefix.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sDestroyWidth"></a><a name="sDestroyWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sDestroyWidth">sDestroyWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>If restoring a table - we should restore its width</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sDom"></a><a name="sDom_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sDom">sDom</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Dictate the positioning of DataTables' control elements - see
|
||||
DataTable.model.oInit.sDom.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sInstance"></a><a name="sInstance_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sInstance">sInstance</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Unique identifier for each instance of the DataTables object. If there
|
||||
is an ID on the table node, then it takes that value, otherwise an
|
||||
incrementing internal counter is used.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sPaginationType"></a><a name="sPaginationType_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sPaginationType">sPaginationType</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Which type of pagination should be used.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sServerMethod"></a><a name="sServerMethod_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sServerMethod">sServerMethod</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Send the XHR HTTP method - GET or POST (could be PUT or DELETE if
|
||||
required).
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sTableId"></a><a name="sTableId_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sTableId">sTableId</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Cache the table ID for quick access</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="_iDisplayLength"></a><a name="_iDisplayLength_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_iDisplayLength">_iDisplayLength</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Paging display length</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="_iDisplayStart"></a><a name="_iDisplayStart_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#_iDisplayStart">_iDisplayStart</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Paging start point - aiDisplay index</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</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.models.oSettings.fnDisplayEnd" class=" even"><a name="fnDisplayEnd"></a><a name="fnDisplayEnd_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnDisplayEnd</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Set the display end point - aiDisplay index</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div>
|
||||
<dt id="DataTable.models.oSettings.fnRecordsDisplay" class=" odd"><a name="fnRecordsDisplay"></a><a name="fnRecordsDisplay_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnRecordsDisplay</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></span></dt><dd class=" odd"><p>Get the number of records in the current record set, after filtering</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div>
|
||||
<dt id="DataTable.models.oSettings.fnRecordsTotal" class=" even"><a name="fnRecordsTotal"></a><a name="fnRecordsTotal_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnRecordsTotal</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"></span></span></span></dt><dd class=" even"><p>Get the number of records in the current record set, before filtering</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</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>
|
||||
@@ -0,0 +1,100 @@
|
||||
<!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: oBrowser - 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: oBrowser</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a> » <a href="DataTable.models.oSettings.html">.oSettings</a>.</span> » oBrowser</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>Static methods (0)</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>Static methods (0)</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>Browser support parameters</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="#bScrollOversize">bScrollOversize</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Indicate if the browser incorrectly calculates width:100% inside a
|
||||
scrolling element (IE6/7)</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="bScrollOversize"></a><a name="bScrollOversize_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bScrollOversize">bScrollOversize</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Indicate if the browser incorrectly calculates width:100% inside a
|
||||
scrolling element (IE6/7)</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd>
|
||||
</dl></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>
|
||||
@@ -0,0 +1,200 @@
|
||||
<!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: oFeatures - 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: oFeatures</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a> » <a href="DataTable.models.oSettings.html">.oSettings</a>.</span> » oFeatures</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 (11)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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 (11)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Primary features of DataTables and their enablement state.</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="#bAutoWidth">bAutoWidth</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to say if DataTables should automatically try to calculate the
|
||||
optimum table and columns widths (true) or not (false).
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bDeferRender">bDeferRender</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Delay the creation of TR and TD elements until they are actually
|
||||
needed by a driven page draw. This can give a significant speed
|
||||
increase for Ajax source and Javascript source data, but makes no
|
||||
difference at all fro DOM and server-side processing tables.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bFilter">bFilter</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Enable filtering on the table or not. Note that if this is disabled
|
||||
then there is no filtering at all on the table, including fnFilter.
|
||||
To just remove the filtering input use sDom and remove the 'f' option.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bInfo">bInfo</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Table information element (the 'Showing x of y records' div) enable
|
||||
flag.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bLengthChange">bLengthChange</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Present a user control allowing the end user to change the page size
|
||||
when pagination is enabled.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bPaginate">bPaginate</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Pagination enabled or not. Note that if this is disabled then length
|
||||
changing must also be disabled.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bProcessing">bProcessing</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Processing indicator enable flag whenever DataTables is enacting a
|
||||
user request - typically an Ajax request for server-side processing.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bServerSide">bServerSide</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Server-side processing enabled flag - when enabled DataTables will
|
||||
get all data from the server for every draw - there is no filtering,
|
||||
sorting or paging done on the client-side.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSort">bSort</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Sorting enablement flag.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSortClasses">bSortClasses</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Apply a class to the columns which are being sorted to provide a
|
||||
visual highlight or not. This can slow things down when enabled since
|
||||
there is a lot of DOM interaction.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bStateSave">bStateSave</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>State saving enablement flag.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</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="bAutoWidth"></a><a name="bAutoWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bAutoWidth">bAutoWidth</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Flag to say if DataTables should automatically try to calculate the
|
||||
optimum table and columns widths (true) or not (false).
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bDeferRender"></a><a name="bDeferRender_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bDeferRender">bDeferRender</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Delay the creation of TR and TD elements until they are actually
|
||||
needed by a driven page draw. This can give a significant speed
|
||||
increase for Ajax source and Javascript source data, but makes no
|
||||
difference at all fro DOM and server-side processing tables.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bFilter"></a><a name="bFilter_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bFilter">bFilter</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Enable filtering on the table or not. Note that if this is disabled
|
||||
then there is no filtering at all on the table, including fnFilter.
|
||||
To just remove the filtering input use sDom and remove the 'f' option.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bInfo"></a><a name="bInfo_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bInfo">bInfo</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Table information element (the 'Showing x of y records' div) enable
|
||||
flag.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bLengthChange"></a><a name="bLengthChange_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bLengthChange">bLengthChange</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Present a user control allowing the end user to change the page size
|
||||
when pagination is enabled.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bPaginate"></a><a name="bPaginate_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bPaginate">bPaginate</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Pagination enabled or not. Note that if this is disabled then length
|
||||
changing must also be disabled.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bProcessing"></a><a name="bProcessing_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bProcessing">bProcessing</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Processing indicator enable flag whenever DataTables is enacting a
|
||||
user request - typically an Ajax request for server-side processing.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bServerSide"></a><a name="bServerSide_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bServerSide">bServerSide</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Server-side processing enabled flag - when enabled DataTables will
|
||||
get all data from the server for every draw - there is no filtering,
|
||||
sorting or paging done on the client-side.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bSort"></a><a name="bSort_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSort">bSort</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Sorting enablement flag.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bSortClasses"></a><a name="bSortClasses_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bSortClasses">bSortClasses</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>Apply a class to the columns which are being sorted to provide a
|
||||
visual highlight or not. This can slow things down when enabled since
|
||||
there is a lot of DOM interaction.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bStateSave"></a><a name="bStateSave_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bStateSave">bStateSave</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>State saving enablement flag.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd>
|
||||
</dl></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>
|
||||
@@ -0,0 +1,105 @@
|
||||
<!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: oLanguage - 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: oLanguage</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a> » <a href="DataTable.models.oSettings.html">.oSettings</a>.</span> » oLanguage</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>Static methods (0)</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>Static methods (0)</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>Language information for the table.</p><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h3 class="subsection-title">Extends</h3>
|
||||
<ul>
|
||||
<li><a href="DataTable.defaults.oLanguage.html">DataTable.defaults.oLanguage</a></li>
|
||||
</ul>
|
||||
|
||||
</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="#fnInfoCallback">fnInfoCallback</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></dt><dd class=" even"><p>Information callback function. See
|
||||
<a href="DataTable.defaults.html#fnInfoCallback">DataTable.defaults.fnInfoCallback</a></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 id="DataTable.models.oSettings.oLanguage.fnInfoCallback" class=" even"><a name="fnInfoCallback"></a><a name="fnInfoCallback_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a>fnInfoCallback</a></span><span class="type-sig"><span class="type-signature"> :function</span></span></span></dt><dd class=" even"><p>Information callback function. See
|
||||
<a href="DataTable.defaults.html#fnInfoCallback">DataTable.defaults.fnInfoCallback</a></p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
</dl></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>
|
||||
@@ -0,0 +1,82 @@
|
||||
<!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: oPreviousSearch - 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: oPreviousSearch</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a> » <a href="DataTable.models.oSettings.html">.oSettings</a>.</span> » oPreviousSearch</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>Static properties (0)</td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Static properties (0)</td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Store the applied global search information in case we want to force a
|
||||
research or compare the old search to a new one.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><dl class="details">
|
||||
|
||||
</dl>
|
||||
<h3 class="subsection-title">Extends</h3>
|
||||
<ul>
|
||||
<li><a href="DataTable.models.oSearch.html">DataTable.models.oSearch</a></li>
|
||||
</ul>
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,167 @@
|
||||
<!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: oScroll - 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: oScroll</h1>
|
||||
<h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a> » <a href="DataTable.models.oSettings.html">.oSettings</a>.</span> » oScroll</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 (8)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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 (8)</a></td></tr><tr><td>Methods (0)</td><td>Static methods (0)</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>Scrolling settings for a table.</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="#bAutoCss">bAutoCss</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Indicate if DataTables should be allowed to set the padding / margin
|
||||
etc for the scrolling header elements or not. Typically you will want
|
||||
this.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bCollapse">bCollapse</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>When the table is shorter in height than sScrollY, collapse the
|
||||
table container down to the height of the table (when true).
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bInfinite">bInfinite</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Infinite scrolling enablement flag. Now deprecated in favour of
|
||||
using the Scroller plug-in.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iBarWidth">iBarWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Width of the scrollbar for the web-browser's platform. Calculated
|
||||
during table initialisation.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iLoadGap">iLoadGap</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Space (in pixels) between the bottom of the scrolling container and
|
||||
the bottom of the scrolling viewport before the next page is loaded
|
||||
when using infinite scrolling.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sX">sX</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Viewport width for horizontal scrolling. Horizontal scrolling is
|
||||
disabled if an empty string.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sXInner">sXInner</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Width to expand the table to when using x-scrolling. Typically you
|
||||
should not need to use this.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sY">sY</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Viewport height for vertical scrolling. Vertical scrolling is disabled
|
||||
if an empty string.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</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="bAutoCss"></a><a name="bAutoCss_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bAutoCss">bAutoCss</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Indicate if DataTables should be allowed to set the padding / margin
|
||||
etc for the scrolling header elements or not. Typically you will want
|
||||
this.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="bCollapse"></a><a name="bCollapse_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bCollapse">bCollapse</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" odd"><p>When the table is shorter in height than sScrollY, collapse the
|
||||
table container down to the height of the table (when true).
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="bInfinite"></a><a name="bInfinite_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#bInfinite">bInfinite</a></span><span class="type-sig"><span class="type-signature"> :boolean</span></span></dt><dd class=" even"><p>Infinite scrolling enablement flag. Now deprecated in favour of
|
||||
using the Scroller plug-in.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="iBarWidth"></a><a name="iBarWidth_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iBarWidth">iBarWidth</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" odd"><p>Width of the scrollbar for the web-browser's platform. Calculated
|
||||
during table initialisation.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="iLoadGap"></a><a name="iLoadGap_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#iLoadGap">iLoadGap</a></span><span class="type-sig"><span class="type-signature"> :int</span></span></dt><dd class=" even"><p>Space (in pixels) between the bottom of the scrolling container and
|
||||
the bottom of the scrolling viewport before the next page is loaded
|
||||
when using infinite scrolling.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sX"></a><a name="sX_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sX">sX</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Viewport width for horizontal scrolling. Horizontal scrolling is
|
||||
disabled if an empty string.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd><dt class=" even"><a name="sXInner"></a><a name="sXInner_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sXInner">sXInner</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" even"><p>Width to expand the table to when using x-scrolling. Typically you
|
||||
should not need to use this.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
<dt class="important">Deprecated</dt><dd class="yes-def">Yes</dd>
|
||||
</dl>
|
||||
</div></dd><dt class=" odd"><a name="sY"></a><a name="sY_details"></a><span class="type-attr"><span class="type-signature"><static> </span></span><span class="type-name"><a href="#sY">sY</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class=" odd"><p>Viewport height for vertical scrolling. Vertical scrolling is disabled
|
||||
if an empty string.
|
||||
Note that this parameter will be set by the initialisation routine. To
|
||||
set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
|
||||
|
||||
</dl>
|
||||
</div></dd>
|
||||
</dl></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>
|
||||
@@ -0,0 +1,48 @@
|
||||
<!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>Table of Contents - 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">
|
||||
</div>
|
||||
|
||||
<div class="fw_content">
|
||||
<h3 class="subsection-title">Table of Contents</h3>
|
||||
<dl>
|
||||
<dt><a href="DataTable.html">DataTable</a></dt><dd><p>DataTables is a plug-in for the jQuery Javascript library. It is a
|
||||
highly flexible tool, based upon the foundations of progressive
|
||||
enhancement, which will add advanced interaction controls to any
|
||||
HTML table. For a full list of features please refer to
|
||||
<a href="http://datatables.net">DataTables.net</a>.</p>
|
||||
|
||||
<p>Note that the <i>DataTable</i> object is not a global variable but is
|
||||
aliased to <i>jQuery.fn.DataTable</i> and <i>jQuery.fn.dataTable</i> through which
|
||||
it may be accessed.</p></dd>
|
||||
</dl>
|
||||
</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>
|
||||
@@ -0,0 +1,393 @@
|
||||
/*
|
||||
Copyright (c) 2006, Yahoo! Inc. All rights reserved.
|
||||
Code licensed under the BSD License:
|
||||
http://developer.yahoo.net/yui/license.txt
|
||||
version: 0.12.0
|
||||
*/
|
||||
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,form,fieldset,input,textarea,p,blockquote,th,td{margin:0;padding:0;}
|
||||
table{border-collapse:collapse;border-spacing:0;}
|
||||
fieldset,img{border:0;}
|
||||
address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}
|
||||
ol,ul {list-style:none;}
|
||||
caption,th {text-align:left;}
|
||||
h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}
|
||||
q:before,q:after{content:'';}
|
||||
abbr,acronym {border:0;}
|
||||
|
||||
|
||||
html, body {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
width: 100%;
|
||||
font: 14px/1.45em "Lucida Grande", Verdana, Arial, Helvetica, sans-serif;
|
||||
color: #111;
|
||||
}
|
||||
|
||||
div.fw_container {
|
||||
width: 980px;
|
||||
padding-top: 2em;
|
||||
margin: 0 auto;
|
||||
}
|
||||
|
||||
div.fw_header {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
div.fw_content {
|
||||
padding-top: 2em;
|
||||
}
|
||||
|
||||
div.fw_footer {
|
||||
padding-top: 4em;
|
||||
font-size: 75%;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
.type-attr .type-signature {
|
||||
background-color: #ccc;
|
||||
color: white;
|
||||
border-radius: 3px;
|
||||
display: inline-block;
|
||||
padding: 0 3px;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
.type-attr {
|
||||
float: right;
|
||||
color: #999;
|
||||
}
|
||||
|
||||
.type-name {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.type-sig {
|
||||
color: #999;
|
||||
}
|
||||
|
||||
.type-param {
|
||||
color: #D32929;
|
||||
}
|
||||
|
||||
.type-return {
|
||||
color: #FF8080;
|
||||
}
|
||||
|
||||
.type-brace {
|
||||
color: #111;
|
||||
}
|
||||
|
||||
.example-code {
|
||||
margin-left: 30px;
|
||||
}
|
||||
.example-code td.code {
|
||||
border-top: 1px solid #4E6CA3 !important;
|
||||
}
|
||||
|
||||
.type-augmented {
|
||||
position: absolute;
|
||||
left: 8px;
|
||||
top: 0;
|
||||
}
|
||||
|
||||
dt, dd {
|
||||
padding: 0.4em 10px;
|
||||
}
|
||||
|
||||
dt {
|
||||
padding-bottom: 0 !important;
|
||||
}
|
||||
|
||||
dd {
|
||||
position: relative;
|
||||
padding-top: 0 !important;
|
||||
padding-left: 3em;
|
||||
}
|
||||
|
||||
dt.even, dd.even {
|
||||
background-color: white;
|
||||
}
|
||||
|
||||
dt.odd, dd.odd {
|
||||
background-color: #F2F2F2;
|
||||
}
|
||||
|
||||
div.doc_overview dd, div.doc_overview dt {
|
||||
padding-left: 0 !important;
|
||||
}
|
||||
|
||||
|
||||
|
||||
.right_border div {
|
||||
width: 20px;
|
||||
padding: 2px 0.5em 2px 1em;
|
||||
text-align: right;
|
||||
}
|
||||
.right_border {
|
||||
border-right: 3px solid #4E6CA3;
|
||||
}
|
||||
.bottom_border {
|
||||
border-bottom: 1px solid #4E6CA3;
|
||||
}
|
||||
|
||||
|
||||
a {
|
||||
text-decoration: none;
|
||||
color: #4E6CA3;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
cursor: pointer;
|
||||
*cursor: hand;
|
||||
}
|
||||
|
||||
div.fw_content ul {
|
||||
list-style-image: url('../images/arrow.png');
|
||||
padding: 0 0 0 2em;
|
||||
}
|
||||
|
||||
/*
|
||||
h2 {
|
||||
font-size: 1.4em;
|
||||
margin-top: 2em;
|
||||
border-bottom: 3px solid #829ac6;
|
||||
padding-left: 5px;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 1.2em;
|
||||
margin-top: 1em;
|
||||
border-bottom: 1px solid #A4B5D5;
|
||||
padding-left: 5px;
|
||||
}
|
||||
*/
|
||||
|
||||
h1 {
|
||||
font-size: 2em;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 1.6em;
|
||||
padding-top: 5px;
|
||||
}
|
||||
|
||||
h2.ancestors {
|
||||
font-size: 14px;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 1.3em;
|
||||
padding-top: 5px;
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
h5 {
|
||||
padding-top: 6px;
|
||||
font-weight: bold;
|
||||
font-size: 0.9em;
|
||||
border-bottom: 1px solid #cad4e6;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
div.doc_summary, div.doc_details {
|
||||
margin-top: 2em;
|
||||
clear: both;
|
||||
}
|
||||
|
||||
div.doc_group {
|
||||
margin-top: 1em;
|
||||
border-top: 1px solid #A4B5D5;
|
||||
border-left: 1px solid #A4B5D5;
|
||||
padding-left: 10px;
|
||||
}
|
||||
|
||||
div.extended {
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
table.params {
|
||||
margin-left: 30px;
|
||||
width: 97%;
|
||||
}
|
||||
|
||||
table.params th,
|
||||
table.params td {
|
||||
padding: 3px;
|
||||
}
|
||||
|
||||
tr.odd {
|
||||
background-color: white;
|
||||
}
|
||||
|
||||
tr.even {
|
||||
background-color: #F8F8F8;
|
||||
}
|
||||
|
||||
th.name,
|
||||
td.name {
|
||||
padding-left: 13px;
|
||||
}
|
||||
|
||||
td.number {
|
||||
background-color: white;
|
||||
color: #5C5C5C;
|
||||
}
|
||||
|
||||
dd.odd td.number {
|
||||
background-color: #F2F2F2;
|
||||
}
|
||||
|
||||
p {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
p:first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
p:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
p.returns {
|
||||
margin-left: 5%;
|
||||
}
|
||||
|
||||
div.page-info {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
right: 0;
|
||||
}
|
||||
|
||||
|
||||
.private {
|
||||
display: none;
|
||||
}
|
||||
|
||||
|
||||
code {
|
||||
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
|
||||
padding: 2px 4px !important;
|
||||
white-space: pre;
|
||||
font-size: 0.9em;
|
||||
|
||||
color: #D14;
|
||||
background-color: #F7F7F9;
|
||||
|
||||
border: 1px solid #E1E1E8;
|
||||
-webkit-border-radius: 3px;
|
||||
-moz-border-radius: 3px;
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
pre {
|
||||
background-color: #f8f8f8;
|
||||
border: 1px solid #ccc;
|
||||
border-radius: 3px;
|
||||
padding: 6px 10px;
|
||||
}
|
||||
|
||||
pre>code {
|
||||
background-color: transparent;
|
||||
border: none;
|
||||
color: #111;
|
||||
}
|
||||
|
||||
strong {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
em {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
ol {
|
||||
list-style-type: decimal;
|
||||
list-style-position: outside;
|
||||
padding-left: 30px;
|
||||
}
|
||||
|
||||
|
||||
|
||||
div.fw_nav {
|
||||
position: fixed;
|
||||
top: 25px;
|
||||
right: 30px;
|
||||
width: 250px;
|
||||
border: 1px solid #A4B5D5;
|
||||
background-color: white;
|
||||
padding: 10px;
|
||||
z-index: 1001;
|
||||
font-size: 12px;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
div.fw_nav h2 {
|
||||
margin: -10px 0 10px -10px;
|
||||
width: 250px;
|
||||
padding: 5px 10px;
|
||||
background-color: #A4B5D5;
|
||||
font-size: 12px;
|
||||
cursor: pointer;
|
||||
*cursor: hand;
|
||||
}
|
||||
|
||||
div.fw_nav ul>li>div {
|
||||
padding: 0 0 0 1em;
|
||||
}
|
||||
|
||||
div.nav_blocker {
|
||||
float: right;
|
||||
}
|
||||
|
||||
div.fw_nav td {
|
||||
color: #999;
|
||||
}
|
||||
|
||||
div.fw_nav li {
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
div.fw_nav li>a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
.css_clear {
|
||||
clear: both;
|
||||
height: 0;
|
||||
line-height: 0;
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
.css_right {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
.css_center {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.css_spacing {
|
||||
margin-top: 1.5em;
|
||||
}
|
||||
|
||||
.css_small {
|
||||
font-size: 75%;
|
||||
line-height: 1.45em;
|
||||
}
|
||||
|
||||
.css_vsmall {
|
||||
font-size: 65%;
|
||||
line-height: 1.45em;
|
||||
}
|
||||
@@ -0,0 +1,226 @@
|
||||
/**
|
||||
* SyntaxHighlighter
|
||||
* http://alexgorbatchev.com/SyntaxHighlighter
|
||||
*
|
||||
* SyntaxHighlighter is donationware. If you are using it, please donate.
|
||||
* http://alexgorbatchev.com/SyntaxHighlighter/donate.html
|
||||
*
|
||||
* @version
|
||||
* 3.0.83 (July 02 2010)
|
||||
*
|
||||
* @copyright
|
||||
* Copyright (C) 2004-2010 Alex Gorbatchev.
|
||||
*
|
||||
* @license
|
||||
* Dual licensed under the MIT and GPL licenses.
|
||||
*/
|
||||
.syntaxhighlighter a,
|
||||
.syntaxhighlighter div,
|
||||
.syntaxhighlighter code,
|
||||
.syntaxhighlighter table,
|
||||
.syntaxhighlighter table td,
|
||||
.syntaxhighlighter table tr,
|
||||
.syntaxhighlighter table tbody,
|
||||
.syntaxhighlighter table thead,
|
||||
.syntaxhighlighter table caption,
|
||||
.syntaxhighlighter textarea {
|
||||
-moz-border-radius: 0 0 0 0 !important;
|
||||
-webkit-border-radius: 0 0 0 0 !important;
|
||||
background: none !important;
|
||||
border: 0 !important;
|
||||
bottom: auto !important;
|
||||
float: none !important;
|
||||
height: auto !important;
|
||||
left: auto !important;
|
||||
line-height: 1.1em !important;
|
||||
margin: 0 !important;
|
||||
outline: 0 !important;
|
||||
overflow: visible !important;
|
||||
padding: 0 !important;
|
||||
position: static !important;
|
||||
right: auto !important;
|
||||
text-align: left !important;
|
||||
top: auto !important;
|
||||
vertical-align: baseline !important;
|
||||
width: auto !important;
|
||||
box-sizing: content-box !important;
|
||||
font-family: "Consolas","Monaco","Bitstream Vera Sans Mono","Courier New",Courier,monospace !important;
|
||||
font-weight: normal !important;
|
||||
font-style: normal !important;
|
||||
font-size: 1em !important;
|
||||
min-height: inherit !important;
|
||||
min-height: auto !important;
|
||||
}
|
||||
|
||||
.syntaxhighlighter {
|
||||
width: 100% !important;
|
||||
margin: 1em 0 1em 0 !important;
|
||||
position: relative !important;
|
||||
overflow: auto !important;
|
||||
font-size: 1em !important;
|
||||
}
|
||||
.syntaxhighlighter.source {
|
||||
overflow: hidden !important;
|
||||
}
|
||||
.syntaxhighlighter .bold {
|
||||
font-weight: bold !important;
|
||||
}
|
||||
.syntaxhighlighter .italic {
|
||||
font-style: italic !important;
|
||||
}
|
||||
.syntaxhighlighter .line {
|
||||
white-space: pre !important;
|
||||
}
|
||||
.syntaxhighlighter table {
|
||||
width: 100% !important;
|
||||
}
|
||||
.syntaxhighlighter table caption {
|
||||
text-align: left !important;
|
||||
padding: .5em 0 0.5em 1em !important;
|
||||
}
|
||||
.syntaxhighlighter table td.code {
|
||||
width: 100% !important;
|
||||
}
|
||||
.syntaxhighlighter table td.code .container {
|
||||
position: relative !important;
|
||||
}
|
||||
.syntaxhighlighter table td.code .container textarea {
|
||||
box-sizing: border-box !important;
|
||||
position: absolute !important;
|
||||
left: 0 !important;
|
||||
top: 0 !important;
|
||||
width: 100% !important;
|
||||
height: 100% !important;
|
||||
border: none !important;
|
||||
background: white !important;
|
||||
padding-left: 1em !important;
|
||||
overflow: hidden !important;
|
||||
white-space: pre !important;
|
||||
}
|
||||
.syntaxhighlighter table td.gutter .line {
|
||||
text-align: right !important;
|
||||
padding: 2px 0.5em 2px 1em !important;
|
||||
}
|
||||
.syntaxhighlighter table td.code .line {
|
||||
padding: 2px 1em !important;
|
||||
}
|
||||
.syntaxhighlighter.nogutter td.code .container textarea, .syntaxhighlighter.nogutter td.code .line {
|
||||
padding-left: 0em !important;
|
||||
}
|
||||
.syntaxhighlighter.show {
|
||||
display: block !important;
|
||||
}
|
||||
.syntaxhighlighter.collapsed table {
|
||||
display: none !important;
|
||||
}
|
||||
.syntaxhighlighter.collapsed .toolbar {
|
||||
padding: 0.1em 0.8em 0em 0.8em !important;
|
||||
font-size: 1em !important;
|
||||
position: static !important;
|
||||
width: auto !important;
|
||||
height: auto !important;
|
||||
}
|
||||
.syntaxhighlighter.collapsed .toolbar span {
|
||||
display: inline !important;
|
||||
margin-right: 1em !important;
|
||||
}
|
||||
.syntaxhighlighter.collapsed .toolbar span a {
|
||||
padding: 0 !important;
|
||||
display: none !important;
|
||||
}
|
||||
.syntaxhighlighter.collapsed .toolbar span a.expandSource {
|
||||
display: inline !important;
|
||||
}
|
||||
.syntaxhighlighter .toolbar {
|
||||
position: absolute !important;
|
||||
right: 1px !important;
|
||||
top: 1px !important;
|
||||
width: 11px !important;
|
||||
height: 11px !important;
|
||||
font-size: 10px !important;
|
||||
z-index: 10 !important;
|
||||
}
|
||||
.syntaxhighlighter .toolbar span.title {
|
||||
display: inline !important;
|
||||
}
|
||||
.syntaxhighlighter .toolbar a {
|
||||
display: block !important;
|
||||
text-align: center !important;
|
||||
text-decoration: none !important;
|
||||
padding-top: 1px !important;
|
||||
}
|
||||
.syntaxhighlighter .toolbar a.expandSource {
|
||||
display: none !important;
|
||||
}
|
||||
.syntaxhighlighter.ie {
|
||||
font-size: .9em !important;
|
||||
padding: 1px 0 1px 0 !important;
|
||||
}
|
||||
.syntaxhighlighter.ie .toolbar {
|
||||
line-height: 8px !important;
|
||||
}
|
||||
.syntaxhighlighter.ie .toolbar a {
|
||||
padding-top: 0px !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .line.alt1 .content,
|
||||
.syntaxhighlighter.printing .line.alt2 .content,
|
||||
.syntaxhighlighter.printing .line.highlighted .number,
|
||||
.syntaxhighlighter.printing .line.highlighted.alt1 .content,
|
||||
.syntaxhighlighter.printing .line.highlighted.alt2 .content {
|
||||
background: none !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .line .number {
|
||||
color: #bbbbbb !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .line .content {
|
||||
color: black !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .toolbar {
|
||||
display: none !important;
|
||||
}
|
||||
.syntaxhighlighter.printing a {
|
||||
text-decoration: none !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .plain, .syntaxhighlighter.printing .plain a {
|
||||
color: black !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .comments, .syntaxhighlighter.printing .comments a {
|
||||
color: #008200 !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .string, .syntaxhighlighter.printing .string a {
|
||||
color: blue !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .keyword {
|
||||
color: #006699 !important;
|
||||
font-weight: bold !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .preprocessor {
|
||||
color: gray !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .variable {
|
||||
color: #aa7700 !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .value {
|
||||
color: #009900 !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .functions {
|
||||
color: #ff1493 !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .constants {
|
||||
color: #0066cc !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .script {
|
||||
font-weight: bold !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .color1, .syntaxhighlighter.printing .color1 a {
|
||||
color: gray !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .color2, .syntaxhighlighter.printing .color2 a {
|
||||
color: #ff1493 !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .color3, .syntaxhighlighter.printing .color3 a {
|
||||
color: red !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .break, .syntaxhighlighter.printing .break a {
|
||||
color: black !important;
|
||||
}
|
||||
@@ -0,0 +1,128 @@
|
||||
/**
|
||||
* SyntaxHighlighter
|
||||
* http://alexgorbatchev.com/SyntaxHighlighter
|
||||
*
|
||||
* SyntaxHighlighter is donationware. If you are using it, please donate.
|
||||
* http://alexgorbatchev.com/SyntaxHighlighter/donate.html
|
||||
*
|
||||
* @version
|
||||
* 3.0.83 (July 02 2010)
|
||||
*
|
||||
* @copyright
|
||||
* Copyright (C) 2004-2010 Alex Gorbatchev.
|
||||
*
|
||||
* @license
|
||||
* Dual licensed under the MIT and GPL licenses.
|
||||
*/
|
||||
.syntaxhighlighter {
|
||||
background-color: white !important;
|
||||
font-size: 14px !important;
|
||||
overflow: visible !important;
|
||||
}
|
||||
.syntaxhighlighter .line.alt1 {
|
||||
background-color: white !important;
|
||||
}
|
||||
.syntaxhighlighter .line.alt2 {
|
||||
background-color: #F8F8F8 !important;
|
||||
}
|
||||
.syntaxhighlighter .line.highlighted.alt1, .syntaxhighlighter .line.highlighted.alt2 {
|
||||
background-color: #e0e0e0 !important;
|
||||
}
|
||||
.syntaxhighlighter .line.highlighted.number {
|
||||
color: black !important;
|
||||
}
|
||||
.syntaxhighlighter table caption {
|
||||
color: black !important;
|
||||
}
|
||||
.syntaxhighlighter .gutter {
|
||||
}
|
||||
.syntaxhighlighter .gutter div {
|
||||
color: #5C5C5C !important;
|
||||
width: 20px !important;
|
||||
}
|
||||
.syntaxhighlighter .gutter .line.alt1, .syntaxhighlighter .gutter .line.alt2 {
|
||||
background-color: white !important;
|
||||
}
|
||||
.odd .syntaxhighlighter .gutter .line.alt1, .odd .syntaxhighlighter .gutter .line.alt2 {
|
||||
background-color: #F2F2F2 !important;
|
||||
}
|
||||
.syntaxhighlighter .gutter .line {
|
||||
border-right: 3px solid #4E6CA3 !important;
|
||||
}
|
||||
.syntaxhighlighter .gutter .line.highlighted {
|
||||
background-color: #4E6CA3 !important;
|
||||
color: white !important;
|
||||
}
|
||||
.syntaxhighlighter.printing .line .content {
|
||||
border: none !important;
|
||||
}
|
||||
.syntaxhighlighter.collapsed {
|
||||
overflow: visible !important;
|
||||
}
|
||||
.syntaxhighlighter.collapsed .toolbar {
|
||||
color: blue !important;
|
||||
background: white !important;
|
||||
border: 1px solid #4E6CA3 !important;
|
||||
}
|
||||
.syntaxhighlighter.collapsed .toolbar a {
|
||||
color: blue !important;
|
||||
}
|
||||
.syntaxhighlighter.collapsed .toolbar a:hover {
|
||||
color: red !important;
|
||||
}
|
||||
.syntaxhighlighter .toolbar {
|
||||
color: white !important;
|
||||
background: #4E6CA3 !important;
|
||||
border: none !important;
|
||||
}
|
||||
.syntaxhighlighter .toolbar a {
|
||||
color: white !important;
|
||||
}
|
||||
.syntaxhighlighter .toolbar a:hover {
|
||||
color: black !important;
|
||||
}
|
||||
.syntaxhighlighter .plain, .syntaxhighlighter .plain a {
|
||||
color: black !important;
|
||||
}
|
||||
.syntaxhighlighter .comments, .syntaxhighlighter .comments a {
|
||||
color: #008200 !important;
|
||||
}
|
||||
.syntaxhighlighter .string, .syntaxhighlighter .string a {
|
||||
color: blue !important;
|
||||
}
|
||||
.syntaxhighlighter .keyword {
|
||||
color: #006699 !important;
|
||||
}
|
||||
.syntaxhighlighter .preprocessor {
|
||||
color: gray !important;
|
||||
}
|
||||
.syntaxhighlighter .variable {
|
||||
color: #aa7700 !important;
|
||||
}
|
||||
.syntaxhighlighter .value {
|
||||
color: #009900 !important;
|
||||
}
|
||||
.syntaxhighlighter .functions {
|
||||
color: #ff1493 !important;
|
||||
}
|
||||
.syntaxhighlighter .constants {
|
||||
color: #0066cc !important;
|
||||
}
|
||||
.syntaxhighlighter .script {
|
||||
font-weight: bold !important;
|
||||
color: #006699 !important;
|
||||
background-color: none !important;
|
||||
}
|
||||
.syntaxhighlighter .color1, .syntaxhighlighter .color1 a {
|
||||
color: gray !important;
|
||||
}
|
||||
.syntaxhighlighter .color2, .syntaxhighlighter .color2 a {
|
||||
color: #ff1493 !important;
|
||||
}
|
||||
.syntaxhighlighter .color3, .syntaxhighlighter .color3 a {
|
||||
color: red !important;
|
||||
}
|
||||
|
||||
.syntaxhighlighter .keyword {
|
||||
font-weight: bold !important;
|
||||
}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 430 B |
Binary file not shown.
|
After Width: | Height: | Size: 1011 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.2 KiB |
@@ -0,0 +1,121 @@
|
||||
|
||||
(function() {
|
||||
|
||||
var showingNav = true;
|
||||
|
||||
$(document).ready( function () {
|
||||
var jqNav = $('div.fw_nav');
|
||||
jqNav.css('right', ($(window).width() - $('div.fw_container').width()) /2);
|
||||
|
||||
var n = $('div.nav_blocker')[0];
|
||||
n.style.height = $(jqNav).outerHeight()+"px";
|
||||
n.style.width = ($(jqNav).outerWidth()+20)+"px";
|
||||
|
||||
SyntaxHighlighter.highlight();
|
||||
|
||||
$('#private_toggle').click( function () {
|
||||
if ( $('input[name=show_private]').val() == 0 ) {
|
||||
$('input[name=show_private]').val( 1 );
|
||||
$('#private_label').html('Showing');
|
||||
$('.private').css('display', 'block');
|
||||
} else {
|
||||
$('input[name=show_private]').val( 0 );
|
||||
$('#private_label').html('Hiding');
|
||||
$('.private').css('display', 'none');
|
||||
}
|
||||
fnWriteCookie();
|
||||
return false;
|
||||
} );
|
||||
|
||||
$('#extended_toggle').click( function () {
|
||||
if ( $('input[name=show_extended]').val() == 0 ) {
|
||||
$('input[name=show_extended]').val( 1 );
|
||||
$('#extended_label').html('Showing');
|
||||
$('.augmented').css('display', 'block');
|
||||
} else {
|
||||
$('input[name=show_extended]').val( 0 );
|
||||
$('#extended_label').html('Hiding');
|
||||
$('.augmented').css('display', 'none');
|
||||
}
|
||||
fnWriteCookie();
|
||||
return false;
|
||||
} );
|
||||
|
||||
var savedHeight = $(jqNav).height();
|
||||
$('div.fw_nav h2').click( function () {
|
||||
if ( showingNav ) {
|
||||
$('div.fw_nav').animate( {
|
||||
"height": 10,
|
||||
"opacity": 0.3
|
||||
} );
|
||||
showingNav = false;
|
||||
} else {
|
||||
$('div.fw_nav').animate( {
|
||||
"height": savedHeight,
|
||||
"opacity": 1
|
||||
} );
|
||||
showingNav = true;
|
||||
}
|
||||
fnWriteCookie();
|
||||
} );
|
||||
|
||||
var cookie = fnReadCookie( 'SpryMedia_JSDoc' );
|
||||
if ( cookie != null ) {
|
||||
var a = cookie.split('-');
|
||||
if ( a[0] == 1 ) {
|
||||
$('#private_toggle').click();
|
||||
}
|
||||
if ( a[1] == 0 ) {
|
||||
$('#extended_toggle').click();
|
||||
}
|
||||
if ( a[2] == 'false' ) {
|
||||
$('div.fw_nav').css('height', 10).css('opacity', 0.3);
|
||||
showingNav = false;
|
||||
}
|
||||
}
|
||||
} );
|
||||
|
||||
|
||||
function fnWriteCookie()
|
||||
{
|
||||
var sVal =
|
||||
$('input[name=show_private]').val()+'-'+
|
||||
$('input[name=show_extended]').val()+'-'+
|
||||
showingNav;
|
||||
|
||||
fnCreateCookie( 'SpryMedia_JSDoc', sVal );
|
||||
}
|
||||
|
||||
|
||||
function fnCreateCookie( sName, sValue )
|
||||
{
|
||||
var iDays = 365;
|
||||
var date = new Date();
|
||||
date.setTime( date.getTime()+(iDays*24*60*60*1000) );
|
||||
var sExpires = "; expires="+date.toGMTString();
|
||||
|
||||
document.cookie = sName+"="+sValue+sExpires+"; path=/";
|
||||
}
|
||||
|
||||
|
||||
function fnReadCookie( sName )
|
||||
{
|
||||
var sNameEQ = sName + "=";
|
||||
var sCookieContents = document.cookie.split(';');
|
||||
|
||||
for( var i=0 ; i<sCookieContents.length ; i++ ) {
|
||||
var c = sCookieContents[i];
|
||||
|
||||
while (c.charAt(0)==' ') {
|
||||
c = c.substring(1,c.length);
|
||||
}
|
||||
|
||||
if (c.indexOf(sNameEQ) == 0) {
|
||||
return c.substring(sNameEQ.length,c.length);
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
})();
|
||||
8316
wwwroot/BackendScript/assets/advanced-datatable/docs/media/js/jquery.js
vendored
Normal file
8316
wwwroot/BackendScript/assets/advanced-datatable/docs/media/js/jquery.js
vendored
Normal file
File diff suppressed because it is too large
Load Diff
52
wwwroot/BackendScript/assets/advanced-datatable/docs/media/js/shBrushJScript.js
vendored
Normal file
52
wwwroot/BackendScript/assets/advanced-datatable/docs/media/js/shBrushJScript.js
vendored
Normal file
@@ -0,0 +1,52 @@
|
||||
/**
|
||||
* SyntaxHighlighter
|
||||
* http://alexgorbatchev.com/SyntaxHighlighter
|
||||
*
|
||||
* SyntaxHighlighter is donationware. If you are using it, please donate.
|
||||
* http://alexgorbatchev.com/SyntaxHighlighter/donate.html
|
||||
*
|
||||
* @version
|
||||
* 3.0.83 (July 02 2010)
|
||||
*
|
||||
* @copyright
|
||||
* Copyright (C) 2004-2010 Alex Gorbatchev.
|
||||
*
|
||||
* @license
|
||||
* Dual licensed under the MIT and GPL licenses.
|
||||
*/
|
||||
;(function()
|
||||
{
|
||||
// CommonJS
|
||||
typeof(require) != 'undefined' ? SyntaxHighlighter = require('shCore').SyntaxHighlighter : null;
|
||||
|
||||
function Brush()
|
||||
{
|
||||
var keywords = 'break case catch continue ' +
|
||||
'default delete do else false ' +
|
||||
'for function if in instanceof ' +
|
||||
'new null return super switch ' +
|
||||
'this throw true try typeof var while with'
|
||||
;
|
||||
|
||||
var r = SyntaxHighlighter.regexLib;
|
||||
|
||||
this.regexList = [
|
||||
{ regex: r.multiLineDoubleQuotedString, css: 'string' }, // double quoted strings
|
||||
{ regex: r.multiLineSingleQuotedString, css: 'string' }, // single quoted strings
|
||||
{ regex: r.singleLineCComments, css: 'comments' }, // one line comments
|
||||
{ regex: r.multiLineCComments, css: 'comments' }, // multiline comments
|
||||
{ regex: /\s*#.*/gm, css: 'preprocessor' }, // preprocessor tags like #region and #endregion
|
||||
{ regex: new RegExp(this.getKeywords(keywords), 'gm'), css: 'keyword' } // keywords
|
||||
];
|
||||
|
||||
this.forHtmlScript(r.scriptScriptTags);
|
||||
};
|
||||
|
||||
Brush.prototype = new SyntaxHighlighter.Highlighter();
|
||||
Brush.aliases = ['js', 'jscript', 'javascript'];
|
||||
|
||||
SyntaxHighlighter.brushes.JScript = Brush;
|
||||
|
||||
// CommonJS
|
||||
typeof(exports) != 'undefined' ? exports.Brush = Brush : null;
|
||||
})();
|
||||
17
wwwroot/BackendScript/assets/advanced-datatable/docs/media/js/shCore.js
vendored
Normal file
17
wwwroot/BackendScript/assets/advanced-datatable/docs/media/js/shCore.js
vendored
Normal file
File diff suppressed because one or more lines are too long
@@ -0,0 +1,20 @@
|
||||
Copyright (c) 2003, 2004 Jim Weirich
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
Reference in New Issue
Block a user