Mercurial > repos > saskia-hiltemann > ireport

comparison DataTables-1.9.4/docs/DataTable.defaults.oLanguage.html @ 0:ac5f9272033b draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
first upload
author saskia-hiltemann
date Tue, 01 Jul 2014 11:42:23 -0400
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:ac5f9272033b
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: oLanguage - 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: oLanguage</h1>
24 <h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.defaults.html">.defaults</a>.</span> » oLanguage</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><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>
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>All strings that DataTables uses in the user interface that it creates
56 are defined in this object, allowing you to modified them individually or
57 completely replace them all as required.</p><dl class="details">
58
59 </dl>
60
61 </div>
62
63
64 <div class="doc_summary">
65 <a name="summary"></a>
66 <h2>Summary</h2>
67
68 <div class="doc_group"><a name="summary_namespaces"></a><h3 class="subsection-title">Namespaces</h3>
69 <dl>
70 <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
71 actually visible on the page, but will be read by screenreaders, and thus
72 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
73 control types ("two_button" and "full_numbers")</p></dd>
74 </dl></div><div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3>
75
76 <dl>
77 <dt class=" even"><span class="type-attr"><span class="type-signature">&lt;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
78 empty of data (regardless of filtering). Note that this is an optional
79 parameter - if it is not given, the value of sZeroRecords will be used
80 instead (either the default or given value).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;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
81 is current on display on the page. The <em>START</em>, <em>END</em> and <em>TOTAL</em>
82 variables are all dynamically replaced as the table display updates, and
83 can be freely moved or removed as the language requirements change.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;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
84 format of this string should match sInfo.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;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
85 to the information (sInfo) to give an idea of how strong the filtering
86 is. The variable <em>MAX</em> is dynamically updated.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;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,
87 and this variable does exactly that. This information will be appended to
88 the sInfo (sInfoEmpty and sInfoFiltered in whatever combination they are
89 being used) at all times.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;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
90 to format large numbers that are used in the table information. By
91 default a comma is used, but this can be trivially changed to any
92 character you wish with this parameter.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;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
93 pagination length option is changed. The '<em>MENU</em>' variable is replaced
94 with a default select list of 10, 25, 50 and 100, and can be replaced
95 with a custom select box if required.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;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
96 gathering the data, this message is shown in an empty row in the table to
97 indicate to the end user the the data is being loaded. Note that this
98 parameter is not used when loading data by server-side processing, just
99 Ajax sourced data with client-side processing.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;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
100 (usually a sort command or similar).</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;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
101 filtering input text box. The variable "<em>INPUT</em>", if used in the string,
102 is replaced with the HTML text box for the filtering input allowing
103 control over where it appears in the string. If "<em>INPUT</em>" is not given
104 then the input box is appended to the string automatically.</p></dd><dt class=" even"><span class="type-attr"><span class="type-signature">&lt;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
105 server-side, which DataTables will look up if this parameter is passed.
106 It must store the URL of the language file, which is in a JSON format,
107 and the object has the same properties as the oLanguage object in the
108 initialiser object (i.e. the above parameters). Please refer to one of
109 the example language files to see how this works in action.</p></dd><dt class=" odd"><span class="type-attr"><span class="type-signature">&lt;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
110 displayed after filtering. sEmptyTable is shown when there is simply no
111 information in the table at all (regardless of filtering).</p></dd>
112 </dl></div>
113 </div>
114
115
116
117
118 <div class="doc_details">
119 <a name="details"></a>
120 <h2>Details</h2>
121 <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3>
122 <dl>
123 <dt class=" even"><a name="sEmptyTable"></a><a name="sEmptyTable_details"></a><span class="type-attr"><span class="type-signature">&lt;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
124 empty of data (regardless of filtering). Note that this is an optional
125 parameter - if it is not given, the value of sZeroRecords will be used
126 instead (either the default or given value).</p><div class="collapse_details"><dl class="details">
127
128 </dl>
129 <h5>Example</h5>
130 <div class="example-code">
131 <pre class="brush: js"> $(document).ready( function() {
132 $('#example').dataTable( {
133 "oLanguage": {
134 "sEmptyTable": "No data available in table"
135 }
136 } );
137 } );</pre>
138 </div>
139 </div></dd><dt class=" odd"><a name="sInfo"></a><a name="sInfo_details"></a><span class="type-attr"><span class="type-signature">&lt;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
140 is current on display on the page. The <em>START</em>, <em>END</em> and <em>TOTAL</em>
141 variables are all dynamically replaced as the table display updates, and
142 can be freely moved or removed as the language requirements change.</p><div class="collapse_details"><dl class="details">
143
144 </dl>
145 <h5>Example</h5>
146 <div class="example-code">
147 <pre class="brush: js"> $(document).ready( function() {
148 $('#example').dataTable( {
149 "oLanguage": {
150 "sInfo": "Got a total of _TOTAL_ entries to show (_START_ to _END_)"
151 }
152 } );
153 } );</pre>
154 </div>
155 </div></dd><dt class=" even"><a name="sInfoEmpty"></a><a name="sInfoEmpty_details"></a><span class="type-attr"><span class="type-signature">&lt;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
156 format of this string should match sInfo.</p><div class="collapse_details"><dl class="details">
157
158 </dl>
159 <h5>Example</h5>
160 <div class="example-code">
161 <pre class="brush: js"> $(document).ready( function() {
162 $('#example').dataTable( {
163 "oLanguage": {
164 "sInfoEmpty": "No entries to show"
165 }
166 } );
167 } );</pre>
168 </div>
169 </div></dd><dt class=" odd"><a name="sInfoFiltered"></a><a name="sInfoFiltered_details"></a><span class="type-attr"><span class="type-signature">&lt;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
170 to the information (sInfo) to give an idea of how strong the filtering
171 is. The variable <em>MAX</em> is dynamically updated.</p><div class="collapse_details"><dl class="details">
172
173 </dl>
174 <h5>Example</h5>
175 <div class="example-code">
176 <pre class="brush: js"> $(document).ready( function() {
177 $('#example').dataTable( {
178 "oLanguage": {
179 "sInfoFiltered": " - filtering from _MAX_ records"
180 }
181 } );
182 } );</pre>
183 </div>
184 </div></dd><dt class=" even"><a name="sInfoPostFix"></a><a name="sInfoPostFix_details"></a><span class="type-attr"><span class="type-signature">&lt;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,
185 and this variable does exactly that. This information will be appended to
186 the sInfo (sInfoEmpty and sInfoFiltered in whatever combination they are
187 being used) at all times.</p><div class="collapse_details"><dl class="details">
188
189 </dl>
190 <h5>Example</h5>
191 <div class="example-code">
192 <pre class="brush: js"> $(document).ready( function() {
193 $('#example').dataTable( {
194 "oLanguage": {
195 "sInfoPostFix": "All records shown are derived from real information."
196 }
197 } );
198 } );</pre>
199 </div>
200 </div></dd><dt class=" odd"><a name="sInfoThousands"></a><a name="sInfoThousands_details"></a><span class="type-attr"><span class="type-signature">&lt;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
201 to format large numbers that are used in the table information. By
202 default a comma is used, but this can be trivially changed to any
203 character you wish with this parameter.</p><div class="collapse_details"><dl class="details">
204
205 </dl>
206 <h5>Example</h5>
207 <div class="example-code">
208 <pre class="brush: js"> $(document).ready( function() {
209 $('#example').dataTable( {
210 "oLanguage": {
211 "sInfoThousands": "'"
212 }
213 } );
214 } );</pre>
215 </div>
216 </div></dd><dt class=" even"><a name="sLengthMenu"></a><a name="sLengthMenu_details"></a><span class="type-attr"><span class="type-signature">&lt;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
217 pagination length option is changed. The '<em>MENU</em>' variable is replaced
218 with a default select list of 10, 25, 50 and 100, and can be replaced
219 with a custom select box if required.</p><div class="collapse_details"><dl class="details">
220
221 </dl>
222 <h5>Examples</h5>
223 <div class="example-code">
224 <pre class="brush: js"> // Language change only
225 $(document).ready( function() {
226 $('#example').dataTable( {
227 "oLanguage": {
228 "sLengthMenu": "Display _MENU_ records"
229 }
230 } );
231 } );
232
233 </pre>
234 </div>
235
236 <div class="example-code">
237 <pre class="brush: js"> // Language and options change
238 $(document).ready( function() {
239 $('#example').dataTable( {
240 "oLanguage": {
241 "sLengthMenu": 'Display <select>'+
242 '<option value="10">10</option>'+
243 '<option value="20">20</option>'+
244 '<option value="30">30</option>'+
245 '<option value="40">40</option>'+
246 '<option value="50">50</option>'+
247 '<option value="-1">All</option>'+
248 '</select> records'
249 }
250 } );
251 } );</pre>
252 </div>
253 </div></dd><dt class=" odd"><a name="sLoadingRecords"></a><a name="sLoadingRecords_details"></a><span class="type-attr"><span class="type-signature">&lt;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
254 gathering the data, this message is shown in an empty row in the table to
255 indicate to the end user the the data is being loaded. Note that this
256 parameter is not used when loading data by server-side processing, just
257 Ajax sourced data with client-side processing.</p><div class="collapse_details"><dl class="details">
258
259 </dl>
260 <h5>Example</h5>
261 <div class="example-code">
262 <pre class="brush: js"> $(document).ready( function() {
263 $('#example').dataTable( {
264 "oLanguage": {
265 "sLoadingRecords": "Please wait - loading..."
266 }
267 } );
268 } );</pre>
269 </div>
270 </div></dd><dt class=" even"><a name="sProcessing"></a><a name="sProcessing_details"></a><span class="type-attr"><span class="type-signature">&lt;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
271 (usually a sort command or similar).</p><div class="collapse_details"><dl class="details">
272
273 </dl>
274 <h5>Example</h5>
275 <div class="example-code">
276 <pre class="brush: js"> $(document).ready( function() {
277 $('#example').dataTable( {
278 "oLanguage": {
279 "sProcessing": "DataTables is currently busy"
280 }
281 } );
282 } );</pre>
283 </div>
284 </div></dd><dt class=" odd"><a name="sSearch"></a><a name="sSearch_details"></a><span class="type-attr"><span class="type-signature">&lt;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
285 filtering input text box. The variable "<em>INPUT</em>", if used in the string,
286 is replaced with the HTML text box for the filtering input allowing
287 control over where it appears in the string. If "<em>INPUT</em>" is not given
288 then the input box is appended to the string automatically.</p><div class="collapse_details"><dl class="details">
289
290 </dl>
291 <h5>Examples</h5>
292 <div class="example-code">
293 <pre class="brush: js"> // Input text box will be appended at the end automatically
294 $(document).ready( function() {
295 $('#example').dataTable( {
296 "oLanguage": {
297 "sSearch": "Filter records:"
298 }
299 } );
300 } );
301
302 </pre>
303 </div>
304
305 <div class="example-code">
306 <pre class="brush: js"> // Specify where the filter should appear
307 $(document).ready( function() {
308 $('#example').dataTable( {
309 "oLanguage": {
310 "sSearch": "Apply filter _INPUT_ to table"
311 }
312 } );
313 } );</pre>
314 </div>
315 </div></dd><dt class=" even"><a name="sUrl"></a><a name="sUrl_details"></a><span class="type-attr"><span class="type-signature">&lt;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
316 server-side, which DataTables will look up if this parameter is passed.
317 It must store the URL of the language file, which is in a JSON format,
318 and the object has the same properties as the oLanguage object in the
319 initialiser object (i.e. the above parameters). Please refer to one of
320 the example language files to see how this works in action.</p><div class="collapse_details"><dl class="details">
321
322 </dl>
323 <h5>Example</h5>
324 <div class="example-code">
325 <pre class="brush: js"> $(document).ready( function() {
326 $('#example').dataTable( {
327 "oLanguage": {
328 "sUrl": "http://www.sprymedia.co.uk/dataTables/lang.txt"
329 }
330 } );
331 } );</pre>
332 </div>
333 </div></dd><dt class=" odd"><a name="sZeroRecords"></a><a name="sZeroRecords_details"></a><span class="type-attr"><span class="type-signature">&lt;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
334 displayed after filtering. sEmptyTable is shown when there is simply no
335 information in the table at all (regardless of filtering).</p><div class="collapse_details"><dl class="details">
336
337 </dl>
338 <h5>Example</h5>
339 <div class="example-code">
340 <pre class="brush: js"> $(document).ready( function() {
341 $('#example').dataTable( {
342 "oLanguage": {
343 "sZeroRecords": "No records to display"
344 }
345 } );
346 } );</pre>
347 </div>
348 </div></dd>
349 </dl></div>
350 </div>
351
352 </div>
353
354 <div class="fw_footer">
355 DataTables: Copyright 2008-2012 Allan Jardine, all rights reserved<br>
356
357 Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
358 23th Sep 2012 - 14:27
359 with the <a href="http://datatables.net/">DataTables</a> template.
360 </div>
361 </body>
362 </html>