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