annotate DataTables-1.9.4/media/src/model/model.settings.js @ 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
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
2
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
3 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
4 * DataTables settings object - this holds all the information needed for a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
5 * given table, including configuration, data and current application of the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
6 * table options. DataTables does not have a single instance for each DataTable
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
7 * with the settings attached to that instance, but rather instances of the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
8 * DataTable "class" are created on-the-fly as needed (typically by a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
9 * $().dataTable() call) and the settings object is then applied to that
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
10 * instance.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
11 *
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
12 * Note that this object is related to {@link DataTable.defaults} but this
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
13 * one is the internal data store for DataTables's cache of columns. It should
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
14 * NOT be manipulated outside of DataTables. Any configuration should be done
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
15 * through the initialisation options.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
16 * @namespace
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
17 * @todo Really should attach the settings object to individual instances so we
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
18 * don't need to create new instances on each $().dataTable() call (if the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
19 * table already exists). It would also save passing oSettings around and
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
20 * into every single function. However, this is a very significant
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
21 * architecture change for DataTables and will almost certainly break
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
22 * backwards compatibility with older installations. This is something that
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
23 * will be done in 2.0.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
24 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
25 DataTable.models.oSettings = {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
26 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
27 * Primary features of DataTables and their enablement state.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
28 * @namespace
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
29 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
30 "oFeatures": {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
31
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
32 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
33 * Flag to say if DataTables should automatically try to calculate the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
34 * optimum table and columns widths (true) or not (false).
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
35 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
36 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
37 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
38 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
39 "bAutoWidth": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
40
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
41 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
42 * Delay the creation of TR and TD elements until they are actually
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
43 * needed by a driven page draw. This can give a significant speed
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
44 * increase for Ajax source and Javascript source data, but makes no
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
45 * difference at all fro DOM and server-side processing tables.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
46 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
47 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
48 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
49 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
50 "bDeferRender": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
51
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
52 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
53 * Enable filtering on the table or not. Note that if this is disabled
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
54 * then there is no filtering at all on the table, including fnFilter.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
55 * To just remove the filtering input use sDom and remove the 'f' option.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
56 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
57 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
58 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
59 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
60 "bFilter": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
61
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
62 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
63 * Table information element (the 'Showing x of y records' div) enable
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
64 * flag.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
65 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
66 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
67 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
68 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
69 "bInfo": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
70
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
71 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
72 * Present a user control allowing the end user to change the page size
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
73 * when pagination is enabled.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
74 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
75 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
76 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
77 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
78 "bLengthChange": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
79
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
80 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
81 * Pagination enabled or not. Note that if this is disabled then length
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
82 * changing must also be disabled.
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 {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
85 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
86 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
87 "bPaginate": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
88
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
89 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
90 * 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 {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
94 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
95 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
96 "bProcessing": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
97
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
98 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
99 * Server-side processing enabled flag - when enabled DataTables will
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
100 * get all data from the server for every draw - there is no filtering,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
101 * sorting or paging done on the client-side.
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 {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
104 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
105 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
106 "bServerSide": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
107
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
108 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
109 * Sorting enablement flag.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
110 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
111 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
112 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
113 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
114 "bSort": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
115
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
116 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
117 * Apply a class to the columns which are being sorted to provide a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
118 * visual highlight or not. This can slow things down when enabled since
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
119 * there is a lot of DOM interaction.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
120 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
121 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
122 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
123 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
124 "bSortClasses": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
125
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
126 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
127 * State saving enablement flag.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
128 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
129 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
130 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
131 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
132 "bStateSave": null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
133 },
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
134
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
135
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
136 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
137 * Scrolling settings for a table.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
138 * @namespace
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
139 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
140 "oScroll": {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
141 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
142 * Indicate if DataTables should be allowed to set the padding / margin
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
143 * etc for the scrolling header elements or not. Typically you will want
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
144 * this.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
145 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
146 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
147 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
148 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
149 "bAutoCss": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
150
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
151 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
152 * When the table is shorter in height than sScrollY, collapse the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
153 * table container down to the height of the table (when true).
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
154 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
155 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
156 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
157 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
158 "bCollapse": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
159
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
160 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
161 * Infinite scrolling enablement flag. Now deprecated in favour of
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
162 * using the Scroller plug-in.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
163 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
164 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
165 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
166 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
167 "bInfinite": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
168
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
169 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
170 * Width of the scrollbar for the web-browser's platform. Calculated
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
171 * during table initialisation.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
172 * @type int
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
173 * @default 0
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
174 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
175 "iBarWidth": 0,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
176
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
177 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
178 * Space (in pixels) between the bottom of the scrolling container and
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
179 * the bottom of the scrolling viewport before the next page is loaded
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
180 * when using infinite scrolling.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
181 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
182 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
183 * @type int
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
184 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
185 "iLoadGap": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
186
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
187 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
188 * Viewport width for horizontal scrolling. Horizontal scrolling is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
189 * disabled if an empty string.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
190 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
191 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
192 * @type string
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
193 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
194 "sX": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
195
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
196 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
197 * Width to expand the table to when using x-scrolling. Typically you
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
198 * should not need to use this.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
199 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
200 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
201 * @type string
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
202 * @deprecated
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
203 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
204 "sXInner": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
205
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
206 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
207 * Viewport height for vertical scrolling. Vertical scrolling is disabled
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
208 * if an empty string.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
209 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
210 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
211 * @type string
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
212 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
213 "sY": null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
214 },
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
215
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
216 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
217 * Language information for the table.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
218 * @namespace
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
219 * @extends DataTable.defaults.oLanguage
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
220 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
221 "oLanguage": {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
222 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
223 * Information callback function. See
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
224 * {@link DataTable.defaults.fnInfoCallback}
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
225 * @type function
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
226 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
227 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
228 "fnInfoCallback": null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
229 },
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
230
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
231 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
232 * Browser support parameters
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
233 * @namespace
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
234 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
235 "oBrowser": {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
236 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
237 * Indicate if the browser incorrectly calculates width:100% inside a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
238 * scrolling element (IE6/7)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
239 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
240 * @default false
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
241 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
242 "bScrollOversize": false
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
243 },
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
244
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
245 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
246 * Array referencing the nodes which are used for the features. The
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
247 * parameters of this object match what is allowed by sDom - i.e.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
248 * <ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
249 * <li>'l' - Length changing</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
250 * <li>'f' - Filtering input</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
251 * <li>'t' - The table!</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
252 * <li>'i' - Information</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
253 * <li>'p' - Pagination</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
254 * <li>'r' - pRocessing</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
255 * </ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
256 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
257 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
258 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
259 "aanFeatures": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
260
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
261 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
262 * Store data information - see {@link DataTable.models.oRow} for detailed
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
263 * information.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
264 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
265 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
266 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
267 "aoData": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
268
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
269 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
270 * Array of indexes which are in the current display (after filtering etc)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
271 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
272 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
273 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
274 "aiDisplay": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
275
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
276 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
277 * Array of indexes for display - no filtering
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
278 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
279 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
280 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
281 "aiDisplayMaster": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
282
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
283 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
284 * Store information about each column that is in use
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
285 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
286 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
287 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
288 "aoColumns": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
289
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
290 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
291 * Store information about the table's header
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
292 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
293 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
294 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
295 "aoHeader": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
296
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
297 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
298 * Store information about the table's footer
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
299 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
300 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
301 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
302 "aoFooter": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
303
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
304 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
305 * Search data array for regular expression searching
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
306 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
307 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
308 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
309 "asDataSearch": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
310
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
311 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
312 * Store the applied global search information in case we want to force a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
313 * research or compare the old search to a new one.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
314 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
315 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
316 * @namespace
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
317 * @extends DataTable.models.oSearch
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
318 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
319 "oPreviousSearch": {},
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
320
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
321 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
322 * Store the applied search for each column - see
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
323 * {@link DataTable.models.oSearch} for the format that is used for the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
324 * filtering information for each column.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
325 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
326 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
327 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
328 "aoPreSearchCols": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
329
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
330 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
331 * Sorting that is applied to the table. Note that the inner arrays are
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
332 * used in the following manner:
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
333 * <ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
334 * <li>Index 0 - column number</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
335 * <li>Index 1 - current sorting direction</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
336 * <li>Index 2 - index of asSorting for this column</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
337 * </ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
338 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
339 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
340 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
341 * @todo These inner arrays should really be objects
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
342 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
343 "aaSorting": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
344
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
345 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
346 * Sorting that is always applied to the table (i.e. prefixed in front of
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
347 * aaSorting).
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
348 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
349 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
350 * @type array|null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
351 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
352 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
353 "aaSortingFixed": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
354
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
355 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
356 * Classes to use for the striping of a table.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
357 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
358 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
359 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
360 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
361 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
362 "asStripeClasses": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
363
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
364 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
365 * If restoring a table - we should restore its striping classes as well
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
366 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
367 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
368 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
369 "asDestroyStripes": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
370
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
371 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
372 * If restoring a table - we should restore its width
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
373 * @type int
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
374 * @default 0
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
375 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
376 "sDestroyWidth": 0,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
377
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
378 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
379 * Callback functions array for every time a row is inserted (i.e. on a draw).
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
380 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
381 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
382 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
383 "aoRowCallback": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
384
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
385 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
386 * Callback functions for the header on each draw.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
387 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
388 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
389 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
390 "aoHeaderCallback": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
391
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
392 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
393 * Callback function for the footer on each draw.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
394 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
395 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
396 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
397 "aoFooterCallback": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
398
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
399 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
400 * Array of callback functions for draw callback functions
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
401 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
402 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
403 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
404 "aoDrawCallback": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
405
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
406 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
407 * Array of callback functions for row created function
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
408 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
409 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
410 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
411 "aoRowCreatedCallback": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
412
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
413 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
414 * Callback functions for just before the table is redrawn. A return of
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
415 * false will be used to cancel the draw.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
416 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
417 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
418 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
419 "aoPreDrawCallback": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
420
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
421 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
422 * Callback functions for when the table has been initialised.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
423 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
424 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
425 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
426 "aoInitComplete": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
427
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
428
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
429 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
430 * Callbacks for modifying the settings to be stored for state saving, prior to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
431 * saving state.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
432 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
433 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
434 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
435 "aoStateSaveParams": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
436
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
437 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
438 * Callbacks for modifying the settings that have been stored for state saving
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
439 * prior to using the stored values to restore the state.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
440 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
441 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
442 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
443 "aoStateLoadParams": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
444
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
445 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
446 * Callbacks for operating on the settings object once the saved state has been
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
447 * loaded
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
448 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
449 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
450 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
451 "aoStateLoaded": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
452
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
453 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
454 * Cache the table ID for quick access
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
455 * @type string
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
456 * @default <i>Empty string</i>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
457 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
458 "sTableId": "",
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
459
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
460 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
461 * The TABLE node for the main table
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
462 * @type node
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
463 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
464 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
465 "nTable": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
466
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
467 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
468 * Permanent ref to the thead element
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
469 * @type node
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
470 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
471 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
472 "nTHead": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
473
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
474 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
475 * Permanent ref to the tfoot element - if it exists
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
476 * @type node
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
477 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
478 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
479 "nTFoot": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
480
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
481 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
482 * Permanent ref to the tbody element
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
483 * @type node
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
484 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
485 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
486 "nTBody": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
487
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
488 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
489 * Cache the wrapper node (contains all DataTables controlled elements)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
490 * @type node
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
491 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
492 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
493 "nTableWrapper": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
494
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
495 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
496 * Indicate if when using server-side processing the loading of data
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
497 * should be deferred until the second draw.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
498 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
499 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
500 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
501 * @default false
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
502 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
503 "bDeferLoading": false,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
504
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
505 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
506 * Indicate if all required information has been read in
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
507 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
508 * @default false
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
509 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
510 "bInitialised": false,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
511
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
512 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
513 * Information about open rows. Each object in the array has the parameters
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
514 * 'nTr' and 'nParent'
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
515 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
516 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
517 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
518 "aoOpenRows": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
519
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
520 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
521 * Dictate the positioning of DataTables' control elements - see
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
522 * {@link DataTable.model.oInit.sDom}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
523 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
524 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
525 * @type string
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
526 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
527 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
528 "sDom": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
529
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
530 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
531 * Which type of pagination should be used.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
532 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
533 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
534 * @type string
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
535 * @default two_button
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
536 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
537 "sPaginationType": "two_button",
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
538
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
539 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
540 * The cookie duration (for bStateSave) in seconds.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
541 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
542 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
543 * @type int
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
544 * @default 0
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
545 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
546 "iCookieDuration": 0,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
547
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
548 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
549 * The cookie name prefix.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
550 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
551 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
552 * @type string
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
553 * @default <i>Empty string</i>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
554 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
555 "sCookiePrefix": "",
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
556
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
557 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
558 * Callback function for cookie creation.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
559 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
560 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
561 * @type function
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
562 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
563 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
564 "fnCookieCallback": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
565
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
566 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
567 * Array of callback functions for state saving. Each array element is an
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
568 * object with the following parameters:
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
569 * <ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
570 * <li>function:fn - function to call. Takes two parameters, oSettings
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
571 * and the JSON string to save that has been thus far created. Returns
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
572 * a JSON string to be inserted into a json object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
573 * (i.e. '"param": [ 0, 1, 2]')</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
574 * <li>string:sName - name of callback</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
575 * </ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
576 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
577 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
578 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
579 "aoStateSave": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
580
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
581 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
582 * Array of callback functions for state loading. Each array element is an
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
583 * object with the following parameters:
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
584 * <ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
585 * <li>function:fn - function to call. Takes two parameters, oSettings
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
586 * and the object stored. May return false to cancel state loading</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
587 * <li>string:sName - name of callback</li>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
588 * </ul>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
589 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
590 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
591 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
592 "aoStateLoad": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
593
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
594 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
595 * State that was loaded from the cookie. Useful for back reference
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
596 * @type object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
597 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
598 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
599 "oLoadedState": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
600
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
601 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
602 * Source url for AJAX data for the table.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
603 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
604 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
605 * @type string
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
606 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
607 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
608 "sAjaxSource": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
609
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
610 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
611 * Property from a given object from which to read the table data from. This
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
612 * can be an empty string (when not server-side processing), in which case
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
613 * it is assumed an an array is given directly.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
614 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
615 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
616 * @type string
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
617 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
618 "sAjaxDataProp": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
619
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
620 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
621 * Note if draw should be blocked while getting data
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
622 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
623 * @default true
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
624 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
625 "bAjaxDataGet": true,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
626
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
627 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
628 * The last jQuery XHR object that was used for server-side data gathering.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
629 * This can be used for working with the XHR information in one of the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
630 * callbacks
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
631 * @type object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
632 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
633 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
634 "jqXHR": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
635
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
636 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
637 * Function to get the server-side data.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
638 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
639 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
640 * @type function
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
641 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
642 "fnServerData": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
643
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
644 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
645 * Functions which are called prior to sending an Ajax request so extra
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
646 * parameters can easily be sent to the server
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
647 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
648 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
649 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
650 "aoServerParams": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
651
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
652 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
653 * Send the XHR HTTP method - GET or POST (could be PUT or DELETE if
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
654 * required).
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
655 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
656 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
657 * @type string
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
658 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
659 "sServerMethod": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
660
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
661 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
662 * Format numbers for display.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
663 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
664 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
665 * @type function
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
666 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
667 "fnFormatNumber": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
668
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
669 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
670 * List of options that can be used for the user selectable length menu.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
671 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
672 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
673 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
674 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
675 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
676 "aLengthMenu": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
677
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
678 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
679 * Counter for the draws that the table does. Also used as a tracker for
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
680 * server-side processing
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
681 * @type int
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
682 * @default 0
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
683 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
684 "iDraw": 0,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
685
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
686 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
687 * Indicate if a redraw is being done - useful for Ajax
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
688 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
689 * @default false
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
690 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
691 "bDrawing": false,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
692
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
693 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
694 * Draw index (iDraw) of the last error when parsing the returned data
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
695 * @type int
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
696 * @default -1
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
697 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
698 "iDrawError": -1,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
699
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
700 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
701 * Paging display length
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
702 * @type int
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
703 * @default 10
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
704 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
705 "_iDisplayLength": 10,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
706
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
707 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
708 * Paging start point - aiDisplay index
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
709 * @type int
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
710 * @default 0
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
711 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
712 "_iDisplayStart": 0,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
713
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
714 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
715 * Paging end point - aiDisplay index. Use fnDisplayEnd rather than
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
716 * this property to get the end point
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
717 * @type int
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
718 * @default 10
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
719 * @private
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
720 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
721 "_iDisplayEnd": 10,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
722
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
723 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
724 * Server-side processing - number of records in the result set
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
725 * (i.e. before filtering), Use fnRecordsTotal rather than
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
726 * this property to get the value of the number of records, regardless of
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
727 * the server-side processing setting.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
728 * @type int
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
729 * @default 0
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
730 * @private
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
731 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
732 "_iRecordsTotal": 0,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
733
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
734 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
735 * Server-side processing - number of records in the current display set
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
736 * (i.e. after filtering). Use fnRecordsDisplay rather than
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
737 * this property to get the value of the number of records, regardless of
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
738 * the server-side processing setting.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
739 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
740 * @default 0
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
741 * @private
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
742 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
743 "_iRecordsDisplay": 0,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
744
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
745 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
746 * Flag to indicate if jQuery UI marking and classes should be used.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
747 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
748 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
749 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
750 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
751 "bJUI": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
752
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
753 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
754 * The classes to use for the table
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
755 * @type object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
756 * @default {}
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
757 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
758 "oClasses": {},
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
759
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
760 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
761 * Flag attached to the settings object so you can check in the draw
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
762 * callback if filtering has been done in the draw. Deprecated in favour of
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
763 * events.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
764 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
765 * @default false
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
766 * @deprecated
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
767 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
768 "bFiltered": false,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
769
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
770 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
771 * Flag attached to the settings object so you can check in the draw
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
772 * callback if sorting has been done in the draw. Deprecated in favour of
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
773 * events.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
774 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
775 * @default false
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
776 * @deprecated
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
777 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
778 "bSorted": false,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
779
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
780 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
781 * Indicate that if multiple rows are in the header and there is more than
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
782 * one unique cell per column, if the top one (true) or bottom one (false)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
783 * should be used for sorting / title by DataTables.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
784 * Note that this parameter will be set by the initialisation routine. To
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
785 * set a default use {@link DataTable.defaults}.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
786 * @type boolean
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
787 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
788 "bSortCellsTop": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
789
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
790 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
791 * Initialisation object that is used for the table
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
792 * @type object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
793 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
794 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
795 "oInit": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
796
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
797 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
798 * Destroy callback functions - for plug-ins to attach themselves to the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
799 * destroy so they can clean up markup and events.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
800 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
801 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
802 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
803 "aoDestroyCallback": [],
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
804
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
805
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
806 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
807 * Get the number of records in the current record set, before filtering
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
808 * @type function
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
809 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
810 "fnRecordsTotal": function ()
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
811 {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
812 if ( this.oFeatures.bServerSide ) {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
813 return parseInt(this._iRecordsTotal, 10);
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
814 } else {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
815 return this.aiDisplayMaster.length;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
816 }
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
817 },
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
818
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
819 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
820 * Get the number of records in the current record set, after filtering
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
821 * @type function
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
822 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
823 "fnRecordsDisplay": function ()
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
824 {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
825 if ( this.oFeatures.bServerSide ) {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
826 return parseInt(this._iRecordsDisplay, 10);
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
827 } else {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
828 return this.aiDisplay.length;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
829 }
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
830 },
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
831
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
832 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
833 * Set the display end point - aiDisplay index
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
834 * @type function
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
835 * @todo Should do away with _iDisplayEnd and calculate it on-the-fly here
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
836 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
837 "fnDisplayEnd": function ()
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
838 {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
839 if ( this.oFeatures.bServerSide ) {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
840 if ( this.oFeatures.bPaginate === false || this._iDisplayLength == -1 ) {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
841 return this._iDisplayStart+this.aiDisplay.length;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
842 } else {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
843 return Math.min( this._iDisplayStart+this._iDisplayLength,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
844 this._iRecordsDisplay );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
845 }
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
846 } else {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
847 return this._iDisplayEnd;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
848 }
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
849 },
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
850
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
851 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
852 * The DataTables object for this table
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
853 * @type object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
854 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
855 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
856 "oInstance": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
857
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
858 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
859 * Unique identifier for each instance of the DataTables object. If there
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
860 * is an ID on the table node, then it takes that value, otherwise an
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
861 * incrementing internal counter is used.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
862 * @type string
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
863 * @default null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
864 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
865 "sInstance": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
866
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
867 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
868 * tabindex attribute value that is added to DataTables control elements, allowing
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
869 * keyboard navigation of the table and its controls.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
870 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
871 "iTabIndex": 0,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
872
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
873 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
874 * DIV container for the footer scrolling table if scrolling
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
875 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
876 "nScrollHead": null,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
877
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
878 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
879 * DIV container for the footer scrolling table if scrolling
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
880 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
881 "nScrollFoot": null
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
882 };