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

fixed tool dependency issue
author saskia-hiltemann
date Tue, 30 Sep 2014 09:56:12 -0400
parents ac5f9272033b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
2 <html>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
3 <head>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
4 <meta http-equiv="Content-type" content="text/html; charset=utf-8">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
5 <title>Namespace: oFeatures - documentation</title>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
6
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
7 <style type="text/css" media="screen">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
8 @import "media/css/doc.css";
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
9 @import "media/css/shCore.css";
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
10 @import "media/css/shThemeDataTables.css";
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
11 </style>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
12
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
13 <script type="text/javascript" src="media/js/shCore.js"></script>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
14 <script type="text/javascript" src="media/js/shBrushJScript.js"></script>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
15 <script type="text/javascript" src="media/js/jquery.js"></script>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
16 <script type="text/javascript" src="media/js/doc.js"></script>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
17 </head>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
18 <body>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
19 <div class="fw_container">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
20
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
21 <a name="top"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
22 <div class="fw_header">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
23 <h1 class="page-title">Namespace: oFeatures</h1>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
24 <h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.models.html">.models</a> » <a href="DataTable.models.oSettings.html">.oSettings</a>.</span> » oFeatures</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
25 <div class="page-info">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
26 DataTables v1.9.4 documentation
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
27 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
28 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
29
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
30
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
31
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
32 <div class="fw_nav">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
33 <h2>Navigation</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
34 <ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
35 <li><a href="#top">Overview</a></li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
36 <li><a href="#summary">Summary</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td>Classes (0)</td><td>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>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
37 <div style="margin-top: 10px;">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
38 <input type="hidden" name="show_private" value="0">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
39 <span id="private_label">Hiding</span> private elements
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
40 (<a id="private_toggle" href="">toggle</a>)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
41 </span>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
42 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
43 <div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
44 <input type="hidden" name="show_extended" value="1">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
45 <span id="extended_label">Showing</span> extended elements
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
46 (<a id="extended_toggle" href="">toggle</a>)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
47 </span>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
48 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
49 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
50
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
51 <div class="fw_content">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
52 <a name="overview"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
53 <div class="doc_overview">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
54 <div class="nav_blocker"></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
55 <p>Primary features of DataTables and their enablement state.</p><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
56
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
57 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
58
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
59 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
60
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
61
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
62 <div class="doc_summary">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
63 <a name="summary"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
64 <h2>Summary</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
65
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
66 <div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
67
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
68 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
69 <dt class=" even"><span class="type-attr"><span class="type-signature">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
70 optimum table and columns widths (true) or not (false).
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
71 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
72 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">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
73 needed by a driven page draw. This can give a significant speed
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
74 increase for Ajax source and Javascript source data, but makes no
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
75 difference at all fro DOM and server-side processing tables.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
76 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
77 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">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
78 then there is no filtering at all on the table, including fnFilter.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
79 To just remove the filtering input use sDom and remove the 'f' option.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
80 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
81 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">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
82 flag.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
83 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
84 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">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
85 when pagination is enabled.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
86 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
87 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">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
88 changing must also be disabled.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
89 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
90 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">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
91 user request - typically an Ajax request for server-side processing.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
92 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
93 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">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
94 get all data from the server for every draw - there is no filtering,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
95 sorting or paging done on the client-side.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
96 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
97 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">&lt;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.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
98 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
99 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
100 visual highlight or not. This can slow things down when enabled since
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
101 there is a lot of DOM interaction.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
102 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
103 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">&lt;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.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
104 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
105 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
106 </dl></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
107 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
108
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
109
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
110
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
111
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
112 <div class="doc_details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
113 <a name="details"></a>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
114 <h2>Details</h2>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
115 <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
116 <dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
117 <dt class=" even"><a name="bAutoWidth"></a><a name="bAutoWidth_details"></a><span class="type-attr"><span class="type-signature">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
118 optimum table and columns widths (true) or not (false).
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
119 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
120 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
121
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
122 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
123 </div></dd><dt class=" odd"><a name="bDeferRender"></a><a name="bDeferRender_details"></a><span class="type-attr"><span class="type-signature">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
124 needed by a driven page draw. This can give a significant speed
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
125 increase for Ajax source and Javascript source data, but makes no
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
126 difference at all fro DOM and server-side processing tables.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
127 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
128 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
129
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
130 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
131 </div></dd><dt class=" even"><a name="bFilter"></a><a name="bFilter_details"></a><span class="type-attr"><span class="type-signature">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
132 then there is no filtering at all on the table, including fnFilter.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
133 To just remove the filtering input use sDom and remove the 'f' option.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
134 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
135 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
136
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
137 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
138 </div></dd><dt class=" odd"><a name="bInfo"></a><a name="bInfo_details"></a><span class="type-attr"><span class="type-signature">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
139 flag.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
140 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
141 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
142
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
143 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
144 </div></dd><dt class=" even"><a name="bLengthChange"></a><a name="bLengthChange_details"></a><span class="type-attr"><span class="type-signature">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
145 when pagination is enabled.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
146 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
147 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
148
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
149 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
150 </div></dd><dt class=" odd"><a name="bPaginate"></a><a name="bPaginate_details"></a><span class="type-attr"><span class="type-signature">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
151 changing must also be disabled.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
152 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
153 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
154
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
155 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
156 </div></dd><dt class=" even"><a name="bProcessing"></a><a name="bProcessing_details"></a><span class="type-attr"><span class="type-signature">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
157 user request - typically an Ajax request for server-side processing.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
158 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
159 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
160
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
161 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
162 </div></dd><dt class=" odd"><a name="bServerSide"></a><a name="bServerSide_details"></a><span class="type-attr"><span class="type-signature">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
163 get all data from the server for every draw - there is no filtering,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
164 sorting or paging done on the client-side.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
165 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
166 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
167
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
168 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
169 </div></dd><dt class=" even"><a name="bSort"></a><a name="bSort_details"></a><span class="type-attr"><span class="type-signature">&lt;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.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
170 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
171 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
172
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
173 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
174 </div></dd><dt class=" odd"><a name="bSortClasses"></a><a name="bSortClasses_details"></a><span class="type-attr"><span class="type-signature">&lt;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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
175 visual highlight or not. This can slow things down when enabled since
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
176 there is a lot of DOM interaction.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
177 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
178 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
179
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
180 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
181 </div></dd><dt class=" even"><a name="bStateSave"></a><a name="bStateSave_details"></a><span class="type-attr"><span class="type-signature">&lt;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.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
182 Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
183 set a default use <a href="DataTable.defaults.html">DataTable.defaults</a>.</p><div class="collapse_details"><dl class="details">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
184
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
185 </dl>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
186 </div></dd>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
187 </dl></div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
188 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
189
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
190 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
191
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
192 <div class="fw_footer">
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
193 DataTables: Copyright 2008-2012 Allan Jardine, all rights reserved<br>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
194
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
195 Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
196 23th Sep 2012 - 14:27
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
197 with the <a href="http://datatables.net/">DataTables</a> template.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
198 </div>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
199 </body>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
200 </html>