|
1 <!DOCTYPE html> |
|
2 <html lang="en"> |
|
3 <head> |
|
4 <meta charset="utf-8"> |
|
5 <title>DataTable - YUI 3</title> |
|
6 <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css"> |
|
7 <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> |
|
8 <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> |
|
9 <link rel="shortcut icon" type="image/png" href="../assets/favicon.png"> |
|
10 <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script> |
|
11 </head> |
|
12 <body class="yui3-skin-sam"> |
|
13 |
|
14 <div id="doc"> |
|
15 <div id="hd" class="yui3-g header"> |
|
16 <div class="yui3-u-3-4"> |
|
17 |
|
18 <h1><img src="../assets/css/logo.png" title="YUI 3"></h1> |
|
19 |
|
20 </div> |
|
21 <div class="yui3-u-1-4 version"> |
|
22 <em>API Docs for: 3.10.3</em> |
|
23 </div> |
|
24 </div> |
|
25 <div id="bd" class="yui3-g"> |
|
26 |
|
27 <div class="yui3-u-1-4"> |
|
28 <div id="docs-sidebar" class="sidebar apidocs"> |
|
29 <div id="api-list"> |
|
30 <h2 class="off-left">APIs</h2> |
|
31 <div id="api-tabview" class="tabview"> |
|
32 <ul class="tabs"> |
|
33 <li><a href="#api-classes">Classes</a></li> |
|
34 <li><a href="#api-modules">Modules</a></li> |
|
35 </ul> |
|
36 |
|
37 <div id="api-tabview-filter"> |
|
38 <input type="search" id="api-filter" placeholder="Type to filter APIs"> |
|
39 </div> |
|
40 |
|
41 <div id="api-tabview-panel"> |
|
42 <ul id="api-classes" class="apis classes"> |
|
43 |
|
44 <li><a href="../classes/Anim.html">Anim</a></li> |
|
45 |
|
46 <li><a href="../classes/App.html">App</a></li> |
|
47 |
|
48 <li><a href="../classes/App.Base.html">App.Base</a></li> |
|
49 |
|
50 <li><a href="../classes/App.Content.html">App.Content</a></li> |
|
51 |
|
52 <li><a href="../classes/App.Transitions.html">App.Transitions</a></li> |
|
53 |
|
54 <li><a href="../classes/App.TransitionsNative.html">App.TransitionsNative</a></li> |
|
55 |
|
56 <li><a href="../classes/AreaSeries.html">AreaSeries</a></li> |
|
57 |
|
58 <li><a href="../classes/AreaSplineSeries.html">AreaSplineSeries</a></li> |
|
59 |
|
60 <li><a href="../classes/Array.html">Array</a></li> |
|
61 |
|
62 <li><a href="../classes/ArrayList.html">ArrayList</a></li> |
|
63 |
|
64 <li><a href="../classes/ArraySort.html">ArraySort</a></li> |
|
65 |
|
66 <li><a href="../classes/AsyncQueue.html">AsyncQueue</a></li> |
|
67 |
|
68 <li><a href="../classes/Attribute.html">Attribute</a></li> |
|
69 |
|
70 <li><a href="../classes/AttributeCore.html">AttributeCore</a></li> |
|
71 |
|
72 <li><a href="../classes/AttributeEvents.html">AttributeEvents</a></li> |
|
73 |
|
74 <li><a href="../classes/AttributeExtras.html">AttributeExtras</a></li> |
|
75 |
|
76 <li><a href="../classes/AttributeLite.html">AttributeLite</a></li> |
|
77 |
|
78 <li><a href="../classes/AttributeObservable.html">AttributeObservable</a></li> |
|
79 |
|
80 <li><a href="../classes/AutoComplete.html">AutoComplete</a></li> |
|
81 |
|
82 <li><a href="../classes/AutoCompleteBase.html">AutoCompleteBase</a></li> |
|
83 |
|
84 <li><a href="../classes/AutoCompleteFilters.html">AutoCompleteFilters</a></li> |
|
85 |
|
86 <li><a href="../classes/AutoCompleteHighlighters.html">AutoCompleteHighlighters</a></li> |
|
87 |
|
88 <li><a href="../classes/AutoCompleteList.html">AutoCompleteList</a></li> |
|
89 |
|
90 <li><a href="../classes/Axis.html">Axis</a></li> |
|
91 |
|
92 <li><a href="../classes/AxisBase.html">AxisBase</a></li> |
|
93 |
|
94 <li><a href="../classes/BarSeries.html">BarSeries</a></li> |
|
95 |
|
96 <li><a href="../classes/Base.html">Base</a></li> |
|
97 |
|
98 <li><a href="../classes/BaseCore.html">BaseCore</a></li> |
|
99 |
|
100 <li><a href="../classes/BaseObservable.html">BaseObservable</a></li> |
|
101 |
|
102 <li><a href="../classes/BottomAxisLayout.html">BottomAxisLayout</a></li> |
|
103 |
|
104 <li><a href="../classes/Button.html">Button</a></li> |
|
105 |
|
106 <li><a href="../classes/ButtonCore.html">ButtonCore</a></li> |
|
107 |
|
108 <li><a href="../classes/ButtonGroup.html">ButtonGroup</a></li> |
|
109 |
|
110 <li><a href="../classes/Cache.html">Cache</a></li> |
|
111 |
|
112 <li><a href="../classes/CacheOffline.html">CacheOffline</a></li> |
|
113 |
|
114 <li><a href="../classes/Calendar.html">Calendar</a></li> |
|
115 |
|
116 <li><a href="../classes/CalendarBase.html">CalendarBase</a></li> |
|
117 |
|
118 <li><a href="../classes/CandlestickSeries.html">CandlestickSeries</a></li> |
|
119 |
|
120 <li><a href="../classes/CanvasCircle.html">CanvasCircle</a></li> |
|
121 |
|
122 <li><a href="../classes/CanvasDrawing.html">CanvasDrawing</a></li> |
|
123 |
|
124 <li><a href="../classes/CanvasEllipse.html">CanvasEllipse</a></li> |
|
125 |
|
126 <li><a href="../classes/CanvasGraphic.html">CanvasGraphic</a></li> |
|
127 |
|
128 <li><a href="../classes/CanvasPath.html">CanvasPath</a></li> |
|
129 |
|
130 <li><a href="../classes/CanvasPieSlice.html">CanvasPieSlice</a></li> |
|
131 |
|
132 <li><a href="../classes/CanvasRect.html">CanvasRect</a></li> |
|
133 |
|
134 <li><a href="../classes/CanvasShape.html">CanvasShape</a></li> |
|
135 |
|
136 <li><a href="../classes/CartesianChart.html">CartesianChart</a></li> |
|
137 |
|
138 <li><a href="../classes/CartesianSeries.html">CartesianSeries</a></li> |
|
139 |
|
140 <li><a href="../classes/CategoryAxis.html">CategoryAxis</a></li> |
|
141 |
|
142 <li><a href="../classes/CategoryAxisBase.html">CategoryAxisBase</a></li> |
|
143 |
|
144 <li><a href="../classes/CategoryImpl.html">CategoryImpl</a></li> |
|
145 |
|
146 <li><a href="../classes/Chart.html">Chart</a></li> |
|
147 |
|
148 <li><a href="../classes/ChartBase.html">ChartBase</a></li> |
|
149 |
|
150 <li><a href="../classes/ChartLegend.html">ChartLegend</a></li> |
|
151 |
|
152 <li><a href="../classes/Circle.html">Circle</a></li> |
|
153 |
|
154 <li><a href="../classes/CircleGroup.html">CircleGroup</a></li> |
|
155 |
|
156 <li><a href="../classes/ClassNameManager.html">ClassNameManager</a></li> |
|
157 |
|
158 <li><a href="../classes/ClickableRail.html">ClickableRail</a></li> |
|
159 |
|
160 <li><a href="../classes/Color.html">Color</a></li> |
|
161 |
|
162 <li><a href="../classes/Color.Harmony.html">Color.Harmony</a></li> |
|
163 |
|
164 <li><a href="../classes/Color.HSL.html">Color.HSL</a></li> |
|
165 |
|
166 <li><a href="../classes/Color.HSV.html">Color.HSV</a></li> |
|
167 |
|
168 <li><a href="../classes/ColumnSeries.html">ColumnSeries</a></li> |
|
169 |
|
170 <li><a href="../classes/ComboSeries.html">ComboSeries</a></li> |
|
171 |
|
172 <li><a href="../classes/ComboSplineSeries.html">ComboSplineSeries</a></li> |
|
173 |
|
174 <li><a href="../classes/config.html">config</a></li> |
|
175 |
|
176 <li><a href="../classes/Console.html">Console</a></li> |
|
177 |
|
178 <li><a href="../classes/Controller.html">Controller</a></li> |
|
179 |
|
180 <li><a href="../classes/Cookie.html">Cookie</a></li> |
|
181 |
|
182 <li><a href="../classes/CurveUtil.html">CurveUtil</a></li> |
|
183 |
|
184 <li><a href="../classes/CustomEvent.html">CustomEvent</a></li> |
|
185 |
|
186 <li><a href="../classes/DataSchema.Array.html">DataSchema.Array</a></li> |
|
187 |
|
188 <li><a href="../classes/DataSchema.Base.html">DataSchema.Base</a></li> |
|
189 |
|
190 <li><a href="../classes/DataSchema.JSON.html">DataSchema.JSON</a></li> |
|
191 |
|
192 <li><a href="../classes/DataSchema.Text.html">DataSchema.Text</a></li> |
|
193 |
|
194 <li><a href="../classes/DataSchema.XML.html">DataSchema.XML</a></li> |
|
195 |
|
196 <li><a href="../classes/DataSource.Function.html">DataSource.Function</a></li> |
|
197 |
|
198 <li><a href="../classes/DataSource.Get.html">DataSource.Get</a></li> |
|
199 |
|
200 <li><a href="../classes/DataSource.IO.html">DataSource.IO</a></li> |
|
201 |
|
202 <li><a href="../classes/DataSource.Local.html">DataSource.Local</a></li> |
|
203 |
|
204 <li><a href="../classes/DataSourceArraySchema.html">DataSourceArraySchema</a></li> |
|
205 |
|
206 <li><a href="../classes/DataSourceCache.html">DataSourceCache</a></li> |
|
207 |
|
208 <li><a href="../classes/DataSourceCacheExtension.html">DataSourceCacheExtension</a></li> |
|
209 |
|
210 <li><a href="../classes/DataSourceJSONSchema.html">DataSourceJSONSchema</a></li> |
|
211 |
|
212 <li><a href="../classes/DataSourceTextSchema.html">DataSourceTextSchema</a></li> |
|
213 |
|
214 <li><a href="../classes/DataSourceXMLSchema.html">DataSourceXMLSchema</a></li> |
|
215 |
|
216 <li><a href="../classes/DataTable.html">DataTable</a></li> |
|
217 |
|
218 <li><a href="../classes/DataTable.Base.html">DataTable.Base</a></li> |
|
219 |
|
220 <li><a href="../classes/DataTable.BodyView.html">DataTable.BodyView</a></li> |
|
221 |
|
222 <li><a href="../classes/DataTable.BodyView.Formatters.html">DataTable.BodyView.Formatters</a></li> |
|
223 |
|
224 <li><a href="../classes/DataTable.ColumnWidths.html">DataTable.ColumnWidths</a></li> |
|
225 |
|
226 <li><a href="../classes/DataTable.Core.html">DataTable.Core</a></li> |
|
227 |
|
228 <li><a href="../classes/DataTable.HeaderView.html">DataTable.HeaderView</a></li> |
|
229 |
|
230 <li><a href="../classes/DataTable.Message.html">DataTable.Message</a></li> |
|
231 |
|
232 <li><a href="../classes/DataTable.Mutable.html">DataTable.Mutable</a></li> |
|
233 |
|
234 <li><a href="../classes/DataTable.Scrollable.html">DataTable.Scrollable</a></li> |
|
235 |
|
236 <li><a href="../classes/DataTable.Sortable.html">DataTable.Sortable</a></li> |
|
237 |
|
238 <li><a href="../classes/DataTable.TableView.html">DataTable.TableView</a></li> |
|
239 |
|
240 <li><a href="../classes/Date.html">Date</a></li> |
|
241 |
|
242 <li><a href="../classes/DD.DDM.html">DD.DDM</a></li> |
|
243 |
|
244 <li><a href="../classes/DD.Delegate.html">DD.Delegate</a></li> |
|
245 |
|
246 <li><a href="../classes/DD.Drag.html">DD.Drag</a></li> |
|
247 |
|
248 <li><a href="../classes/DD.Drop.html">DD.Drop</a></li> |
|
249 |
|
250 <li><a href="../classes/DD.Scroll.html">DD.Scroll</a></li> |
|
251 |
|
252 <li><a href="../classes/Dial.html">Dial</a></li> |
|
253 |
|
254 <li><a href="../classes/Do.html">Do</a></li> |
|
255 |
|
256 <li><a href="../classes/Do.AlterArgs.html">Do.AlterArgs</a></li> |
|
257 |
|
258 <li><a href="../classes/Do.AlterReturn.html">Do.AlterReturn</a></li> |
|
259 |
|
260 <li><a href="../classes/Do.Error.html">Do.Error</a></li> |
|
261 |
|
262 <li><a href="../classes/Do.Halt.html">Do.Halt</a></li> |
|
263 |
|
264 <li><a href="../classes/Do.Method.html">Do.Method</a></li> |
|
265 |
|
266 <li><a href="../classes/Do.Prevent.html">Do.Prevent</a></li> |
|
267 |
|
268 <li><a href="../classes/DOM.html">DOM</a></li> |
|
269 |
|
270 <li><a href="../classes/DOMEventFacade.html">DOMEventFacade</a></li> |
|
271 |
|
272 <li><a href="../classes/Drawing.html">Drawing</a></li> |
|
273 |
|
274 <li><a href="../classes/Easing.html">Easing</a></li> |
|
275 |
|
276 <li><a href="../classes/EditorBase.html">EditorBase</a></li> |
|
277 |
|
278 <li><a href="../classes/EditorSelection.html">EditorSelection</a></li> |
|
279 |
|
280 <li><a href="../classes/Ellipse.html">Ellipse</a></li> |
|
281 |
|
282 <li><a href="../classes/EllipseGroup.html">EllipseGroup</a></li> |
|
283 |
|
284 <li><a href="../classes/Escape.html">Escape</a></li> |
|
285 |
|
286 <li><a href="../classes/Event.html">Event</a></li> |
|
287 |
|
288 <li><a href="../classes/EventFacade.html">EventFacade</a></li> |
|
289 |
|
290 <li><a href="../classes/EventHandle.html">EventHandle</a></li> |
|
291 |
|
292 <li><a href="../classes/EventTarget.html">EventTarget</a></li> |
|
293 |
|
294 <li><a href="../classes/ExecCommand.html">ExecCommand</a></li> |
|
295 |
|
296 <li><a href="../classes/Features.html">Features</a></li> |
|
297 |
|
298 <li><a href="../classes/File.html">File</a></li> |
|
299 |
|
300 <li><a href="../classes/FileFlash.html">FileFlash</a></li> |
|
301 |
|
302 <li><a href="../classes/FileHTML5.html">FileHTML5</a></li> |
|
303 |
|
304 <li><a href="../classes/Fills.html">Fills</a></li> |
|
305 |
|
306 <li><a href="../classes/Frame.html">Frame</a></li> |
|
307 |
|
308 <li><a href="../classes/Get.html">Get</a></li> |
|
309 |
|
310 <li><a href="../classes/Get.Transaction.html">Get.Transaction</a></li> |
|
311 |
|
312 <li><a href="../classes/GetNodeJS.html">GetNodeJS</a></li> |
|
313 |
|
314 <li><a href="../classes/Graph.html">Graph</a></li> |
|
315 |
|
316 <li><a href="../classes/Graphic.html">Graphic</a></li> |
|
317 |
|
318 <li><a href="../classes/GraphicBase.html">GraphicBase</a></li> |
|
319 |
|
320 <li><a href="../classes/Gridlines.html">Gridlines</a></li> |
|
321 |
|
322 <li><a href="../classes/GroupDiamond.html">GroupDiamond</a></li> |
|
323 |
|
324 <li><a href="../classes/GroupRect.html">GroupRect</a></li> |
|
325 |
|
326 <li><a href="../classes/Handlebars.html">Handlebars</a></li> |
|
327 |
|
328 <li><a href="../classes/Highlight.html">Highlight</a></li> |
|
329 |
|
330 <li><a href="../classes/Histogram.html">Histogram</a></li> |
|
331 |
|
332 <li><a href="../classes/HistoryBase.html">HistoryBase</a></li> |
|
333 |
|
334 <li><a href="../classes/HistoryHash.html">HistoryHash</a></li> |
|
335 |
|
336 <li><a href="../classes/HistoryHTML5.html">HistoryHTML5</a></li> |
|
337 |
|
338 <li><a href="../classes/HorizontalLegendLayout.html">HorizontalLegendLayout</a></li> |
|
339 |
|
340 <li><a href="../classes/ImgLoadGroup.html">ImgLoadGroup</a></li> |
|
341 |
|
342 <li><a href="../classes/ImgLoadImgObj.html">ImgLoadImgObj</a></li> |
|
343 |
|
344 <li><a href="../classes/Intl.html">Intl</a></li> |
|
345 |
|
346 <li><a href="../classes/IO.html">IO</a></li> |
|
347 |
|
348 <li><a href="../classes/JSON.html">JSON</a></li> |
|
349 |
|
350 <li><a href="../classes/JSONPRequest.html">JSONPRequest</a></li> |
|
351 |
|
352 <li><a href="../classes/Lang.html">Lang</a></li> |
|
353 |
|
354 <li><a href="../classes/LazyModelList.html">LazyModelList</a></li> |
|
355 |
|
356 <li><a href="../classes/LeftAxisLayout.html">LeftAxisLayout</a></li> |
|
357 |
|
358 <li><a href="../classes/Lines.html">Lines</a></li> |
|
359 |
|
360 <li><a href="../classes/LineSeries.html">LineSeries</a></li> |
|
361 |
|
362 <li><a href="../classes/Loader.html">Loader</a></li> |
|
363 |
|
364 <li><a href="../classes/MarkerSeries.html">MarkerSeries</a></li> |
|
365 |
|
366 <li><a href="../classes/Matrix.html">Matrix</a></li> |
|
367 |
|
368 <li><a href="../classes/MatrixUtil.html">MatrixUtil</a></li> |
|
369 |
|
370 <li><a href="../classes/Model.html">Model</a></li> |
|
371 |
|
372 <li><a href="../classes/ModelList.html">ModelList</a></li> |
|
373 |
|
374 <li><a href="../classes/ModelSync.REST.html">ModelSync.REST</a></li> |
|
375 |
|
376 <li><a href="../classes/Node.html">Node</a></li> |
|
377 |
|
378 <li><a href="../classes/NodeList.html">NodeList</a></li> |
|
379 |
|
380 <li><a href="../classes/Number.html">Number</a></li> |
|
381 |
|
382 <li><a href="../classes/NumericAxis.html">NumericAxis</a></li> |
|
383 |
|
384 <li><a href="../classes/NumericAxisBase.html">NumericAxisBase</a></li> |
|
385 |
|
386 <li><a href="../classes/NumericImpl.html">NumericImpl</a></li> |
|
387 |
|
388 <li><a href="../classes/Object.html">Object</a></li> |
|
389 |
|
390 <li><a href="../classes/OHLCSeries.html">OHLCSeries</a></li> |
|
391 |
|
392 <li><a href="../classes/Overlay.html">Overlay</a></li> |
|
393 |
|
394 <li><a href="../classes/Panel.html">Panel</a></li> |
|
395 |
|
396 <li><a href="../classes/Parallel.html">Parallel</a></li> |
|
397 |
|
398 <li><a href="../classes/Path.html">Path</a></li> |
|
399 |
|
400 <li><a href="../classes/PieChart.html">PieChart</a></li> |
|
401 |
|
402 <li><a href="../classes/PieSeries.html">PieSeries</a></li> |
|
403 |
|
404 <li><a href="../classes/Pjax.html">Pjax</a></li> |
|
405 |
|
406 <li><a href="../classes/PjaxBase.html">PjaxBase</a></li> |
|
407 |
|
408 <li><a href="../classes/PjaxContent.html">PjaxContent</a></li> |
|
409 |
|
410 <li><a href="../classes/Plots.html">Plots</a></li> |
|
411 |
|
412 <li><a href="../classes/Plugin.Align.html">Plugin.Align</a></li> |
|
413 |
|
414 <li><a href="../classes/Plugin.AutoComplete.html">Plugin.AutoComplete</a></li> |
|
415 |
|
416 <li><a href="../classes/Plugin.Base.html">Plugin.Base</a></li> |
|
417 |
|
418 <li><a href="../classes/Plugin.Button.html">Plugin.Button</a></li> |
|
419 |
|
420 <li><a href="../classes/Plugin.Cache.html">Plugin.Cache</a></li> |
|
421 |
|
422 <li><a href="../classes/Plugin.CalendarNavigator.html">Plugin.CalendarNavigator</a></li> |
|
423 |
|
424 <li><a href="../classes/Plugin.ConsoleFilters.html">Plugin.ConsoleFilters</a></li> |
|
425 |
|
426 <li><a href="../classes/Plugin.CreateLinkBase.html">Plugin.CreateLinkBase</a></li> |
|
427 |
|
428 <li><a href="../classes/Plugin.DataTableDataSource.html">Plugin.DataTableDataSource</a></li> |
|
429 |
|
430 <li><a href="../classes/Plugin.DDConstrained.html">Plugin.DDConstrained</a></li> |
|
431 |
|
432 <li><a href="../classes/Plugin.DDNodeScroll.html">Plugin.DDNodeScroll</a></li> |
|
433 |
|
434 <li><a href="../classes/Plugin.DDProxy.html">Plugin.DDProxy</a></li> |
|
435 |
|
436 <li><a href="../classes/Plugin.DDWindowScroll.html">Plugin.DDWindowScroll</a></li> |
|
437 |
|
438 <li><a href="../classes/Plugin.Drag.html">Plugin.Drag</a></li> |
|
439 |
|
440 <li><a href="../classes/Plugin.Drop.html">Plugin.Drop</a></li> |
|
441 |
|
442 <li><a href="../classes/Plugin.EditorBidi.html">Plugin.EditorBidi</a></li> |
|
443 |
|
444 <li><a href="../classes/Plugin.EditorBR.html">Plugin.EditorBR</a></li> |
|
445 |
|
446 <li><a href="../classes/Plugin.EditorLists.html">Plugin.EditorLists</a></li> |
|
447 |
|
448 <li><a href="../classes/Plugin.EditorPara.html">Plugin.EditorPara</a></li> |
|
449 |
|
450 <li><a href="../classes/Plugin.EditorParaBase.html">Plugin.EditorParaBase</a></li> |
|
451 |
|
452 <li><a href="../classes/Plugin.EditorParaIE.html">Plugin.EditorParaIE</a></li> |
|
453 |
|
454 <li><a href="../classes/Plugin.EditorTab.html">Plugin.EditorTab</a></li> |
|
455 |
|
456 <li><a href="../classes/Plugin.ExecCommand.html">Plugin.ExecCommand</a></li> |
|
457 |
|
458 <li><a href="../classes/Plugin.Flick.html">Plugin.Flick</a></li> |
|
459 |
|
460 <li><a href="../classes/Plugin.Host.html">Plugin.Host</a></li> |
|
461 |
|
462 <li><a href="../classes/plugin.NodeFocusManager.html">plugin.NodeFocusManager</a></li> |
|
463 |
|
464 <li><a href="../classes/Plugin.NodeFX.html">Plugin.NodeFX</a></li> |
|
465 |
|
466 <li><a href="../classes/plugin.NodeMenuNav.html">plugin.NodeMenuNav</a></li> |
|
467 |
|
468 <li><a href="../classes/Plugin.Pjax.html">Plugin.Pjax</a></li> |
|
469 |
|
470 <li><a href="../classes/Plugin.Resize.html">Plugin.Resize</a></li> |
|
471 |
|
472 <li><a href="../classes/Plugin.ResizeConstrained.html">Plugin.ResizeConstrained</a></li> |
|
473 |
|
474 <li><a href="../classes/Plugin.ResizeProxy.html">Plugin.ResizeProxy</a></li> |
|
475 |
|
476 <li><a href="../classes/Plugin.ScrollInfo.html">Plugin.ScrollInfo</a></li> |
|
477 |
|
478 <li><a href="../classes/Plugin.ScrollViewList.html">Plugin.ScrollViewList</a></li> |
|
479 |
|
480 <li><a href="../classes/Plugin.ScrollViewPaginator.html">Plugin.ScrollViewPaginator</a></li> |
|
481 |
|
482 <li><a href="../classes/Plugin.ScrollViewScrollbars.html">Plugin.ScrollViewScrollbars</a></li> |
|
483 |
|
484 <li><a href="../classes/Plugin.Shim.html">Plugin.Shim</a></li> |
|
485 |
|
486 <li><a href="../classes/Plugin.SortScroll.html">Plugin.SortScroll</a></li> |
|
487 |
|
488 <li><a href="../classes/Plugin.Tree.Lazy.html">Plugin.Tree.Lazy</a></li> |
|
489 |
|
490 <li><a href="../classes/Plugin.WidgetAnim.html">Plugin.WidgetAnim</a></li> |
|
491 |
|
492 <li><a href="../classes/Pollable.html">Pollable</a></li> |
|
493 |
|
494 <li><a href="../classes/Promise.html">Promise</a></li> |
|
495 |
|
496 <li><a href="../classes/Promise.Resolver.html">Promise.Resolver</a></li> |
|
497 |
|
498 <li><a href="../classes/QueryString.html">QueryString</a></li> |
|
499 |
|
500 <li><a href="../classes/Queue.html">Queue</a></li> |
|
501 |
|
502 <li><a href="../classes/RangeSeries.html">RangeSeries</a></li> |
|
503 |
|
504 <li><a href="../classes/Record.html">Record</a></li> |
|
505 |
|
506 <li><a href="../classes/Recordset.html">Recordset</a></li> |
|
507 |
|
508 <li><a href="../classes/RecordsetFilter.html">RecordsetFilter</a></li> |
|
509 |
|
510 <li><a href="../classes/RecordsetIndexer.html">RecordsetIndexer</a></li> |
|
511 |
|
512 <li><a href="../classes/RecordsetSort.html">RecordsetSort</a></li> |
|
513 |
|
514 <li><a href="../classes/Rect.html">Rect</a></li> |
|
515 |
|
516 <li><a href="../classes/Renderer.html">Renderer</a></li> |
|
517 |
|
518 <li><a href="../classes/Resize.html">Resize</a></li> |
|
519 |
|
520 <li><a href="../classes/RightAxisLayout.html">RightAxisLayout</a></li> |
|
521 |
|
522 <li><a href="../classes/Router.html">Router</a></li> |
|
523 |
|
524 <li><a href="../classes/ScrollView.html">ScrollView</a></li> |
|
525 |
|
526 <li><a href="../classes/Selector.html">Selector</a></li> |
|
527 |
|
528 <li><a href="../classes/SeriesBase.html">SeriesBase</a></li> |
|
529 |
|
530 <li><a href="../classes/Shape.html">Shape</a></li> |
|
531 |
|
532 <li><a href="../classes/ShapeGroup.html">ShapeGroup</a></li> |
|
533 |
|
534 <li><a href="../classes/Slider.html">Slider</a></li> |
|
535 |
|
536 <li><a href="../classes/SliderBase.html">SliderBase</a></li> |
|
537 |
|
538 <li><a href="../classes/SliderValueRange.html">SliderValueRange</a></li> |
|
539 |
|
540 <li><a href="../classes/soon.html">soon</a></li> |
|
541 |
|
542 <li><a href="../classes/Sortable.html">Sortable</a></li> |
|
543 |
|
544 <li><a href="../classes/SplineSeries.html">SplineSeries</a></li> |
|
545 |
|
546 <li><a href="../classes/StackedAreaSeries.html">StackedAreaSeries</a></li> |
|
547 |
|
548 <li><a href="../classes/StackedAreaSplineSeries.html">StackedAreaSplineSeries</a></li> |
|
549 |
|
550 <li><a href="../classes/StackedAxis.html">StackedAxis</a></li> |
|
551 |
|
552 <li><a href="../classes/StackedAxisBase.html">StackedAxisBase</a></li> |
|
553 |
|
554 <li><a href="../classes/StackedBarSeries.html">StackedBarSeries</a></li> |
|
555 |
|
556 <li><a href="../classes/StackedColumnSeries.html">StackedColumnSeries</a></li> |
|
557 |
|
558 <li><a href="../classes/StackedComboSeries.html">StackedComboSeries</a></li> |
|
559 |
|
560 <li><a href="../classes/StackedComboSplineSeries.html">StackedComboSplineSeries</a></li> |
|
561 |
|
562 <li><a href="../classes/StackedImpl.html">StackedImpl</a></li> |
|
563 |
|
564 <li><a href="../classes/StackedLineSeries.html">StackedLineSeries</a></li> |
|
565 |
|
566 <li><a href="../classes/StackedMarkerSeries.html">StackedMarkerSeries</a></li> |
|
567 |
|
568 <li><a href="../classes/StackedSplineSeries.html">StackedSplineSeries</a></li> |
|
569 |
|
570 <li><a href="../classes/StackingUtil.html">StackingUtil</a></li> |
|
571 |
|
572 <li><a href="../classes/State.html">State</a></li> |
|
573 |
|
574 <li><a href="../classes/StyleSheet.html">StyleSheet</a></li> |
|
575 |
|
576 <li><a href="../classes/Subscriber.html">Subscriber</a></li> |
|
577 |
|
578 <li><a href="../classes/SVGCircle.html">SVGCircle</a></li> |
|
579 |
|
580 <li><a href="../classes/SVGDrawing.html">SVGDrawing</a></li> |
|
581 |
|
582 <li><a href="../classes/SVGEllipse.html">SVGEllipse</a></li> |
|
583 |
|
584 <li><a href="../classes/SVGGraphic.html">SVGGraphic</a></li> |
|
585 |
|
586 <li><a href="../classes/SVGPath.html">SVGPath</a></li> |
|
587 |
|
588 <li><a href="../classes/SVGPieSlice.html">SVGPieSlice</a></li> |
|
589 |
|
590 <li><a href="../classes/SVGRect.html">SVGRect</a></li> |
|
591 |
|
592 <li><a href="../classes/SVGShape.html">SVGShape</a></li> |
|
593 |
|
594 <li><a href="../classes/SWF.html">SWF</a></li> |
|
595 |
|
596 <li><a href="../classes/SWFDetect.html">SWFDetect</a></li> |
|
597 |
|
598 <li><a href="../classes/SyntheticEvent.html">SyntheticEvent</a></li> |
|
599 |
|
600 <li><a href="../classes/SyntheticEvent.Notifier.html">SyntheticEvent.Notifier</a></li> |
|
601 |
|
602 <li><a href="../classes/SynthRegistry.html">SynthRegistry</a></li> |
|
603 |
|
604 <li><a href="../classes/Tab.html">Tab</a></li> |
|
605 |
|
606 <li><a href="../classes/TabView.html">TabView</a></li> |
|
607 |
|
608 <li><a href="../classes/Template.html">Template</a></li> |
|
609 |
|
610 <li><a href="../classes/Template.Micro.html">Template.Micro</a></li> |
|
611 |
|
612 <li><a href="../classes/Test.ArrayAssert.html">Test.ArrayAssert</a></li> |
|
613 |
|
614 <li><a href="../classes/Test.Assert.html">Test.Assert</a></li> |
|
615 |
|
616 <li><a href="../classes/Test.AssertionError.html">Test.AssertionError</a></li> |
|
617 |
|
618 <li><a href="../classes/Test.ComparisonFailure.html">Test.ComparisonFailure</a></li> |
|
619 |
|
620 <li><a href="../classes/Test.Console.html">Test.Console</a></li> |
|
621 |
|
622 <li><a href="../classes/Test.CoverageFormat.html">Test.CoverageFormat</a></li> |
|
623 |
|
624 <li><a href="../classes/Test.DateAssert.html">Test.DateAssert</a></li> |
|
625 |
|
626 <li><a href="../classes/Test.EventTarget.html">Test.EventTarget</a></li> |
|
627 |
|
628 <li><a href="../classes/Test.Mock.html">Test.Mock</a></li> |
|
629 |
|
630 <li><a href="../classes/Test.Mock.Value.html">Test.Mock.Value</a></li> |
|
631 |
|
632 <li><a href="../classes/Test.ObjectAssert.html">Test.ObjectAssert</a></li> |
|
633 |
|
634 <li><a href="../classes/Test.Reporter.html">Test.Reporter</a></li> |
|
635 |
|
636 <li><a href="../classes/Test.Results.html">Test.Results</a></li> |
|
637 |
|
638 <li><a href="../classes/Test.Runner.html">Test.Runner</a></li> |
|
639 |
|
640 <li><a href="../classes/Test.ShouldError.html">Test.ShouldError</a></li> |
|
641 |
|
642 <li><a href="../classes/Test.ShouldFail.html">Test.ShouldFail</a></li> |
|
643 |
|
644 <li><a href="../classes/Test.TestCase.html">Test.TestCase</a></li> |
|
645 |
|
646 <li><a href="../classes/Test.TestFormat.html">Test.TestFormat</a></li> |
|
647 |
|
648 <li><a href="../classes/Test.TestNode.html">Test.TestNode</a></li> |
|
649 |
|
650 <li><a href="../classes/Test.TestRunner.html">Test.TestRunner</a></li> |
|
651 |
|
652 <li><a href="../classes/Test.TestSuite.html">Test.TestSuite</a></li> |
|
653 |
|
654 <li><a href="../classes/Test.UnexpectedError.html">Test.UnexpectedError</a></li> |
|
655 |
|
656 <li><a href="../classes/Test.UnexpectedValue.html">Test.UnexpectedValue</a></li> |
|
657 |
|
658 <li><a href="../classes/Test.Wait.html">Test.Wait</a></li> |
|
659 |
|
660 <li><a href="../classes/Text.AccentFold.html">Text.AccentFold</a></li> |
|
661 |
|
662 <li><a href="../classes/Text.WordBreak.html">Text.WordBreak</a></li> |
|
663 |
|
664 <li><a href="../classes/TimeAxis.html">TimeAxis</a></li> |
|
665 |
|
666 <li><a href="../classes/TimeAxisBase.html">TimeAxisBase</a></li> |
|
667 |
|
668 <li><a href="../classes/TimeImpl.html">TimeImpl</a></li> |
|
669 |
|
670 <li><a href="../classes/ToggleButton.html">ToggleButton</a></li> |
|
671 |
|
672 <li><a href="../classes/TopAxisLayout.html">TopAxisLayout</a></li> |
|
673 |
|
674 <li><a href="../classes/Transition.html">Transition</a></li> |
|
675 |
|
676 <li><a href="../classes/Tree.html">Tree</a></li> |
|
677 |
|
678 <li><a href="../classes/Tree.Labelable.html">Tree.Labelable</a></li> |
|
679 |
|
680 <li><a href="../classes/Tree.Node.html">Tree.Node</a></li> |
|
681 |
|
682 <li><a href="../classes/Tree.Node.Labelable.html">Tree.Node.Labelable</a></li> |
|
683 |
|
684 <li><a href="../classes/Tree.Node.Openable.html">Tree.Node.Openable</a></li> |
|
685 |
|
686 <li><a href="../classes/Tree.Node.Selectable.html">Tree.Node.Selectable</a></li> |
|
687 |
|
688 <li><a href="../classes/Tree.Node.Sortable.html">Tree.Node.Sortable</a></li> |
|
689 |
|
690 <li><a href="../classes/Tree.Openable.html">Tree.Openable</a></li> |
|
691 |
|
692 <li><a href="../classes/Tree.Selectable.html">Tree.Selectable</a></li> |
|
693 |
|
694 <li><a href="../classes/Tree.Sortable.html">Tree.Sortable</a></li> |
|
695 |
|
696 <li><a href="../classes/UA.html">UA</a></li> |
|
697 |
|
698 <li><a href="../classes/Uploader.html">Uploader</a></li> |
|
699 |
|
700 <li><a href="../classes/Uploader.Queue.html">Uploader.Queue</a></li> |
|
701 |
|
702 <li><a href="../classes/UploaderFlash.html">UploaderFlash</a></li> |
|
703 |
|
704 <li><a href="../classes/UploaderHTML5.html">UploaderHTML5</a></li> |
|
705 |
|
706 <li><a href="../classes/ValueChange.html">ValueChange</a></li> |
|
707 |
|
708 <li><a href="../classes/VerticalLegendLayout.html">VerticalLegendLayout</a></li> |
|
709 |
|
710 <li><a href="../classes/View.html">View</a></li> |
|
711 |
|
712 <li><a href="../classes/View.NodeMap.html">View.NodeMap</a></li> |
|
713 |
|
714 <li><a href="../classes/VMLCircle.html">VMLCircle</a></li> |
|
715 |
|
716 <li><a href="../classes/VMLDrawing.html">VMLDrawing</a></li> |
|
717 |
|
718 <li><a href="../classes/VMLEllipse.html">VMLEllipse</a></li> |
|
719 |
|
720 <li><a href="../classes/VMLGraphic.html">VMLGraphic</a></li> |
|
721 |
|
722 <li><a href="../classes/VMLPath.html">VMLPath</a></li> |
|
723 |
|
724 <li><a href="../classes/VMLPieSlice.html">VMLPieSlice</a></li> |
|
725 |
|
726 <li><a href="../classes/VMLRect.html">VMLRect</a></li> |
|
727 |
|
728 <li><a href="../classes/VMLShape.html">VMLShape</a></li> |
|
729 |
|
730 <li><a href="../classes/Widget.html">Widget</a></li> |
|
731 |
|
732 <li><a href="../classes/WidgetAutohide.html">WidgetAutohide</a></li> |
|
733 |
|
734 <li><a href="../classes/WidgetButtons.html">WidgetButtons</a></li> |
|
735 |
|
736 <li><a href="../classes/WidgetChild.html">WidgetChild</a></li> |
|
737 |
|
738 <li><a href="../classes/WidgetModality.html">WidgetModality</a></li> |
|
739 |
|
740 <li><a href="../classes/WidgetParent.html">WidgetParent</a></li> |
|
741 |
|
742 <li><a href="../classes/WidgetPosition.html">WidgetPosition</a></li> |
|
743 |
|
744 <li><a href="../classes/WidgetPositionAlign.html">WidgetPositionAlign</a></li> |
|
745 |
|
746 <li><a href="../classes/WidgetPositionConstrain.html">WidgetPositionConstrain</a></li> |
|
747 |
|
748 <li><a href="../classes/WidgetStack.html">WidgetStack</a></li> |
|
749 |
|
750 <li><a href="../classes/WidgetStdMod.html">WidgetStdMod</a></li> |
|
751 |
|
752 <li><a href="../classes/XML.html">XML</a></li> |
|
753 |
|
754 <li><a href="../classes/YQL.html">YQL</a></li> |
|
755 |
|
756 <li><a href="../classes/YQLRequest.html">YQLRequest</a></li> |
|
757 |
|
758 <li><a href="../classes/YUI.html">YUI</a></li> |
|
759 |
|
760 <li><a href="../classes/YUI~substitute.html">YUI~substitute</a></li> |
|
761 |
|
762 </ul> |
|
763 |
|
764 <ul id="api-modules" class="apis modules"> |
|
765 |
|
766 <li><a href="../modules/align-plugin.html">align-plugin</a></li> |
|
767 |
|
768 <li><a href="../modules/anim.html">anim</a></li> |
|
769 |
|
770 <li><a href="../modules/anim-base.html">anim-base</a></li> |
|
771 |
|
772 <li><a href="../modules/anim-color.html">anim-color</a></li> |
|
773 |
|
774 <li><a href="../modules/anim-curve.html">anim-curve</a></li> |
|
775 |
|
776 <li><a href="../modules/anim-easing.html">anim-easing</a></li> |
|
777 |
|
778 <li><a href="../modules/anim-node-plugin.html">anim-node-plugin</a></li> |
|
779 |
|
780 <li><a href="../modules/anim-scroll.html">anim-scroll</a></li> |
|
781 |
|
782 <li><a href="../modules/anim-shape.html">anim-shape</a></li> |
|
783 |
|
784 <li><a href="../modules/anim-shape-transform.html">anim-shape-transform</a></li> |
|
785 |
|
786 <li><a href="../modules/anim-xy.html">anim-xy</a></li> |
|
787 |
|
788 <li><a href="../modules/app.html">app</a></li> |
|
789 |
|
790 <li><a href="../modules/app-base.html">app-base</a></li> |
|
791 |
|
792 <li><a href="../modules/app-content.html">app-content</a></li> |
|
793 |
|
794 <li><a href="../modules/app-transitions.html">app-transitions</a></li> |
|
795 |
|
796 <li><a href="../modules/app-transitions-native.html">app-transitions-native</a></li> |
|
797 |
|
798 <li><a href="../modules/array-extras.html">array-extras</a></li> |
|
799 |
|
800 <li><a href="../modules/array-invoke.html">array-invoke</a></li> |
|
801 |
|
802 <li><a href="../modules/arraylist.html">arraylist</a></li> |
|
803 |
|
804 <li><a href="../modules/arraylist-add.html">arraylist-add</a></li> |
|
805 |
|
806 <li><a href="../modules/arraylist-filter.html">arraylist-filter</a></li> |
|
807 |
|
808 <li><a href="../modules/arraysort.html">arraysort</a></li> |
|
809 |
|
810 <li><a href="../modules/async-queue.html">async-queue</a></li> |
|
811 |
|
812 <li><a href="../modules/attribute.html">attribute</a></li> |
|
813 |
|
814 <li><a href="../modules/attribute-base.html">attribute-base</a></li> |
|
815 |
|
816 <li><a href="../modules/attribute-complex.html">attribute-complex</a></li> |
|
817 |
|
818 <li><a href="../modules/attribute-core.html">attribute-core</a></li> |
|
819 |
|
820 <li><a href="../modules/attribute-extras.html">attribute-extras</a></li> |
|
821 |
|
822 <li><a href="../modules/attribute-observable.html">attribute-observable</a></li> |
|
823 |
|
824 <li><a href="../modules/autocomplete.html">autocomplete</a></li> |
|
825 |
|
826 <li><a href="../modules/autocomplete-base.html">autocomplete-base</a></li> |
|
827 |
|
828 <li><a href="../modules/autocomplete-filters.html">autocomplete-filters</a></li> |
|
829 |
|
830 <li><a href="../modules/autocomplete-filters-accentfold.html">autocomplete-filters-accentfold</a></li> |
|
831 |
|
832 <li><a href="../modules/autocomplete-highlighters.html">autocomplete-highlighters</a></li> |
|
833 |
|
834 <li><a href="../modules/autocomplete-highlighters-accentfold.html">autocomplete-highlighters-accentfold</a></li> |
|
835 |
|
836 <li><a href="../modules/autocomplete-list.html">autocomplete-list</a></li> |
|
837 |
|
838 <li><a href="../modules/autocomplete-list-keys.html">autocomplete-list-keys</a></li> |
|
839 |
|
840 <li><a href="../modules/autocomplete-plugin.html">autocomplete-plugin</a></li> |
|
841 |
|
842 <li><a href="../modules/autocomplete-sources.html">autocomplete-sources</a></li> |
|
843 |
|
844 <li><a href="../modules/axis.html">axis</a></li> |
|
845 |
|
846 <li><a href="../modules/axis-base.html">axis-base</a></li> |
|
847 |
|
848 <li><a href="../modules/axis-category.html">axis-category</a></li> |
|
849 |
|
850 <li><a href="../modules/axis-category-base.html">axis-category-base</a></li> |
|
851 |
|
852 <li><a href="../modules/axis-numeric.html">axis-numeric</a></li> |
|
853 |
|
854 <li><a href="../modules/axis-numeric-base.html">axis-numeric-base</a></li> |
|
855 |
|
856 <li><a href="../modules/axis-stacked.html">axis-stacked</a></li> |
|
857 |
|
858 <li><a href="../modules/axis-stacked-base.html">axis-stacked-base</a></li> |
|
859 |
|
860 <li><a href="../modules/axis-time.html">axis-time</a></li> |
|
861 |
|
862 <li><a href="../modules/axis-time-base.html">axis-time-base</a></li> |
|
863 |
|
864 <li><a href="../modules/base.html">base</a></li> |
|
865 |
|
866 <li><a href="../modules/base-base.html">base-base</a></li> |
|
867 |
|
868 <li><a href="../modules/base-build.html">base-build</a></li> |
|
869 |
|
870 <li><a href="../modules/base-core.html">base-core</a></li> |
|
871 |
|
872 <li><a href="../modules/base-observable.html">base-observable</a></li> |
|
873 |
|
874 <li><a href="../modules/base-pluginhost.html">base-pluginhost</a></li> |
|
875 |
|
876 <li><a href="../modules/button.html">button</a></li> |
|
877 |
|
878 <li><a href="../modules/button-core.html">button-core</a></li> |
|
879 |
|
880 <li><a href="../modules/button-group.html">button-group</a></li> |
|
881 |
|
882 <li><a href="../modules/button-plugin.html">button-plugin</a></li> |
|
883 |
|
884 <li><a href="../modules/cache.html">cache</a></li> |
|
885 |
|
886 <li><a href="../modules/cache-base.html">cache-base</a></li> |
|
887 |
|
888 <li><a href="../modules/cache-offline.html">cache-offline</a></li> |
|
889 |
|
890 <li><a href="../modules/cache-plugin.html">cache-plugin</a></li> |
|
891 |
|
892 <li><a href="../modules/calendar.html">calendar</a></li> |
|
893 |
|
894 <li><a href="../modules/calendar-base.html">calendar-base</a></li> |
|
895 |
|
896 <li><a href="../modules/calendarnavigator.html">calendarnavigator</a></li> |
|
897 |
|
898 <li><a href="../modules/charts.html">charts</a></li> |
|
899 |
|
900 <li><a href="../modules/charts-base.html">charts-base</a></li> |
|
901 |
|
902 <li><a href="../modules/charts-legend.html">charts-legend</a></li> |
|
903 |
|
904 <li><a href="../modules/classnamemanager.html">classnamemanager</a></li> |
|
905 |
|
906 <li><a href="../modules/clickable-rail.html">clickable-rail</a></li> |
|
907 |
|
908 <li><a href="../modules/collection.html">collection</a></li> |
|
909 |
|
910 <li><a href="../modules/color.html">color</a></li> |
|
911 |
|
912 <li><a href="../modules/color-base.html">color-base</a></li> |
|
913 |
|
914 <li><a href="../modules/color-harmony.html">color-harmony</a></li> |
|
915 |
|
916 <li><a href="../modules/color-hsl.html">color-hsl</a></li> |
|
917 |
|
918 <li><a href="../modules/color-hsv.html">color-hsv</a></li> |
|
919 |
|
920 <li><a href="../modules/console.html">console</a></li> |
|
921 |
|
922 <li><a href="../modules/console-filters.html">console-filters</a></li> |
|
923 |
|
924 <li><a href="../modules/cookie.html">cookie</a></li> |
|
925 |
|
926 <li><a href="../modules/createlink-base.html">createlink-base</a></li> |
|
927 |
|
928 <li><a href="../modules/dataschema.html">dataschema</a></li> |
|
929 |
|
930 <li><a href="../modules/dataschema-array.html">dataschema-array</a></li> |
|
931 |
|
932 <li><a href="../modules/dataschema-base.html">dataschema-base</a></li> |
|
933 |
|
934 <li><a href="../modules/dataschema-json.html">dataschema-json</a></li> |
|
935 |
|
936 <li><a href="../modules/dataschema-text.html">dataschema-text</a></li> |
|
937 |
|
938 <li><a href="../modules/dataschema-xml.html">dataschema-xml</a></li> |
|
939 |
|
940 <li><a href="../modules/datasource.html">datasource</a></li> |
|
941 |
|
942 <li><a href="../modules/datasource-arrayschema.html">datasource-arrayschema</a></li> |
|
943 |
|
944 <li><a href="../modules/datasource-cache.html">datasource-cache</a></li> |
|
945 |
|
946 <li><a href="../modules/datasource-function.html">datasource-function</a></li> |
|
947 |
|
948 <li><a href="../modules/datasource-get.html">datasource-get</a></li> |
|
949 |
|
950 <li><a href="../modules/datasource-io.html">datasource-io</a></li> |
|
951 |
|
952 <li><a href="../modules/datasource-jsonschema.html">datasource-jsonschema</a></li> |
|
953 |
|
954 <li><a href="../modules/datasource-local.html">datasource-local</a></li> |
|
955 |
|
956 <li><a href="../modules/datasource-polling.html">datasource-polling</a></li> |
|
957 |
|
958 <li><a href="../modules/datasource-textschema.html">datasource-textschema</a></li> |
|
959 |
|
960 <li><a href="../modules/datasource-xmlschema.html">datasource-xmlschema</a></li> |
|
961 |
|
962 <li><a href="../modules/datatable.html">datatable</a></li> |
|
963 |
|
964 <li><a href="../modules/datatable-base.html">datatable-base</a></li> |
|
965 |
|
966 <li><a href="../modules/datatable-body.html">datatable-body</a></li> |
|
967 |
|
968 <li><a href="../modules/datatable-column-widths.html">datatable-column-widths</a></li> |
|
969 |
|
970 <li><a href="../modules/datatable-core.html">datatable-core</a></li> |
|
971 |
|
972 <li><a href="../modules/datatable-datasource.html">datatable-datasource</a></li> |
|
973 |
|
974 <li><a href="../modules/datatable-formatters.html">datatable-formatters</a></li> |
|
975 |
|
976 <li><a href="../modules/datatable-head.html">datatable-head</a></li> |
|
977 |
|
978 <li><a href="../modules/datatable-message.html">datatable-message</a></li> |
|
979 |
|
980 <li><a href="../modules/datatable-mutable.html">datatable-mutable</a></li> |
|
981 |
|
982 <li><a href="../modules/datatable-scroll.html">datatable-scroll</a></li> |
|
983 |
|
984 <li><a href="../modules/datatable-sort.html">datatable-sort</a></li> |
|
985 |
|
986 <li><a href="../modules/datatable-table.html">datatable-table</a></li> |
|
987 |
|
988 <li><a href="../modules/datatype.html">datatype</a></li> |
|
989 |
|
990 <li><a href="../modules/datatype-date.html">datatype-date</a></li> |
|
991 |
|
992 <li><a href="../modules/datatype-date-format.html">datatype-date-format</a></li> |
|
993 |
|
994 <li><a href="../modules/datatype-date-math.html">datatype-date-math</a></li> |
|
995 |
|
996 <li><a href="../modules/datatype-date-parse.html">datatype-date-parse</a></li> |
|
997 |
|
998 <li><a href="../modules/datatype-number.html">datatype-number</a></li> |
|
999 |
|
1000 <li><a href="../modules/datatype-number-format.html">datatype-number-format</a></li> |
|
1001 |
|
1002 <li><a href="../modules/datatype-number-parse.html">datatype-number-parse</a></li> |
|
1003 |
|
1004 <li><a href="../modules/datatype-xml.html">datatype-xml</a></li> |
|
1005 |
|
1006 <li><a href="../modules/datatype-xml-format.html">datatype-xml-format</a></li> |
|
1007 |
|
1008 <li><a href="../modules/datatype-xml-parse.html">datatype-xml-parse</a></li> |
|
1009 |
|
1010 <li><a href="../modules/dd.html">dd</a></li> |
|
1011 |
|
1012 <li><a href="../modules/dd-constrain.html">dd-constrain</a></li> |
|
1013 |
|
1014 <li><a href="../modules/dd-ddm.html">dd-ddm</a></li> |
|
1015 |
|
1016 <li><a href="../modules/dd-ddm-base.html">dd-ddm-base</a></li> |
|
1017 |
|
1018 <li><a href="../modules/dd-ddm-drop.html">dd-ddm-drop</a></li> |
|
1019 |
|
1020 <li><a href="../modules/dd-delegate.html">dd-delegate</a></li> |
|
1021 |
|
1022 <li><a href="../modules/dd-drag.html">dd-drag</a></li> |
|
1023 |
|
1024 <li><a href="../modules/dd-drop.html">dd-drop</a></li> |
|
1025 |
|
1026 <li><a href="../modules/dd-drop-plugin.html">dd-drop-plugin</a></li> |
|
1027 |
|
1028 <li><a href="../modules/dd-gestures.html">dd-gestures</a></li> |
|
1029 |
|
1030 <li><a href="../modules/dd-plugin.html">dd-plugin</a></li> |
|
1031 |
|
1032 <li><a href="../modules/dd-proxy.html">dd-proxy</a></li> |
|
1033 |
|
1034 <li><a href="../modules/dd-scroll.html">dd-scroll</a></li> |
|
1035 |
|
1036 <li><a href="../modules/dial.html">dial</a></li> |
|
1037 |
|
1038 <li><a href="../modules/dom.html">dom</a></li> |
|
1039 |
|
1040 <li><a href="../modules/dom-base.html">dom-base</a></li> |
|
1041 |
|
1042 <li><a href="../modules/dom-screen.html">dom-screen</a></li> |
|
1043 |
|
1044 <li><a href="../modules/dom-style.html">dom-style</a></li> |
|
1045 |
|
1046 <li><a href="../modules/dump.html">dump</a></li> |
|
1047 |
|
1048 <li><a href="../modules/editor.html">editor</a></li> |
|
1049 |
|
1050 <li><a href="../modules/editor-base.html">editor-base</a></li> |
|
1051 |
|
1052 <li><a href="../modules/editor-bidi.html">editor-bidi</a></li> |
|
1053 |
|
1054 <li><a href="../modules/editor-br.html">editor-br</a></li> |
|
1055 |
|
1056 <li><a href="../modules/editor-lists.html">editor-lists</a></li> |
|
1057 |
|
1058 <li><a href="../modules/editor-para.html">editor-para</a></li> |
|
1059 |
|
1060 <li><a href="../modules/editor-para-base.html">editor-para-base</a></li> |
|
1061 |
|
1062 <li><a href="../modules/editor-para-ie.html">editor-para-ie</a></li> |
|
1063 |
|
1064 <li><a href="../modules/editor-tab.html">editor-tab</a></li> |
|
1065 |
|
1066 <li><a href="../modules/escape.html">escape</a></li> |
|
1067 |
|
1068 <li><a href="../modules/event.html">event</a></li> |
|
1069 |
|
1070 <li><a href="../modules/event-base.html">event-base</a></li> |
|
1071 |
|
1072 <li><a href="../modules/event-contextmenu.html">event-contextmenu</a></li> |
|
1073 |
|
1074 <li><a href="../modules/event-custom.html">event-custom</a></li> |
|
1075 |
|
1076 <li><a href="../modules/event-custom-base.html">event-custom-base</a></li> |
|
1077 |
|
1078 <li><a href="../modules/event-custom-complex.html">event-custom-complex</a></li> |
|
1079 |
|
1080 <li><a href="../modules/event-delegate.html">event-delegate</a></li> |
|
1081 |
|
1082 <li><a href="../modules/event-flick.html">event-flick</a></li> |
|
1083 |
|
1084 <li><a href="../modules/event-focus.html">event-focus</a></li> |
|
1085 |
|
1086 <li><a href="../modules/event-gestures.html">event-gestures</a></li> |
|
1087 |
|
1088 <li><a href="../modules/event-hover.html">event-hover</a></li> |
|
1089 |
|
1090 <li><a href="../modules/event-key.html">event-key</a></li> |
|
1091 |
|
1092 <li><a href="../modules/event-mouseenter.html">event-mouseenter</a></li> |
|
1093 |
|
1094 <li><a href="../modules/event-mousewheel.html">event-mousewheel</a></li> |
|
1095 |
|
1096 <li><a href="../modules/event-move.html">event-move</a></li> |
|
1097 |
|
1098 <li><a href="../modules/event-outside.html">event-outside</a></li> |
|
1099 |
|
1100 <li><a href="../modules/event-resize.html">event-resize</a></li> |
|
1101 |
|
1102 <li><a href="../modules/event-simulate.html">event-simulate</a></li> |
|
1103 |
|
1104 <li><a href="../modules/event-synthetic.html">event-synthetic</a></li> |
|
1105 |
|
1106 <li><a href="../modules/event-tap.html">event-tap</a></li> |
|
1107 |
|
1108 <li><a href="../modules/event-touch.html">event-touch</a></li> |
|
1109 |
|
1110 <li><a href="../modules/event-valuechange.html">event-valuechange</a></li> |
|
1111 |
|
1112 <li><a href="../modules/exec-command.html">exec-command</a></li> |
|
1113 |
|
1114 <li><a href="../modules/features.html">features</a></li> |
|
1115 |
|
1116 <li><a href="../modules/file.html">file</a></li> |
|
1117 |
|
1118 <li><a href="../modules/file-flash.html">file-flash</a></li> |
|
1119 |
|
1120 <li><a href="../modules/file-html5.html">file-html5</a></li> |
|
1121 |
|
1122 <li><a href="../modules/frame.html">frame</a></li> |
|
1123 |
|
1124 <li><a href="../modules/gesture-simulate.html">gesture-simulate</a></li> |
|
1125 |
|
1126 <li><a href="../modules/get.html">get</a></li> |
|
1127 |
|
1128 <li><a href="../modules/get-nodejs.html">get-nodejs</a></li> |
|
1129 |
|
1130 <li><a href="../modules/graphics.html">graphics</a></li> |
|
1131 |
|
1132 <li><a href="../modules/graphics-group.html">graphics-group</a></li> |
|
1133 |
|
1134 <li><a href="../modules/handlebars.html">handlebars</a></li> |
|
1135 |
|
1136 <li><a href="../modules/handlebars-base.html">handlebars-base</a></li> |
|
1137 |
|
1138 <li><a href="../modules/handlebars-compiler.html">handlebars-compiler</a></li> |
|
1139 |
|
1140 <li><a href="../modules/highlight.html">highlight</a></li> |
|
1141 |
|
1142 <li><a href="../modules/highlight-accentfold.html">highlight-accentfold</a></li> |
|
1143 |
|
1144 <li><a href="../modules/highlight-base.html">highlight-base</a></li> |
|
1145 |
|
1146 <li><a href="../modules/history.html">history</a></li> |
|
1147 |
|
1148 <li><a href="../modules/history-base.html">history-base</a></li> |
|
1149 |
|
1150 <li><a href="../modules/history-hash.html">history-hash</a></li> |
|
1151 |
|
1152 <li><a href="../modules/history-hash-ie.html">history-hash-ie</a></li> |
|
1153 |
|
1154 <li><a href="../modules/history-html5.html">history-html5</a></li> |
|
1155 |
|
1156 <li><a href="../modules/imageloader.html">imageloader</a></li> |
|
1157 |
|
1158 <li><a href="../modules/intl.html">intl</a></li> |
|
1159 |
|
1160 <li><a href="../modules/io.html">io</a></li> |
|
1161 |
|
1162 <li><a href="../modules/io-base.html">io-base</a></li> |
|
1163 |
|
1164 <li><a href="../modules/io-form.html">io-form</a></li> |
|
1165 |
|
1166 <li><a href="../modules/io-nodejs.html">io-nodejs</a></li> |
|
1167 |
|
1168 <li><a href="../modules/io-queue.html">io-queue</a></li> |
|
1169 |
|
1170 <li><a href="../modules/io-upload-iframe.html">io-upload-iframe</a></li> |
|
1171 |
|
1172 <li><a href="../modules/io-xdr.html">io-xdr</a></li> |
|
1173 |
|
1174 <li><a href="../modules/json.html">json</a></li> |
|
1175 |
|
1176 <li><a href="../modules/json-parse.html">json-parse</a></li> |
|
1177 |
|
1178 <li><a href="../modules/json-stringify.html">json-stringify</a></li> |
|
1179 |
|
1180 <li><a href="../modules/jsonp.html">jsonp</a></li> |
|
1181 |
|
1182 <li><a href="../modules/jsonp-url.html">jsonp-url</a></li> |
|
1183 |
|
1184 <li><a href="../modules/lazy-model-list.html">lazy-model-list</a></li> |
|
1185 |
|
1186 <li><a href="../modules/loader.html">loader</a></li> |
|
1187 |
|
1188 <li><a href="../modules/loader-base.html">loader-base</a></li> |
|
1189 |
|
1190 <li><a href="../modules/loader-yui3.html">loader-yui3</a></li> |
|
1191 |
|
1192 <li><a href="../modules/matrix.html">matrix</a></li> |
|
1193 |
|
1194 <li><a href="../modules/model.html">model</a></li> |
|
1195 |
|
1196 <li><a href="../modules/model-list.html">model-list</a></li> |
|
1197 |
|
1198 <li><a href="../modules/model-sync-rest.html">model-sync-rest</a></li> |
|
1199 |
|
1200 <li><a href="../modules/node.html">node</a></li> |
|
1201 |
|
1202 <li><a href="../modules/node-base.html">node-base</a></li> |
|
1203 |
|
1204 <li><a href="../modules/node-core.html">node-core</a></li> |
|
1205 |
|
1206 <li><a href="../modules/node-data.html">node-data</a></li> |
|
1207 |
|
1208 <li><a href="../modules/node-event-delegate.html">node-event-delegate</a></li> |
|
1209 |
|
1210 <li><a href="../modules/node-event-html5.html">node-event-html5</a></li> |
|
1211 |
|
1212 <li><a href="../modules/node-event-simulate.html">node-event-simulate</a></li> |
|
1213 |
|
1214 <li><a href="../modules/node-flick.html">node-flick</a></li> |
|
1215 |
|
1216 <li><a href="../modules/node-focusmanager.html">node-focusmanager</a></li> |
|
1217 |
|
1218 <li><a href="../modules/node-load.html">node-load</a></li> |
|
1219 |
|
1220 <li><a href="../modules/node-menunav.html">node-menunav</a></li> |
|
1221 |
|
1222 <li><a href="../modules/node-pluginhost.html">node-pluginhost</a></li> |
|
1223 |
|
1224 <li><a href="../modules/node-screen.html">node-screen</a></li> |
|
1225 |
|
1226 <li><a href="../modules/node-scroll-info.html">node-scroll-info</a></li> |
|
1227 |
|
1228 <li><a href="../modules/node-style.html">node-style</a></li> |
|
1229 |
|
1230 <li><a href="../modules/oop.html">oop</a></li> |
|
1231 |
|
1232 <li><a href="../modules/overlay.html">overlay</a></li> |
|
1233 |
|
1234 <li><a href="../modules/panel.html">panel</a></li> |
|
1235 |
|
1236 <li><a href="../modules/parallel.html">parallel</a></li> |
|
1237 |
|
1238 <li><a href="../modules/pjax.html">pjax</a></li> |
|
1239 |
|
1240 <li><a href="../modules/pjax-base.html">pjax-base</a></li> |
|
1241 |
|
1242 <li><a href="../modules/pjax-content.html">pjax-content</a></li> |
|
1243 |
|
1244 <li><a href="../modules/pjax-plugin.html">pjax-plugin</a></li> |
|
1245 |
|
1246 <li><a href="../modules/plugin.html">plugin</a></li> |
|
1247 |
|
1248 <li><a href="../modules/pluginhost.html">pluginhost</a></li> |
|
1249 |
|
1250 <li><a href="../modules/pluginhost-base.html">pluginhost-base</a></li> |
|
1251 |
|
1252 <li><a href="../modules/pluginhost-config.html">pluginhost-config</a></li> |
|
1253 |
|
1254 <li><a href="../modules/promise.html">promise</a></li> |
|
1255 |
|
1256 <li><a href="../modules/querystring.html">querystring</a></li> |
|
1257 |
|
1258 <li><a href="../modules/querystring-parse.html">querystring-parse</a></li> |
|
1259 |
|
1260 <li><a href="../modules/querystring-parse-simple.html">querystring-parse-simple</a></li> |
|
1261 |
|
1262 <li><a href="../modules/querystring-stringify.html">querystring-stringify</a></li> |
|
1263 |
|
1264 <li><a href="../modules/querystring-stringify-simple.html">querystring-stringify-simple</a></li> |
|
1265 |
|
1266 <li><a href="../modules/queue-promote.html">queue-promote</a></li> |
|
1267 |
|
1268 <li><a href="../modules/range-slider.html">range-slider</a></li> |
|
1269 |
|
1270 <li><a href="../modules/recordset.html">recordset</a></li> |
|
1271 |
|
1272 <li><a href="../modules/recordset-base.html">recordset-base</a></li> |
|
1273 |
|
1274 <li><a href="../modules/recordset-filter.html">recordset-filter</a></li> |
|
1275 |
|
1276 <li><a href="../modules/recordset-indexer.html">recordset-indexer</a></li> |
|
1277 |
|
1278 <li><a href="../modules/recordset-sort.html">recordset-sort</a></li> |
|
1279 |
|
1280 <li><a href="../modules/resize.html">resize</a></li> |
|
1281 |
|
1282 <li><a href="../modules/resize-contrain.html">resize-contrain</a></li> |
|
1283 |
|
1284 <li><a href="../modules/resize-plugin.html">resize-plugin</a></li> |
|
1285 |
|
1286 <li><a href="../modules/resize-proxy.html">resize-proxy</a></li> |
|
1287 |
|
1288 <li><a href="../modules/rollup.html">rollup</a></li> |
|
1289 |
|
1290 <li><a href="../modules/router.html">router</a></li> |
|
1291 |
|
1292 <li><a href="../modules/scrollview.html">scrollview</a></li> |
|
1293 |
|
1294 <li><a href="../modules/scrollview-base.html">scrollview-base</a></li> |
|
1295 |
|
1296 <li><a href="../modules/scrollview-base-ie.html">scrollview-base-ie</a></li> |
|
1297 |
|
1298 <li><a href="../modules/scrollview-list.html">scrollview-list</a></li> |
|
1299 |
|
1300 <li><a href="../modules/scrollview-paginator.html">scrollview-paginator</a></li> |
|
1301 |
|
1302 <li><a href="../modules/scrollview-scrollbars.html">scrollview-scrollbars</a></li> |
|
1303 |
|
1304 <li><a href="../modules/selection.html">selection</a></li> |
|
1305 |
|
1306 <li><a href="../modules/selector-css2.html">selector-css2</a></li> |
|
1307 |
|
1308 <li><a href="../modules/selector-css3.html">selector-css3</a></li> |
|
1309 |
|
1310 <li><a href="../modules/selector-native.html">selector-native</a></li> |
|
1311 |
|
1312 <li><a href="../modules/series-area.html">series-area</a></li> |
|
1313 |
|
1314 <li><a href="../modules/series-area-stacked.html">series-area-stacked</a></li> |
|
1315 |
|
1316 <li><a href="../modules/series-areaspline.html">series-areaspline</a></li> |
|
1317 |
|
1318 <li><a href="../modules/series-areaspline-stacked.html">series-areaspline-stacked</a></li> |
|
1319 |
|
1320 <li><a href="../modules/series-bar.html">series-bar</a></li> |
|
1321 |
|
1322 <li><a href="../modules/series-bar-stacked.html">series-bar-stacked</a></li> |
|
1323 |
|
1324 <li><a href="../modules/series-base.html">series-base</a></li> |
|
1325 |
|
1326 <li><a href="../modules/series-candlestick.html">series-candlestick</a></li> |
|
1327 |
|
1328 <li><a href="../modules/series-cartesian.html">series-cartesian</a></li> |
|
1329 |
|
1330 <li><a href="../modules/series-column.html">series-column</a></li> |
|
1331 |
|
1332 <li><a href="../modules/series-column-stacked.html">series-column-stacked</a></li> |
|
1333 |
|
1334 <li><a href="../modules/series-combo.html">series-combo</a></li> |
|
1335 |
|
1336 <li><a href="../modules/series-combo-stacked.html">series-combo-stacked</a></li> |
|
1337 |
|
1338 <li><a href="../modules/series-combospline.html">series-combospline</a></li> |
|
1339 |
|
1340 <li><a href="../modules/series-combospline-stacked.html">series-combospline-stacked</a></li> |
|
1341 |
|
1342 <li><a href="../modules/series-curve-util.html">series-curve-util</a></li> |
|
1343 |
|
1344 <li><a href="../modules/series-fill-util.html">series-fill-util</a></li> |
|
1345 |
|
1346 <li><a href="../modules/series-histogram.html">series-histogram</a></li> |
|
1347 |
|
1348 <li><a href="../modules/series-line.html">series-line</a></li> |
|
1349 |
|
1350 <li><a href="../modules/series-line-stacked.html">series-line-stacked</a></li> |
|
1351 |
|
1352 <li><a href="../modules/series-line-util.html">series-line-util</a></li> |
|
1353 |
|
1354 <li><a href="../modules/series-marker.html">series-marker</a></li> |
|
1355 |
|
1356 <li><a href="../modules/series-marker-stacked.html">series-marker-stacked</a></li> |
|
1357 |
|
1358 <li><a href="../modules/series-ohlc.html">series-ohlc</a></li> |
|
1359 |
|
1360 <li><a href="../modules/series-pie.html">series-pie</a></li> |
|
1361 |
|
1362 <li><a href="../modules/series-plot-util.html">series-plot-util</a></li> |
|
1363 |
|
1364 <li><a href="../modules/series-range.html">series-range</a></li> |
|
1365 |
|
1366 <li><a href="../modules/series-spline.html">series-spline</a></li> |
|
1367 |
|
1368 <li><a href="../modules/series-spline-stacked.html">series-spline-stacked</a></li> |
|
1369 |
|
1370 <li><a href="../modules/series-stacked.html">series-stacked</a></li> |
|
1371 |
|
1372 <li><a href="../modules/shim-plugin.html">shim-plugin</a></li> |
|
1373 |
|
1374 <li><a href="../modules/slider.html">slider</a></li> |
|
1375 |
|
1376 <li><a href="../modules/slider-base.html">slider-base</a></li> |
|
1377 |
|
1378 <li><a href="../modules/slider-value-range.html">slider-value-range</a></li> |
|
1379 |
|
1380 <li><a href="../modules/sortable.html">sortable</a></li> |
|
1381 |
|
1382 <li><a href="../modules/sortable-scroll.html">sortable-scroll</a></li> |
|
1383 |
|
1384 <li><a href="../modules/stylesheet.html">stylesheet</a></li> |
|
1385 |
|
1386 <li><a href="../modules/substitute.html">substitute</a></li> |
|
1387 |
|
1388 <li><a href="../modules/swf.html">swf</a></li> |
|
1389 |
|
1390 <li><a href="../modules/swfdetect.html">swfdetect</a></li> |
|
1391 |
|
1392 <li><a href="../modules/tabview.html">tabview</a></li> |
|
1393 |
|
1394 <li><a href="../modules/template.html">template</a></li> |
|
1395 |
|
1396 <li><a href="../modules/template-base.html">template-base</a></li> |
|
1397 |
|
1398 <li><a href="../modules/template-micro.html">template-micro</a></li> |
|
1399 |
|
1400 <li><a href="../modules/test.html">test</a></li> |
|
1401 |
|
1402 <li><a href="../modules/test-console.html">test-console</a></li> |
|
1403 |
|
1404 <li><a href="../modules/text.html">text</a></li> |
|
1405 |
|
1406 <li><a href="../modules/text-accentfold.html">text-accentfold</a></li> |
|
1407 |
|
1408 <li><a href="../modules/text-wordbreak.html">text-wordbreak</a></li> |
|
1409 |
|
1410 <li><a href="../modules/timers.html">timers</a></li> |
|
1411 |
|
1412 <li><a href="../modules/transition.html">transition</a></li> |
|
1413 |
|
1414 <li><a href="../modules/transition-timer.html">transition-timer</a></li> |
|
1415 |
|
1416 <li><a href="../modules/tree.html">tree</a></li> |
|
1417 |
|
1418 <li><a href="../modules/tree-labelable.html">tree-labelable</a></li> |
|
1419 |
|
1420 <li><a href="../modules/tree-lazy.html">tree-lazy</a></li> |
|
1421 |
|
1422 <li><a href="../modules/tree-node.html">tree-node</a></li> |
|
1423 |
|
1424 <li><a href="../modules/tree-openable.html">tree-openable</a></li> |
|
1425 |
|
1426 <li><a href="../modules/tree-selectable.html">tree-selectable</a></li> |
|
1427 |
|
1428 <li><a href="../modules/tree-sortable.html">tree-sortable</a></li> |
|
1429 |
|
1430 <li><a href="../modules/uploader.html">uploader</a></li> |
|
1431 |
|
1432 <li><a href="../modules/uploader-flash.html">uploader-flash</a></li> |
|
1433 |
|
1434 <li><a href="../modules/uploader-html5.html">uploader-html5</a></li> |
|
1435 |
|
1436 <li><a href="../modules/uploader-queue.html">uploader-queue</a></li> |
|
1437 |
|
1438 <li><a href="../modules/view.html">view</a></li> |
|
1439 |
|
1440 <li><a href="../modules/view-node-map.html">view-node-map</a></li> |
|
1441 |
|
1442 <li><a href="../modules/widget.html">widget</a></li> |
|
1443 |
|
1444 <li><a href="../modules/widget-anim.html">widget-anim</a></li> |
|
1445 |
|
1446 <li><a href="../modules/widget-autohide.html">widget-autohide</a></li> |
|
1447 |
|
1448 <li><a href="../modules/widget-base.html">widget-base</a></li> |
|
1449 |
|
1450 <li><a href="../modules/widget-base-ie.html">widget-base-ie</a></li> |
|
1451 |
|
1452 <li><a href="../modules/widget-buttons.html">widget-buttons</a></li> |
|
1453 |
|
1454 <li><a href="../modules/widget-child.html">widget-child</a></li> |
|
1455 |
|
1456 <li><a href="../modules/widget-htmlparser.html">widget-htmlparser</a></li> |
|
1457 |
|
1458 <li><a href="../modules/widget-locale.html">widget-locale</a></li> |
|
1459 |
|
1460 <li><a href="../modules/widget-modality.html">widget-modality</a></li> |
|
1461 |
|
1462 <li><a href="../modules/widget-parent.html">widget-parent</a></li> |
|
1463 |
|
1464 <li><a href="../modules/widget-position.html">widget-position</a></li> |
|
1465 |
|
1466 <li><a href="../modules/widget-position-align.html">widget-position-align</a></li> |
|
1467 |
|
1468 <li><a href="../modules/widget-position-constrain.html">widget-position-constrain</a></li> |
|
1469 |
|
1470 <li><a href="../modules/widget-skin.html">widget-skin</a></li> |
|
1471 |
|
1472 <li><a href="../modules/widget-stack.html">widget-stack</a></li> |
|
1473 |
|
1474 <li><a href="../modules/widget-stdmod.html">widget-stdmod</a></li> |
|
1475 |
|
1476 <li><a href="../modules/widget-uievents.html">widget-uievents</a></li> |
|
1477 |
|
1478 <li><a href="../modules/yql.html">yql</a></li> |
|
1479 |
|
1480 <li><a href="../modules/yql-jsonp.html">yql-jsonp</a></li> |
|
1481 |
|
1482 <li><a href="../modules/yql-nodejs.html">yql-nodejs</a></li> |
|
1483 |
|
1484 <li><a href="../modules/yql-winjs.html">yql-winjs</a></li> |
|
1485 |
|
1486 <li><a href="../modules/yui.html">yui</a></li> |
|
1487 |
|
1488 <li><a href="../modules/yui-base.html">yui-base</a></li> |
|
1489 |
|
1490 <li><a href="../modules/yui-later.html">yui-later</a></li> |
|
1491 |
|
1492 <li><a href="../modules/yui-log.html">yui-log</a></li> |
|
1493 |
|
1494 <li><a href="../modules/yui-throttle.html">yui-throttle</a></li> |
|
1495 |
|
1496 </ul> |
|
1497 </div> |
|
1498 </div> |
|
1499 </div> |
|
1500 |
|
1501 </div> |
|
1502 </div> |
|
1503 <div class="yui3-u-3-4"> |
|
1504 <div id="api-options"> |
|
1505 Show: |
|
1506 <label for="api-show-inherited"> |
|
1507 <input type="checkbox" id="api-show-inherited" checked> |
|
1508 Inherited |
|
1509 </label> |
|
1510 |
|
1511 <label for="api-show-protected"> |
|
1512 <input type="checkbox" id="api-show-protected"> |
|
1513 Protected |
|
1514 </label> |
|
1515 |
|
1516 <label for="api-show-private"> |
|
1517 <input type="checkbox" id="api-show-private"> |
|
1518 Private |
|
1519 </label> |
|
1520 <label for="api-show-deprecated"> |
|
1521 <input type="checkbox" id="api-show-deprecated"> |
|
1522 Deprecated |
|
1523 </label> |
|
1524 |
|
1525 </div> |
|
1526 |
|
1527 |
|
1528 <div class="apidocs"> |
|
1529 <div id="docs-main"> |
|
1530 <div class="content"> |
|
1531 <h1>DataTable Class</h1> |
|
1532 <div class="box meta"> |
|
1533 |
|
1534 |
|
1535 |
|
1536 <div class="extends"> |
|
1537 Extends <a href="../classes/DataTable.Base.html" class="crosslink">DataTable.Base</a> |
|
1538 </div> |
|
1539 |
|
1540 |
|
1541 |
|
1542 <div class="foundat"> |
|
1543 Defined in: <a href="../files/datatable_js_base.js.html#l16"><code>datatable/js/base.js:16</code></a> |
|
1544 </div> |
|
1545 |
|
1546 |
|
1547 |
|
1548 |
|
1549 Module: <a href="../modules/datatable-base.html">datatable-base</a><br> |
|
1550 Parent Module: <a href="../modules/datatable.html">datatable</a> |
|
1551 |
|
1552 |
|
1553 |
|
1554 |
|
1555 <p>Available since 3.5.0</p> |
|
1556 |
|
1557 </div> |
|
1558 |
|
1559 |
|
1560 |
|
1561 <div class="box intro"> |
|
1562 <p>A Widget for displaying tabular data. Before feature modules are <code>use()</code>d, |
|
1563 this class is functionally equivalent to DataTable.Base. However, feature |
|
1564 modules can modify this class in non-destructive ways, expanding the API and |
|
1565 functionality.</p> |
|
1566 |
|
1567 <p>This is the primary DataTable class. Out of the box, it provides the ability |
|
1568 to dynamically generate an HTML table from a set of column configurations and |
|
1569 row data. But feature module inclusion can add table sorting, pagintaion, |
|
1570 highlighting, selection, and more.</p> |
|
1571 |
|
1572 <pre class="code prettyprint"><code> |
|
1573 // The functionality of this table would require additional modules be use()d, |
|
1574 // but the feature APIs are aggregated onto Y.DataTable. |
|
1575 // (Snippet is for illustration. Not all features are available today.) |
|
1576 var table = new Y.DataTable({ |
|
1577 columns: [ |
|
1578 { type: 'checkbox', defaultChecked: true }, |
|
1579 { key: 'firstName', sortable: true, resizable: true }, |
|
1580 { key: 'lastName', sortable: true }, |
|
1581 { key: 'role', formatter: toRoleName } |
|
1582 ], |
|
1583 data: { |
|
1584 source: 'http://myserver.com/service/json', |
|
1585 type: 'json', |
|
1586 schema: { |
|
1587 resultListLocator: 'results.users', |
|
1588 fields: [ |
|
1589 'username', |
|
1590 'firstName', |
|
1591 'lastName', |
|
1592 { key: 'role', type: 'number' } |
|
1593 ] |
|
1594 } |
|
1595 }, |
|
1596 recordType: UserModel, |
|
1597 pagedData: { |
|
1598 location: 'footer', |
|
1599 pageSizes: [20, 50, 'all'], |
|
1600 rowsPerPage: 20, |
|
1601 pageLinks: 5 |
|
1602 }, |
|
1603 editable: true |
|
1604 }); |
|
1605 </code></pre> |
|
1606 |
|
1607 <h3>Column Configuration</h3> |
|
1608 |
|
1609 <p>The column configurations are set in the form of an array of objects, where |
|
1610 each object corresponds to a column. For columns populated directly from the |
|
1611 row data, a 'key' property is required to bind the column to that property or |
|
1612 attribute in the row data.</p> |
|
1613 |
|
1614 <p>Not all columns need to relate to row data, nor do all properties or attributes |
|
1615 of the row data need to have a corresponding column. However, only those |
|
1616 columns included in the <code>columns</code> configuration attribute will be rendered.</p> |
|
1617 |
|
1618 <p>Other column configuration properties are supported by the configured |
|
1619 <code>view</code>, class as well as any features added by plugins or class extensions. |
|
1620 See the description of DataTable.TableView and its subviews |
|
1621 DataTable.HeaderView, DataTable.BodyView, and DataTable.FooterView (and other |
|
1622 DataTable feature classes) to see what column properties they support.</p> |
|
1623 |
|
1624 <p>Some examples of column configurations would be:</p> |
|
1625 |
|
1626 <pre class="code prettyprint"><code> |
|
1627 // Basic |
|
1628 var columns = [{ key: 'firstName' }, { key: 'lastName' }, { key: 'age' }]; |
|
1629 |
|
1630 // For columns without any additional configuration, strings can be used |
|
1631 var columns = ['firstName', 'lastName', 'age']; |
|
1632 |
|
1633 // Multi-row column headers (see DataTable.HeaderView for details) |
|
1634 var columns = [ |
|
1635 { |
|
1636 label: 'Name', |
|
1637 children: [ |
|
1638 { key: 'firstName' }, |
|
1639 { key: 'lastName' } |
|
1640 ] |
|
1641 }, |
|
1642 'age' // mixing and matching objects and strings is ok |
|
1643 ]; |
|
1644 |
|
1645 // Including columns that are not related 1:1 to row data fields/attributes |
|
1646 // (See DataTable.BodyView for details) |
|
1647 var columns = [ |
|
1648 { |
|
1649 label: 'Name', // Needed for the column header |
|
1650 formatter: function (o) { |
|
1651 // Fill the column cells with data from firstName and lastName |
|
1652 if (o.data.age > 55) { |
|
1653 o.className += ' senior'; |
|
1654 } |
|
1655 return o.data.lastName + ', ' + o.data.firstName; |
|
1656 } |
|
1657 }, |
|
1658 'age' |
|
1659 ]; |
|
1660 |
|
1661 // Columns that include feature configurations (for illustration; not all |
|
1662 // features are available today). |
|
1663 var columns = [ |
|
1664 { type: 'checkbox', defaultChecked: true }, |
|
1665 { key: 'firstName', sortable: true, resizable: true, min-width: '300px' }, |
|
1666 { key: 'lastName', sortable: true, resizable: true, min-width: '300px' }, |
|
1667 { key: 'age', emptyCellValue: '<em>unknown</em>' } |
|
1668 ]; |
|
1669 </code></pre> |
|
1670 |
|
1671 <h3>Row Data Configuration</h3> |
|
1672 |
|
1673 <p>The <code>data</code> configuration attribute is responsible for housing the data objects |
|
1674 that will be rendered as rows. You can provide this information in two ways by default:</p> |
|
1675 |
|
1676 <ol> |
|
1677 <li>An array of simple objects with key:value pairs</li> |
|
1678 <li>A ModelList of Base-based class instances (presumably Model subclass |
|
1679 instances)</li> |
|
1680 </ol> |
|
1681 |
|
1682 <p>If an array of objects is passed, it will be translated into a ModelList filled |
|
1683 with instances of the class provided to the <code>recordType</code> attribute. This |
|
1684 attribute can also create a custom Model subclass from an array of field names |
|
1685 or an object of attribute configurations. If no <code>recordType</code> is provided, one |
|
1686 will be created for you from available information (see <code>_initRecordType</code>). |
|
1687 Providing either your own ModelList instance for <code>data</code>, or at least Model |
|
1688 class for <code>recordType</code>, is the best way to control client-server |
|
1689 synchronization when modifying data on the client side.</p> |
|
1690 |
|
1691 <p>The ModelList instance that manages the table's data is available in the <code>data</code> |
|
1692 property on the DataTable instance.</p> |
|
1693 |
|
1694 <h3>Rendering</h3> |
|
1695 |
|
1696 <p>Table rendering is a collaborative process between the DataTable and its |
|
1697 configured <code>view</code>. The DataTable creates an instance of the configured <code>view</code> |
|
1698 (DataTable.TableView by default), and calls its <code>render()</code> method. |
|
1699 DataTable.TableView, for instance, then creates the <code><table></code> and <code><caption></code>, |
|
1700 then delegates the rendering of the specific sections of the table to subviews, |
|
1701 which can be configured as <code>headerView</code>, <code>bodyView</code>, and <code>footerView</code>. |
|
1702 DataTable.TableView defaults the <code>headerView</code> to DataTable.HeaderView and the |
|
1703 <code>bodyView</code> to DataTable.BodyView, but leaves the <code>footerView</code> unassigned. |
|
1704 Setting any subview to <code>null</code> will result in that table section not being |
|
1705 rendered.</p> |
|
1706 </div> |
|
1707 |
|
1708 |
|
1709 |
|
1710 <div id="classdocs" class="tabview"> |
|
1711 <ul class="api-class-tabs"> |
|
1712 <li class="api-class-tab index"><a href="#index">Index</a></li> |
|
1713 |
|
1714 |
|
1715 <li class="api-class-tab methods"><a href="#methods">Methods</a></li> |
|
1716 |
|
1717 |
|
1718 <li class="api-class-tab properties"><a href="#properties">Properties</a></li> |
|
1719 |
|
1720 |
|
1721 <li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li> |
|
1722 |
|
1723 |
|
1724 <li class="api-class-tab events"><a href="#events">Events</a></li> |
|
1725 |
|
1726 </ul> |
|
1727 |
|
1728 <div> |
|
1729 <div id="index" class="api-class-tabpanel index"> |
|
1730 <h2 class="off-left">Item Index</h2> |
|
1731 |
|
1732 |
|
1733 <div class="index-section methods"> |
|
1734 <h3>Methods</h3> |
|
1735 |
|
1736 <ul class="index-list methods extends"> |
|
1737 |
|
1738 <li class="index-item method protected inherited"> |
|
1739 <a href="#method_@renderUI">@renderUI</a> |
|
1740 |
|
1741 |
|
1742 |
|
1743 </li> |
|
1744 |
|
1745 <li class="index-item method private inherited"> |
|
1746 <a href="#method__addAttrs">_addAttrs</a> |
|
1747 |
|
1748 |
|
1749 |
|
1750 </li> |
|
1751 |
|
1752 <li class="index-item method private inherited"> |
|
1753 <a href="#method__addLazyAttr">_addLazyAttr</a> |
|
1754 |
|
1755 |
|
1756 |
|
1757 </li> |
|
1758 |
|
1759 <li class="index-item method protected"> |
|
1760 <a href="#method__addScrollbarPadding">_addScrollbarPadding</a> |
|
1761 |
|
1762 |
|
1763 |
|
1764 </li> |
|
1765 |
|
1766 <li class="index-item method protected inherited"> |
|
1767 <a href="#method__afterChildSelectedChange">_afterChildSelectedChange</a> |
|
1768 |
|
1769 |
|
1770 |
|
1771 </li> |
|
1772 |
|
1773 <li class="index-item method protected"> |
|
1774 <a href="#method__afterColumnsChange">_afterColumnsChange</a> |
|
1775 |
|
1776 |
|
1777 |
|
1778 </li> |
|
1779 |
|
1780 <li class="index-item method protected"> |
|
1781 <a href="#method__afterDataChange">_afterDataChange</a> |
|
1782 |
|
1783 |
|
1784 |
|
1785 </li> |
|
1786 |
|
1787 <li class="index-item method protected inherited"> |
|
1788 <a href="#method__afterDisplayColumnsChange">_afterDisplayColumnsChange</a> |
|
1789 |
|
1790 |
|
1791 |
|
1792 </li> |
|
1793 |
|
1794 <li class="index-item method protected"> |
|
1795 <a href="#method__afterMessageColumnsChange">_afterMessageColumnsChange</a> |
|
1796 |
|
1797 |
|
1798 |
|
1799 </li> |
|
1800 |
|
1801 <li class="index-item method protected"> |
|
1802 <a href="#method__afterMessageDataChange">_afterMessageDataChange</a> |
|
1803 |
|
1804 |
|
1805 |
|
1806 </li> |
|
1807 |
|
1808 <li class="index-item method protected"> |
|
1809 <a href="#method__afterRecordTypeChange">_afterRecordTypeChange</a> |
|
1810 |
|
1811 |
|
1812 |
|
1813 </li> |
|
1814 |
|
1815 <li class="index-item method protected"> |
|
1816 <a href="#method__afterScrollableChange">_afterScrollableChange</a> |
|
1817 |
|
1818 |
|
1819 |
|
1820 </li> |
|
1821 |
|
1822 <li class="index-item method protected"> |
|
1823 <a href="#method__afterScrollCaptionChange">_afterScrollCaptionChange</a> |
|
1824 |
|
1825 |
|
1826 |
|
1827 </li> |
|
1828 |
|
1829 <li class="index-item method protected"> |
|
1830 <a href="#method__afterScrollColumnsChange">_afterScrollColumnsChange</a> |
|
1831 |
|
1832 |
|
1833 |
|
1834 </li> |
|
1835 |
|
1836 <li class="index-item method protected"> |
|
1837 <a href="#method__afterScrollDataChange">_afterScrollDataChange</a> |
|
1838 |
|
1839 |
|
1840 |
|
1841 </li> |
|
1842 |
|
1843 <li class="index-item method protected"> |
|
1844 <a href="#method__afterScrollHeightChange">_afterScrollHeightChange</a> |
|
1845 |
|
1846 |
|
1847 |
|
1848 </li> |
|
1849 |
|
1850 <li class="index-item method protected"> |
|
1851 <a href="#method__afterScrollWidthChange">_afterScrollWidthChange</a> |
|
1852 |
|
1853 |
|
1854 |
|
1855 </li> |
|
1856 |
|
1857 <li class="index-item method protected"> |
|
1858 <a href="#method__afterShowMessagesChange">_afterShowMessagesChange</a> |
|
1859 |
|
1860 |
|
1861 |
|
1862 </li> |
|
1863 |
|
1864 <li class="index-item method protected"> |
|
1865 <a href="#method__afterSortByChange">_afterSortByChange</a> |
|
1866 |
|
1867 |
|
1868 |
|
1869 </li> |
|
1870 |
|
1871 <li class="index-item method protected"> |
|
1872 <a href="#method__afterSortDataChange">_afterSortDataChange</a> |
|
1873 |
|
1874 |
|
1875 |
|
1876 </li> |
|
1877 |
|
1878 <li class="index-item method protected"> |
|
1879 <a href="#method__afterSortRecordChange">_afterSortRecordChange</a> |
|
1880 |
|
1881 |
|
1882 |
|
1883 </li> |
|
1884 |
|
1885 <li class="index-item method private inherited"> |
|
1886 <a href="#method__aggregateAttrs">_aggregateAttrs</a> |
|
1887 |
|
1888 |
|
1889 |
|
1890 </li> |
|
1891 |
|
1892 <li class="index-item method protected inherited"> |
|
1893 <a href="#method__applyParsedConfig">_applyParsedConfig</a> |
|
1894 |
|
1895 |
|
1896 |
|
1897 </li> |
|
1898 |
|
1899 <li class="index-item method protected inherited"> |
|
1900 <a href="#method__applyParser">_applyParser</a> |
|
1901 |
|
1902 |
|
1903 |
|
1904 </li> |
|
1905 |
|
1906 <li class="index-item method private inherited"> |
|
1907 <a href="#method__attrCfgHash">_attrCfgHash</a> |
|
1908 |
|
1909 |
|
1910 |
|
1911 </li> |
|
1912 |
|
1913 <li class="index-item method private inherited"> |
|
1914 <a href="#method__baseDestroy">_baseDestroy</a> |
|
1915 |
|
1916 |
|
1917 |
|
1918 </li> |
|
1919 |
|
1920 <li class="index-item method private inherited"> |
|
1921 <a href="#method__baseInit">_baseInit</a> |
|
1922 |
|
1923 |
|
1924 |
|
1925 </li> |
|
1926 |
|
1927 <li class="index-item method private inherited"> |
|
1928 <a href="#method__bindAttrUI">_bindAttrUI</a> |
|
1929 |
|
1930 |
|
1931 |
|
1932 </li> |
|
1933 |
|
1934 <li class="index-item method protected inherited"> |
|
1935 <a href="#method__bindDOM">_bindDOM</a> |
|
1936 |
|
1937 |
|
1938 |
|
1939 </li> |
|
1940 |
|
1941 <li class="index-item method protected"> |
|
1942 <a href="#method__bindMessageUI">_bindMessageUI</a> |
|
1943 |
|
1944 |
|
1945 |
|
1946 </li> |
|
1947 |
|
1948 <li class="index-item method protected"> |
|
1949 <a href="#method__bindScrollbar">_bindScrollbar</a> |
|
1950 |
|
1951 |
|
1952 |
|
1953 </li> |
|
1954 |
|
1955 <li class="index-item method protected"> |
|
1956 <a href="#method__bindScrollResize">_bindScrollResize</a> |
|
1957 |
|
1958 |
|
1959 |
|
1960 </li> |
|
1961 |
|
1962 <li class="index-item method protected"> |
|
1963 <a href="#method__bindScrollUI">_bindScrollUI</a> |
|
1964 |
|
1965 |
|
1966 |
|
1967 </li> |
|
1968 |
|
1969 <li class="index-item method protected"> |
|
1970 <a href="#method__bindSortUI">_bindSortUI</a> |
|
1971 |
|
1972 |
|
1973 |
|
1974 </li> |
|
1975 |
|
1976 <li class="index-item method protected inherited"> |
|
1977 <a href="#method__bindUI">_bindUI</a> |
|
1978 |
|
1979 |
|
1980 |
|
1981 </li> |
|
1982 |
|
1983 <li class="index-item method protected inherited"> |
|
1984 <a href="#method__bindUIChild">_bindUIChild</a> |
|
1985 |
|
1986 |
|
1987 |
|
1988 </li> |
|
1989 |
|
1990 <li class="index-item method protected"> |
|
1991 <a href="#method__clearScrollLock">_clearScrollLock</a> |
|
1992 |
|
1993 |
|
1994 |
|
1995 </li> |
|
1996 |
|
1997 <li class="index-item method private inherited"> |
|
1998 <a href="#method__cloneDefaultValue">_cloneDefaultValue</a> |
|
1999 |
|
2000 |
|
2001 |
|
2002 </li> |
|
2003 |
|
2004 <li class="index-item method protected"> |
|
2005 <a href="#method__createColumnGroup">_createColumnGroup</a> |
|
2006 |
|
2007 |
|
2008 |
|
2009 </li> |
|
2010 |
|
2011 <li class="index-item method protected"> |
|
2012 <a href="#method__createRecordClass">_createRecordClass</a> |
|
2013 |
|
2014 |
|
2015 |
|
2016 </li> |
|
2017 |
|
2018 <li class="index-item method protected"> |
|
2019 <a href="#method__createScrollbar">_createScrollbar</a> |
|
2020 |
|
2021 |
|
2022 |
|
2023 </li> |
|
2024 |
|
2025 <li class="index-item method protected"> |
|
2026 <a href="#method__createScrollCaptionTable">_createScrollCaptionTable</a> |
|
2027 |
|
2028 |
|
2029 |
|
2030 </li> |
|
2031 |
|
2032 <li class="index-item method private inherited"> |
|
2033 <a href="#method__createUIEvent">_createUIEvent</a> |
|
2034 |
|
2035 |
|
2036 |
|
2037 </li> |
|
2038 |
|
2039 <li class="index-item method protected"> |
|
2040 <a href="#method__createXScrollNode">_createXScrollNode</a> |
|
2041 |
|
2042 |
|
2043 |
|
2044 </li> |
|
2045 |
|
2046 <li class="index-item method protected"> |
|
2047 <a href="#method__createYScrollHeader">_createYScrollHeader</a> |
|
2048 |
|
2049 |
|
2050 |
|
2051 </li> |
|
2052 |
|
2053 <li class="index-item method protected"> |
|
2054 <a href="#method__createYScrollNode">_createYScrollNode</a> |
|
2055 |
|
2056 |
|
2057 |
|
2058 </li> |
|
2059 |
|
2060 <li class="index-item method protected"> |
|
2061 <a href="#method__defAddColumnFn">_defAddColumnFn</a> |
|
2062 |
|
2063 |
|
2064 |
|
2065 </li> |
|
2066 |
|
2067 <li class="index-item method private inherited"> |
|
2068 <a href="#method__defAttrChangeFn">_defAttrChangeFn</a> |
|
2069 |
|
2070 |
|
2071 |
|
2072 </li> |
|
2073 |
|
2074 <li class="index-item method protected inherited"> |
|
2075 <a href="#method__defaultCB">_defaultCB</a> |
|
2076 |
|
2077 |
|
2078 |
|
2079 </li> |
|
2080 |
|
2081 <li class="index-item method protected inherited"> |
|
2082 <a href="#method__defDestroyFn">_defDestroyFn</a> |
|
2083 |
|
2084 |
|
2085 |
|
2086 </li> |
|
2087 |
|
2088 <li class="index-item method protected inherited"> |
|
2089 <a href="#method__defInitFn">_defInitFn</a> |
|
2090 |
|
2091 |
|
2092 |
|
2093 </li> |
|
2094 |
|
2095 <li class="index-item method protected"> |
|
2096 <a href="#method__defModifyColumnFn">_defModifyColumnFn</a> |
|
2097 |
|
2098 |
|
2099 |
|
2100 </li> |
|
2101 |
|
2102 <li class="index-item method protected"> |
|
2103 <a href="#method__defMoveColumnFn">_defMoveColumnFn</a> |
|
2104 |
|
2105 |
|
2106 |
|
2107 </li> |
|
2108 |
|
2109 <li class="index-item method protected"> |
|
2110 <a href="#method__defRemoveColumnFn">_defRemoveColumnFn</a> |
|
2111 |
|
2112 |
|
2113 |
|
2114 </li> |
|
2115 |
|
2116 <li class="index-item method protected inherited"> |
|
2117 <a href="#method__defRenderFn">_defRenderFn</a> |
|
2118 |
|
2119 |
|
2120 |
|
2121 </li> |
|
2122 |
|
2123 <li class="index-item method protected inherited"> |
|
2124 <a href="#method__defRenderViewFn">_defRenderViewFn</a> |
|
2125 |
|
2126 |
|
2127 |
|
2128 </li> |
|
2129 |
|
2130 <li class="index-item method protected"> |
|
2131 <a href="#method__defSortFn">_defSortFn</a> |
|
2132 |
|
2133 |
|
2134 |
|
2135 </li> |
|
2136 |
|
2137 <li class="index-item method protected inherited"> |
|
2138 <a href="#method__destroyBox">_destroyBox</a> |
|
2139 |
|
2140 |
|
2141 |
|
2142 </li> |
|
2143 |
|
2144 <li class="index-item method private inherited"> |
|
2145 <a href="#method__destroyHierarchy">_destroyHierarchy</a> |
|
2146 |
|
2147 |
|
2148 |
|
2149 </li> |
|
2150 |
|
2151 <li class="index-item method private inherited"> |
|
2152 <a href="#method__destroyUIEvents">_destroyUIEvents</a> |
|
2153 |
|
2154 |
|
2155 |
|
2156 </li> |
|
2157 |
|
2158 <li class="index-item method protected"> |
|
2159 <a href="#method__disableScrolling">_disableScrolling</a> |
|
2160 |
|
2161 |
|
2162 |
|
2163 </li> |
|
2164 |
|
2165 <li class="index-item method protected"> |
|
2166 <a href="#method__disableXScrolling">_disableXScrolling</a> |
|
2167 |
|
2168 |
|
2169 |
|
2170 </li> |
|
2171 |
|
2172 <li class="index-item method protected"> |
|
2173 <a href="#method__disableYScrolling">_disableYScrolling</a> |
|
2174 |
|
2175 |
|
2176 |
|
2177 </li> |
|
2178 |
|
2179 <li class="index-item method protected inherited"> |
|
2180 <a href="#method__extractDisplayColumns">_extractDisplayColumns</a> |
|
2181 |
|
2182 |
|
2183 |
|
2184 </li> |
|
2185 |
|
2186 <li class="index-item method private inherited"> |
|
2187 <a href="#method__filterAdHocAttrs">_filterAdHocAttrs</a> |
|
2188 |
|
2189 |
|
2190 |
|
2191 </li> |
|
2192 |
|
2193 <li class="index-item method private inherited"> |
|
2194 <a href="#method__filterAttrCfgs">_filterAttrCfgs</a> |
|
2195 |
|
2196 |
|
2197 |
|
2198 </li> |
|
2199 |
|
2200 <li class="index-item method private inherited"> |
|
2201 <a href="#method__filterUIEvent">_filterUIEvent</a> |
|
2202 |
|
2203 |
|
2204 |
|
2205 </li> |
|
2206 |
|
2207 <li class="index-item method private inherited"> |
|
2208 <a href="#method__fireAttrChange">_fireAttrChange</a> |
|
2209 |
|
2210 |
|
2211 |
|
2212 </li> |
|
2213 |
|
2214 <li class="index-item method protected inherited"> |
|
2215 <a href="#method__getAttr">_getAttr</a> |
|
2216 |
|
2217 |
|
2218 |
|
2219 </li> |
|
2220 |
|
2221 <li class="index-item method protected inherited"> |
|
2222 <a href="#method__getAttrCfg">_getAttrCfg</a> |
|
2223 |
|
2224 |
|
2225 |
|
2226 </li> |
|
2227 |
|
2228 <li class="index-item method protected inherited"> |
|
2229 <a href="#method__getAttrCfgs">_getAttrCfgs</a> |
|
2230 |
|
2231 |
|
2232 |
|
2233 </li> |
|
2234 |
|
2235 <li class="index-item method private inherited"> |
|
2236 <a href="#method__getAttrInitVal">_getAttrInitVal</a> |
|
2237 |
|
2238 |
|
2239 |
|
2240 </li> |
|
2241 |
|
2242 <li class="index-item method protected inherited"> |
|
2243 <a href="#method__getAttrs">_getAttrs</a> |
|
2244 |
|
2245 |
|
2246 |
|
2247 </li> |
|
2248 |
|
2249 <li class="index-item method protected inherited"> |
|
2250 <a href="#method__getClasses">_getClasses</a> |
|
2251 |
|
2252 |
|
2253 |
|
2254 </li> |
|
2255 |
|
2256 <li class="index-item method protected"> |
|
2257 <a href="#method__getColumns">_getColumns</a> |
|
2258 |
|
2259 |
|
2260 |
|
2261 </li> |
|
2262 |
|
2263 <li class="index-item method protected deprecated"> |
|
2264 <a href="#method__getColumnset">_getColumnset</a> |
|
2265 |
|
2266 |
|
2267 |
|
2268 <span class="flag deprecated">deprecated</span> |
|
2269 |
|
2270 </li> |
|
2271 |
|
2272 <li class="index-item method private inherited"> |
|
2273 <a href="#method__getFullType">_getFullType</a> |
|
2274 |
|
2275 |
|
2276 |
|
2277 </li> |
|
2278 |
|
2279 <li class="index-item method private inherited"> |
|
2280 <a href="#method__getHtmlParser">_getHtmlParser</a> |
|
2281 |
|
2282 |
|
2283 |
|
2284 </li> |
|
2285 |
|
2286 <li class="index-item method private inherited"> |
|
2287 <a href="#method__getNodeToParse">_getNodeToParse</a> |
|
2288 |
|
2289 |
|
2290 |
|
2291 </li> |
|
2292 |
|
2293 <li class="index-item method"> |
|
2294 <a href="#method__getRecordType">_getRecordType</a> |
|
2295 |
|
2296 |
|
2297 |
|
2298 </li> |
|
2299 |
|
2300 <li class="index-item method protected"> |
|
2301 <a href="#method__getSortBy">_getSortBy</a> |
|
2302 |
|
2303 |
|
2304 |
|
2305 </li> |
|
2306 |
|
2307 <li class="index-item method protected inherited"> |
|
2308 <a href="#method__getSrcNode">_getSrcNode</a> |
|
2309 |
|
2310 |
|
2311 |
|
2312 </li> |
|
2313 |
|
2314 <li class="index-item method private inherited"> |
|
2315 <a href="#method__getStateVal">_getStateVal</a> |
|
2316 |
|
2317 |
|
2318 |
|
2319 </li> |
|
2320 |
|
2321 <li class="index-item method protected inherited"> |
|
2322 <a href="#method__getStrings">_getStrings</a> |
|
2323 |
|
2324 |
|
2325 |
|
2326 </li> |
|
2327 |
|
2328 <li class="index-item method private inherited"> |
|
2329 <a href="#method__getType">_getType</a> |
|
2330 |
|
2331 |
|
2332 |
|
2333 </li> |
|
2334 |
|
2335 <li class="index-item method protected inherited inherited"> |
|
2336 <a href="#method__getUIEventNode">_getUIEventNode</a> |
|
2337 |
|
2338 |
|
2339 |
|
2340 </li> |
|
2341 |
|
2342 <li class="index-item method protected inherited"> |
|
2343 <a href="#method__guid">_guid</a> |
|
2344 |
|
2345 |
|
2346 |
|
2347 </li> |
|
2348 |
|
2349 <li class="index-item method private inherited"> |
|
2350 <a href="#method__initAttrHost">_initAttrHost</a> |
|
2351 |
|
2352 |
|
2353 |
|
2354 </li> |
|
2355 |
|
2356 <li class="index-item method private inherited inherited"> |
|
2357 <a href="#method__initAttribute">_initAttribute</a> |
|
2358 |
|
2359 |
|
2360 |
|
2361 </li> |
|
2362 |
|
2363 <li class="index-item method protected inherited"> |
|
2364 <a href="#method__initAttrs">_initAttrs</a> |
|
2365 |
|
2366 |
|
2367 |
|
2368 </li> |
|
2369 |
|
2370 <li class="index-item method private inherited"> |
|
2371 <a href="#method__initBase">_initBase</a> |
|
2372 |
|
2373 |
|
2374 |
|
2375 </li> |
|
2376 |
|
2377 <li class="index-item method protected"> |
|
2378 <a href="#method__initColumns">_initColumns</a> |
|
2379 |
|
2380 |
|
2381 |
|
2382 </li> |
|
2383 |
|
2384 <li class="index-item method protected"> |
|
2385 <a href="#method__initCoreEvents">_initCoreEvents</a> |
|
2386 |
|
2387 |
|
2388 |
|
2389 </li> |
|
2390 |
|
2391 <li class="index-item method protected"> |
|
2392 <a href="#method__initData">_initData</a> |
|
2393 |
|
2394 |
|
2395 |
|
2396 </li> |
|
2397 |
|
2398 <li class="index-item method protected"> |
|
2399 <a href="#method__initDataProperty">_initDataProperty</a> |
|
2400 |
|
2401 |
|
2402 |
|
2403 </li> |
|
2404 |
|
2405 <li class="index-item method private inherited"> |
|
2406 <a href="#method__initHierarchy">_initHierarchy</a> |
|
2407 |
|
2408 |
|
2409 |
|
2410 </li> |
|
2411 |
|
2412 <li class="index-item method private inherited"> |
|
2413 <a href="#method__initHierarchyData">_initHierarchyData</a> |
|
2414 |
|
2415 |
|
2416 |
|
2417 </li> |
|
2418 |
|
2419 <li class="index-item method protected"> |
|
2420 <a href="#method__initMessageNode">_initMessageNode</a> |
|
2421 |
|
2422 |
|
2423 |
|
2424 </li> |
|
2425 |
|
2426 <li class="index-item method protected"> |
|
2427 <a href="#method__initMessageStrings">_initMessageStrings</a> |
|
2428 |
|
2429 |
|
2430 |
|
2431 </li> |
|
2432 |
|
2433 <li class="index-item method protected"> |
|
2434 <a href="#method__initSortFn">_initSortFn</a> |
|
2435 |
|
2436 |
|
2437 |
|
2438 </li> |
|
2439 |
|
2440 <li class="index-item method protected"> |
|
2441 <a href="#method__initSortStrings">_initSortStrings</a> |
|
2442 |
|
2443 |
|
2444 |
|
2445 </li> |
|
2446 |
|
2447 <li class="index-item method private inherited"> |
|
2448 <a href="#method__initUIEvent">_initUIEvent</a> |
|
2449 |
|
2450 |
|
2451 |
|
2452 </li> |
|
2453 |
|
2454 <li class="index-item method private inherited"> |
|
2455 <a href="#method__isLazyAttr">_isLazyAttr</a> |
|
2456 |
|
2457 |
|
2458 |
|
2459 </li> |
|
2460 |
|
2461 <li class="index-item method private inherited"> |
|
2462 <a href="#method__isUIEvent">_isUIEvent</a> |
|
2463 |
|
2464 |
|
2465 |
|
2466 </li> |
|
2467 |
|
2468 <li class="index-item method protected inherited"> |
|
2469 <a href="#method__mapInstance">_mapInstance</a> |
|
2470 |
|
2471 |
|
2472 |
|
2473 </li> |
|
2474 |
|
2475 <li class="index-item method private inherited"> |
|
2476 <a href="#method__monitor">_monitor</a> |
|
2477 |
|
2478 |
|
2479 |
|
2480 </li> |
|
2481 |
|
2482 <li class="index-item method private inherited"> |
|
2483 <a href="#method__normAttrVals">_normAttrVals</a> |
|
2484 |
|
2485 |
|
2486 |
|
2487 </li> |
|
2488 |
|
2489 <li class="index-item method protected inherited"> |
|
2490 <a href="#method__onDocFocus">_onDocFocus</a> |
|
2491 |
|
2492 |
|
2493 |
|
2494 </li> |
|
2495 |
|
2496 <li class="index-item method protected inherited"> |
|
2497 <a href="#method__onDocMouseDown">_onDocMouseDown</a> |
|
2498 |
|
2499 |
|
2500 |
|
2501 </li> |
|
2502 |
|
2503 <li class="index-item method protected"> |
|
2504 <a href="#method__onUITriggerSort">_onUITriggerSort</a> |
|
2505 |
|
2506 |
|
2507 |
|
2508 </li> |
|
2509 |
|
2510 <li class="index-item method protected"> |
|
2511 <a href="#method__parseSortable">_parseSortable</a> |
|
2512 |
|
2513 |
|
2514 |
|
2515 </li> |
|
2516 |
|
2517 <li class="index-item method private inherited"> |
|
2518 <a href="#method__parseType">_parseType</a> |
|
2519 |
|
2520 |
|
2521 |
|
2522 </li> |
|
2523 |
|
2524 <li class="index-item method private inherited"> |
|
2525 <a href="#method__preInitEventCfg">_preInitEventCfg</a> |
|
2526 |
|
2527 |
|
2528 |
|
2529 </li> |
|
2530 |
|
2531 <li class="index-item method protected deprecated inherited"> |
|
2532 <a href="#method__protectAttrs">_protectAttrs</a> |
|
2533 |
|
2534 |
|
2535 |
|
2536 <span class="flag deprecated">deprecated</span> |
|
2537 |
|
2538 </li> |
|
2539 |
|
2540 <li class="index-item method private inherited"> |
|
2541 <a href="#method__publish">_publish</a> |
|
2542 |
|
2543 |
|
2544 |
|
2545 </li> |
|
2546 |
|
2547 <li class="index-item method protected inherited"> |
|
2548 <a href="#method__relayCoreAttrChange">_relayCoreAttrChange</a> |
|
2549 |
|
2550 |
|
2551 |
|
2552 </li> |
|
2553 |
|
2554 <li class="index-item method protected inherited"> |
|
2555 <a href="#method__removeLoadingClassNames">_removeLoadingClassNames</a> |
|
2556 |
|
2557 |
|
2558 |
|
2559 </li> |
|
2560 |
|
2561 <li class="index-item method protected"> |
|
2562 <a href="#method__removeScrollbar">_removeScrollbar</a> |
|
2563 |
|
2564 |
|
2565 |
|
2566 </li> |
|
2567 |
|
2568 <li class="index-item method protected"> |
|
2569 <a href="#method__removeScrollCaptionTable">_removeScrollCaptionTable</a> |
|
2570 |
|
2571 |
|
2572 |
|
2573 </li> |
|
2574 |
|
2575 <li class="index-item method protected"> |
|
2576 <a href="#method__removeXScrollNode">_removeXScrollNode</a> |
|
2577 |
|
2578 |
|
2579 |
|
2580 </li> |
|
2581 |
|
2582 <li class="index-item method protected"> |
|
2583 <a href="#method__removeYScrollContainer">_removeYScrollContainer</a> |
|
2584 |
|
2585 |
|
2586 |
|
2587 </li> |
|
2588 |
|
2589 <li class="index-item method protected"> |
|
2590 <a href="#method__removeYScrollHeader">_removeYScrollHeader</a> |
|
2591 |
|
2592 |
|
2593 |
|
2594 </li> |
|
2595 |
|
2596 <li class="index-item method protected"> |
|
2597 <a href="#method__removeYScrollNode">_removeYScrollNode</a> |
|
2598 |
|
2599 |
|
2600 |
|
2601 </li> |
|
2602 |
|
2603 <li class="index-item method private inherited"> |
|
2604 <a href="#method__renderBox">_renderBox</a> |
|
2605 |
|
2606 |
|
2607 |
|
2608 </li> |
|
2609 |
|
2610 <li class="index-item method protected inherited"> |
|
2611 <a href="#method__renderBoxClassNames">_renderBoxClassNames</a> |
|
2612 |
|
2613 |
|
2614 |
|
2615 </li> |
|
2616 |
|
2617 <li class="index-item method protected"> |
|
2618 <a href="#method__renderSortable">_renderSortable</a> |
|
2619 |
|
2620 |
|
2621 |
|
2622 </li> |
|
2623 |
|
2624 <li class="index-item method protected inherited"> |
|
2625 <a href="#method__renderUI">_renderUI</a> |
|
2626 |
|
2627 |
|
2628 |
|
2629 </li> |
|
2630 |
|
2631 <li class="index-item method protected inherited inherited"> |
|
2632 <a href="#method__set">_set</a> |
|
2633 |
|
2634 |
|
2635 |
|
2636 </li> |
|
2637 |
|
2638 <li class="index-item method protected inherited"> |
|
2639 <a href="#method__setAttr">_setAttr</a> |
|
2640 |
|
2641 |
|
2642 |
|
2643 </li> |
|
2644 |
|
2645 <li class="index-item method protected inherited inherited"> |
|
2646 <a href="#method__setAttrs">_setAttrs</a> |
|
2647 |
|
2648 |
|
2649 |
|
2650 </li> |
|
2651 |
|
2652 <li class="index-item method private inherited"> |
|
2653 <a href="#method__setAttrUI">_setAttrUI</a> |
|
2654 |
|
2655 |
|
2656 |
|
2657 </li> |
|
2658 |
|
2659 <li class="index-item method private inherited"> |
|
2660 <a href="#method__setAttrVal">_setAttrVal</a> |
|
2661 |
|
2662 |
|
2663 |
|
2664 </li> |
|
2665 |
|
2666 <li class="index-item method private inherited"> |
|
2667 <a href="#method__setBB">_setBB</a> |
|
2668 |
|
2669 |
|
2670 |
|
2671 </li> |
|
2672 |
|
2673 <li class="index-item method private inherited"> |
|
2674 <a href="#method__setBox">_setBox</a> |
|
2675 |
|
2676 |
|
2677 |
|
2678 </li> |
|
2679 |
|
2680 <li class="index-item method private inherited"> |
|
2681 <a href="#method__setCB">_setCB</a> |
|
2682 |
|
2683 |
|
2684 |
|
2685 </li> |
|
2686 |
|
2687 <li class="index-item method protected"> |
|
2688 <a href="#method__setColumnMap">_setColumnMap</a> |
|
2689 |
|
2690 |
|
2691 |
|
2692 </li> |
|
2693 |
|
2694 <li class="index-item method protected"> |
|
2695 <a href="#method__setColumns">_setColumns</a> |
|
2696 |
|
2697 |
|
2698 |
|
2699 </li> |
|
2700 |
|
2701 <li class="index-item method protected deprecated"> |
|
2702 <a href="#method__setColumnset">_setColumnset</a> |
|
2703 |
|
2704 |
|
2705 |
|
2706 <span class="flag deprecated">deprecated</span> |
|
2707 |
|
2708 </li> |
|
2709 |
|
2710 <li class="index-item method protected"> |
|
2711 <a href="#method__setColumnWidth">_setColumnWidth</a> |
|
2712 |
|
2713 |
|
2714 |
|
2715 </li> |
|
2716 |
|
2717 <li class="index-item method protected"> |
|
2718 <a href="#method__setData">_setData</a> |
|
2719 |
|
2720 |
|
2721 |
|
2722 </li> |
|
2723 |
|
2724 <li class="index-item method protected deprecated"> |
|
2725 <a href="#method__setRecordset">_setRecordset</a> |
|
2726 |
|
2727 |
|
2728 |
|
2729 <span class="flag deprecated">deprecated</span> |
|
2730 |
|
2731 </li> |
|
2732 |
|
2733 <li class="index-item method protected"> |
|
2734 <a href="#method__setRecordType">_setRecordType</a> |
|
2735 |
|
2736 |
|
2737 |
|
2738 </li> |
|
2739 |
|
2740 <li class="index-item method protected"> |
|
2741 <a href="#method__setScrollable">_setScrollable</a> |
|
2742 |
|
2743 |
|
2744 |
|
2745 </li> |
|
2746 |
|
2747 <li class="index-item method protected"> |
|
2748 <a href="#method__setScrollProperties">_setScrollProperties</a> |
|
2749 |
|
2750 |
|
2751 |
|
2752 </li> |
|
2753 |
|
2754 <li class="index-item method protected"> |
|
2755 <a href="#method__setSortBy">_setSortBy</a> |
|
2756 |
|
2757 |
|
2758 |
|
2759 </li> |
|
2760 |
|
2761 <li class="index-item method private inherited"> |
|
2762 <a href="#method__setStateVal">_setStateVal</a> |
|
2763 |
|
2764 |
|
2765 |
|
2766 </li> |
|
2767 |
|
2768 <li class="index-item method protected inherited"> |
|
2769 <a href="#method__setStrings">_setStrings</a> |
|
2770 |
|
2771 |
|
2772 |
|
2773 </li> |
|
2774 |
|
2775 <li class="index-item method protected"> |
|
2776 <a href="#method__sortComparator">_sortComparator</a> |
|
2777 |
|
2778 |
|
2779 |
|
2780 </li> |
|
2781 |
|
2782 <li class="index-item method protected inherited"> |
|
2783 <a href="#method__strSetter">_strSetter</a> |
|
2784 |
|
2785 |
|
2786 |
|
2787 </li> |
|
2788 |
|
2789 <li class="index-item method private inherited"> |
|
2790 <a href="#method__syncAttrUI">_syncAttrUI</a> |
|
2791 |
|
2792 |
|
2793 |
|
2794 </li> |
|
2795 |
|
2796 <li class="index-item method protected"> |
|
2797 <a href="#method__syncMessageUI">_syncMessageUI</a> |
|
2798 |
|
2799 |
|
2800 |
|
2801 </li> |
|
2802 |
|
2803 <li class="index-item method protected"> |
|
2804 <a href="#method__syncScrollCaptionUI">_syncScrollCaptionUI</a> |
|
2805 |
|
2806 |
|
2807 |
|
2808 </li> |
|
2809 |
|
2810 <li class="index-item method protected"> |
|
2811 <a href="#method__syncScrollColumnWidths">_syncScrollColumnWidths</a> |
|
2812 |
|
2813 |
|
2814 |
|
2815 </li> |
|
2816 |
|
2817 <li class="index-item method protected"> |
|
2818 <a href="#method__syncScrollHeaders">_syncScrollHeaders</a> |
|
2819 |
|
2820 |
|
2821 |
|
2822 </li> |
|
2823 |
|
2824 <li class="index-item method protected"> |
|
2825 <a href="#method__syncScrollPosition">_syncScrollPosition</a> |
|
2826 |
|
2827 |
|
2828 |
|
2829 </li> |
|
2830 |
|
2831 <li class="index-item method protected"> |
|
2832 <a href="#method__syncScrollUI">_syncScrollUI</a> |
|
2833 |
|
2834 |
|
2835 |
|
2836 </li> |
|
2837 |
|
2838 <li class="index-item method protected inherited"> |
|
2839 <a href="#method__syncUI">_syncUI</a> |
|
2840 |
|
2841 |
|
2842 |
|
2843 </li> |
|
2844 |
|
2845 <li class="index-item method protected inherited"> |
|
2846 <a href="#method__syncUIChild">_syncUIChild</a> |
|
2847 |
|
2848 |
|
2849 |
|
2850 </li> |
|
2851 |
|
2852 <li class="index-item method protected"> |
|
2853 <a href="#method__syncXScrollUI">_syncXScrollUI</a> |
|
2854 |
|
2855 |
|
2856 |
|
2857 </li> |
|
2858 |
|
2859 <li class="index-item method protected"> |
|
2860 <a href="#method__syncYScrollUI">_syncYScrollUI</a> |
|
2861 |
|
2862 |
|
2863 |
|
2864 </li> |
|
2865 |
|
2866 <li class="index-item method protected inherited"> |
|
2867 <a href="#method__uiSetChildSelected">_uiSetChildSelected</a> |
|
2868 |
|
2869 |
|
2870 |
|
2871 </li> |
|
2872 |
|
2873 <li class="index-item method protected"> |
|
2874 <a href="#method__uiSetColumnWidths">_uiSetColumnWidths</a> |
|
2875 |
|
2876 |
|
2877 |
|
2878 </li> |
|
2879 |
|
2880 <li class="index-item method private inherited"> |
|
2881 <a href="#method__uiSetDim">_uiSetDim</a> |
|
2882 |
|
2883 |
|
2884 |
|
2885 </li> |
|
2886 |
|
2887 <li class="index-item method protected inherited"> |
|
2888 <a href="#method__uiSetDisabled">_uiSetDisabled</a> |
|
2889 |
|
2890 |
|
2891 |
|
2892 </li> |
|
2893 |
|
2894 <li class="index-item method protected inherited"> |
|
2895 <a href="#method__uiSetFocused">_uiSetFocused</a> |
|
2896 |
|
2897 |
|
2898 |
|
2899 </li> |
|
2900 |
|
2901 <li class="index-item method protected inherited"> |
|
2902 <a href="#method__uiSetHeight">_uiSetHeight</a> |
|
2903 |
|
2904 |
|
2905 |
|
2906 </li> |
|
2907 |
|
2908 <li class="index-item method protected"> |
|
2909 <a href="#method__uiSetMessage">_uiSetMessage</a> |
|
2910 |
|
2911 |
|
2912 |
|
2913 </li> |
|
2914 |
|
2915 <li class="index-item method protected"> |
|
2916 <a href="#method__uiSetScrollable">_uiSetScrollable</a> |
|
2917 |
|
2918 |
|
2919 |
|
2920 </li> |
|
2921 |
|
2922 <li class="index-item method protected"> |
|
2923 <a href="#method__uiSetScrollbarHeight">_uiSetScrollbarHeight</a> |
|
2924 |
|
2925 |
|
2926 |
|
2927 </li> |
|
2928 |
|
2929 <li class="index-item method protected"> |
|
2930 <a href="#method__uiSetScrollbarPosition">_uiSetScrollbarPosition</a> |
|
2931 |
|
2932 |
|
2933 |
|
2934 </li> |
|
2935 |
|
2936 <li class="index-item method protected"> |
|
2937 <a href="#method__uiSetSortable">_uiSetSortable</a> |
|
2938 |
|
2939 |
|
2940 |
|
2941 </li> |
|
2942 |
|
2943 <li class="index-item method protected inherited"> |
|
2944 <a href="#method__uiSetTabIndex">_uiSetTabIndex</a> |
|
2945 |
|
2946 |
|
2947 |
|
2948 </li> |
|
2949 |
|
2950 <li class="index-item method protected inherited"> |
|
2951 <a href="#method__uiSetVisible">_uiSetVisible</a> |
|
2952 |
|
2953 |
|
2954 |
|
2955 </li> |
|
2956 |
|
2957 <li class="index-item method protected inherited"> |
|
2958 <a href="#method__uiSetWidth">_uiSetWidth</a> |
|
2959 |
|
2960 |
|
2961 |
|
2962 </li> |
|
2963 |
|
2964 <li class="index-item method protected"> |
|
2965 <a href="#method__uiSetYScrollWidth">_uiSetYScrollWidth</a> |
|
2966 |
|
2967 |
|
2968 |
|
2969 </li> |
|
2970 |
|
2971 <li class="index-item method protected inherited"> |
|
2972 <a href="#method__uiSizeCB">_uiSizeCB</a> |
|
2973 |
|
2974 |
|
2975 |
|
2976 </li> |
|
2977 |
|
2978 <li class="index-item method protected inherited"> |
|
2979 <a href="#method__unbindDOM">_unbindDOM</a> |
|
2980 |
|
2981 |
|
2982 |
|
2983 </li> |
|
2984 |
|
2985 <li class="index-item method protected"> |
|
2986 <a href="#method__unbindScrollbar">_unbindScrollbar</a> |
|
2987 |
|
2988 |
|
2989 |
|
2990 </li> |
|
2991 |
|
2992 <li class="index-item method protected"> |
|
2993 <a href="#method__unbindScrollResize">_unbindScrollResize</a> |
|
2994 |
|
2995 |
|
2996 |
|
2997 </li> |
|
2998 |
|
2999 <li class="index-item method protected inherited"> |
|
3000 <a href="#method__unbindUI">_unbindUI</a> |
|
3001 |
|
3002 |
|
3003 |
|
3004 </li> |
|
3005 |
|
3006 <li class="index-item method protected"> |
|
3007 <a href="#method__validateSortable">_validateSortable</a> |
|
3008 |
|
3009 |
|
3010 |
|
3011 </li> |
|
3012 |
|
3013 <li class="index-item method protected"> |
|
3014 <a href="#method__validateSortBy">_validateSortBy</a> |
|
3015 |
|
3016 |
|
3017 |
|
3018 </li> |
|
3019 |
|
3020 <li class="index-item method protected inherited"> |
|
3021 <a href="#method__validateView">_validateView</a> |
|
3022 |
|
3023 |
|
3024 |
|
3025 </li> |
|
3026 |
|
3027 <li class="index-item method protected inherited"> |
|
3028 <a href="#method__validTabIndex">_validTabIndex</a> |
|
3029 |
|
3030 |
|
3031 |
|
3032 </li> |
|
3033 |
|
3034 <li class="index-item method inherited"> |
|
3035 <a href="#method_addAttr">addAttr</a> |
|
3036 |
|
3037 |
|
3038 |
|
3039 </li> |
|
3040 |
|
3041 <li class="index-item method inherited"> |
|
3042 <a href="#method_addAttrs">addAttrs</a> |
|
3043 |
|
3044 |
|
3045 |
|
3046 </li> |
|
3047 |
|
3048 <li class="index-item method"> |
|
3049 <a href="#method_addColumn">addColumn</a> |
|
3050 |
|
3051 |
|
3052 |
|
3053 </li> |
|
3054 |
|
3055 <li class="index-item method"> |
|
3056 <a href="#method_addRow">addRow</a> |
|
3057 |
|
3058 |
|
3059 |
|
3060 </li> |
|
3061 |
|
3062 <li class="index-item method"> |
|
3063 <a href="#method_addRows">addRows</a> |
|
3064 |
|
3065 |
|
3066 |
|
3067 </li> |
|
3068 |
|
3069 <li class="index-item method inherited"> |
|
3070 <a href="#method_addTarget">addTarget</a> |
|
3071 |
|
3072 |
|
3073 |
|
3074 </li> |
|
3075 |
|
3076 <li class="index-item method inherited"> |
|
3077 <a href="#method_after">after</a> |
|
3078 |
|
3079 |
|
3080 |
|
3081 </li> |
|
3082 |
|
3083 <li class="index-item method inherited"> |
|
3084 <a href="#method_ancestor">ancestor</a> |
|
3085 |
|
3086 |
|
3087 |
|
3088 </li> |
|
3089 |
|
3090 <li class="index-item method inherited"> |
|
3091 <a href="#method_attrAdded">attrAdded</a> |
|
3092 |
|
3093 |
|
3094 |
|
3095 </li> |
|
3096 |
|
3097 <li class="index-item method inherited"> |
|
3098 <a href="#method_before">before</a> |
|
3099 |
|
3100 |
|
3101 |
|
3102 </li> |
|
3103 |
|
3104 <li class="index-item method protected inherited inherited"> |
|
3105 <a href="#method_bindUI">bindUI</a> |
|
3106 |
|
3107 |
|
3108 |
|
3109 </li> |
|
3110 |
|
3111 <li class="index-item method inherited"> |
|
3112 <a href="#method_blur">blur</a> |
|
3113 |
|
3114 |
|
3115 |
|
3116 </li> |
|
3117 |
|
3118 <li class="index-item method inherited"> |
|
3119 <a href="#method_bubble">bubble</a> |
|
3120 |
|
3121 |
|
3122 |
|
3123 </li> |
|
3124 |
|
3125 <li class="index-item method inherited"> |
|
3126 <a href="#method_delegate">delegate</a> |
|
3127 |
|
3128 |
|
3129 |
|
3130 </li> |
|
3131 |
|
3132 <li class="index-item method inherited inherited"> |
|
3133 <a href="#method_destroy">destroy</a> |
|
3134 |
|
3135 |
|
3136 |
|
3137 </li> |
|
3138 |
|
3139 <li class="index-item method protected"> |
|
3140 <a href="#method_destructor">destructor</a> |
|
3141 |
|
3142 |
|
3143 |
|
3144 </li> |
|
3145 |
|
3146 <li class="index-item method protected inherited"> |
|
3147 <a href="#method_destructor">destructor</a> |
|
3148 |
|
3149 |
|
3150 |
|
3151 </li> |
|
3152 |
|
3153 <li class="index-item method inherited"> |
|
3154 <a href="#method_detach">detach</a> |
|
3155 |
|
3156 |
|
3157 |
|
3158 </li> |
|
3159 |
|
3160 <li class="index-item method inherited"> |
|
3161 <a href="#method_detachAll">detachAll</a> |
|
3162 |
|
3163 |
|
3164 |
|
3165 </li> |
|
3166 |
|
3167 <li class="index-item method inherited"> |
|
3168 <a href="#method_disable">disable</a> |
|
3169 |
|
3170 |
|
3171 |
|
3172 </li> |
|
3173 |
|
3174 <li class="index-item method inherited"> |
|
3175 <a href="#method_enable">enable</a> |
|
3176 |
|
3177 |
|
3178 |
|
3179 </li> |
|
3180 |
|
3181 <li class="index-item method inherited"> |
|
3182 <a href="#method_fire">fire</a> |
|
3183 |
|
3184 |
|
3185 |
|
3186 </li> |
|
3187 |
|
3188 <li class="index-item method inherited"> |
|
3189 <a href="#method_focus">focus</a> |
|
3190 |
|
3191 |
|
3192 |
|
3193 </li> |
|
3194 |
|
3195 <li class="index-item method inherited"> |
|
3196 <a href="#method_get">get</a> |
|
3197 |
|
3198 |
|
3199 |
|
3200 </li> |
|
3201 |
|
3202 <li class="index-item method inherited"> |
|
3203 <a href="#method_getAttrs">getAttrs</a> |
|
3204 |
|
3205 |
|
3206 |
|
3207 </li> |
|
3208 |
|
3209 <li class="index-item method inherited"> |
|
3210 <a href="#method_getCell">getCell</a> |
|
3211 |
|
3212 |
|
3213 |
|
3214 </li> |
|
3215 |
|
3216 <li class="index-item method inherited inherited"> |
|
3217 <a href="#method_getClassName">getClassName</a> |
|
3218 |
|
3219 |
|
3220 |
|
3221 </li> |
|
3222 |
|
3223 <li class="index-item method"> |
|
3224 <a href="#method_getColumn">getColumn</a> |
|
3225 |
|
3226 |
|
3227 |
|
3228 </li> |
|
3229 |
|
3230 <li class="index-item method inherited"> |
|
3231 <a href="#method_getDefaultLocale">getDefaultLocale</a> |
|
3232 |
|
3233 |
|
3234 |
|
3235 </li> |
|
3236 |
|
3237 <li class="index-item method inherited"> |
|
3238 <a href="#method_getEvent">getEvent</a> |
|
3239 |
|
3240 |
|
3241 |
|
3242 </li> |
|
3243 |
|
3244 <li class="index-item method"> |
|
3245 <a href="#method_getRecord">getRecord</a> |
|
3246 |
|
3247 |
|
3248 |
|
3249 </li> |
|
3250 |
|
3251 <li class="index-item method inherited"> |
|
3252 <a href="#method_getRow">getRow</a> |
|
3253 |
|
3254 |
|
3255 |
|
3256 </li> |
|
3257 |
|
3258 <li class="index-item method inherited"> |
|
3259 <a href="#method_getSkinName">getSkinName</a> |
|
3260 |
|
3261 |
|
3262 |
|
3263 </li> |
|
3264 |
|
3265 <li class="index-item method deprecated inherited inherited"> |
|
3266 <a href="#method_getString">getString</a> |
|
3267 |
|
3268 |
|
3269 |
|
3270 <span class="flag deprecated">deprecated</span> |
|
3271 |
|
3272 </li> |
|
3273 |
|
3274 <li class="index-item method deprecated inherited inherited"> |
|
3275 <a href="#method_getStrings">getStrings</a> |
|
3276 |
|
3277 |
|
3278 |
|
3279 <span class="flag deprecated">deprecated</span> |
|
3280 |
|
3281 </li> |
|
3282 |
|
3283 <li class="index-item method inherited"> |
|
3284 <a href="#method_getTargets">getTargets</a> |
|
3285 |
|
3286 |
|
3287 |
|
3288 </li> |
|
3289 |
|
3290 <li class="index-item method inherited"> |
|
3291 <a href="#method_hide">hide</a> |
|
3292 |
|
3293 |
|
3294 |
|
3295 </li> |
|
3296 |
|
3297 <li class="index-item method"> |
|
3298 <a href="#method_hideMessage">hideMessage</a> |
|
3299 |
|
3300 |
|
3301 |
|
3302 </li> |
|
3303 |
|
3304 <li class="index-item method inherited inherited"> |
|
3305 <a href="#method_init">init</a> |
|
3306 |
|
3307 |
|
3308 |
|
3309 </li> |
|
3310 |
|
3311 <li class="index-item method protected"> |
|
3312 <a href="#method_initializer">initializer</a> |
|
3313 |
|
3314 |
|
3315 |
|
3316 </li> |
|
3317 |
|
3318 <li class="index-item method protected"> |
|
3319 <a href="#method_initializer">initializer</a> |
|
3320 |
|
3321 |
|
3322 |
|
3323 </li> |
|
3324 |
|
3325 <li class="index-item method protected"> |
|
3326 <a href="#method_initializer">initializer</a> |
|
3327 |
|
3328 |
|
3329 |
|
3330 </li> |
|
3331 |
|
3332 <li class="index-item method protected"> |
|
3333 <a href="#method_initializer">initializer</a> |
|
3334 |
|
3335 |
|
3336 |
|
3337 </li> |
|
3338 |
|
3339 <li class="index-item method protected inherited"> |
|
3340 <a href="#method_initializer">initializer</a> |
|
3341 |
|
3342 |
|
3343 |
|
3344 </li> |
|
3345 |
|
3346 <li class="index-item method protected"> |
|
3347 <a href="#method_initializer">initializer</a> |
|
3348 |
|
3349 |
|
3350 |
|
3351 </li> |
|
3352 |
|
3353 <li class="index-item method inherited"> |
|
3354 <a href="#method_isRoot">isRoot</a> |
|
3355 |
|
3356 |
|
3357 |
|
3358 </li> |
|
3359 |
|
3360 <li class="index-item method inherited"> |
|
3361 <a href="#method_modifyAttr">modifyAttr</a> |
|
3362 |
|
3363 |
|
3364 |
|
3365 </li> |
|
3366 |
|
3367 <li class="index-item method"> |
|
3368 <a href="#method_modifyColumn">modifyColumn</a> |
|
3369 |
|
3370 |
|
3371 |
|
3372 </li> |
|
3373 |
|
3374 <li class="index-item method"> |
|
3375 <a href="#method_modifyRow">modifyRow</a> |
|
3376 |
|
3377 |
|
3378 |
|
3379 </li> |
|
3380 |
|
3381 <li class="index-item method"> |
|
3382 <a href="#method_moveColumn">moveColumn</a> |
|
3383 |
|
3384 |
|
3385 |
|
3386 </li> |
|
3387 |
|
3388 <li class="index-item method inherited"> |
|
3389 <a href="#method_next">next</a> |
|
3390 |
|
3391 |
|
3392 |
|
3393 </li> |
|
3394 |
|
3395 <li class="index-item method inherited"> |
|
3396 <a href="#method_on">on</a> |
|
3397 |
|
3398 |
|
3399 |
|
3400 </li> |
|
3401 |
|
3402 <li class="index-item method inherited"> |
|
3403 <a href="#method_once">once</a> |
|
3404 |
|
3405 |
|
3406 |
|
3407 </li> |
|
3408 |
|
3409 <li class="index-item method inherited"> |
|
3410 <a href="#method_onceAfter">onceAfter</a> |
|
3411 |
|
3412 |
|
3413 |
|
3414 </li> |
|
3415 |
|
3416 <li class="index-item method inherited"> |
|
3417 <a href="#method_parseType">parseType</a> |
|
3418 |
|
3419 |
|
3420 |
|
3421 </li> |
|
3422 |
|
3423 <li class="index-item method inherited"> |
|
3424 <a href="#method_previous">previous</a> |
|
3425 |
|
3426 |
|
3427 |
|
3428 </li> |
|
3429 |
|
3430 <li class="index-item method inherited"> |
|
3431 <a href="#method_publish">publish</a> |
|
3432 |
|
3433 |
|
3434 |
|
3435 </li> |
|
3436 |
|
3437 <li class="index-item method inherited"> |
|
3438 <a href="#method_removeAttr">removeAttr</a> |
|
3439 |
|
3440 |
|
3441 |
|
3442 </li> |
|
3443 |
|
3444 <li class="index-item method"> |
|
3445 <a href="#method_removeColumn">removeColumn</a> |
|
3446 |
|
3447 |
|
3448 |
|
3449 </li> |
|
3450 |
|
3451 <li class="index-item method"> |
|
3452 <a href="#method_removeRow">removeRow</a> |
|
3453 |
|
3454 |
|
3455 |
|
3456 </li> |
|
3457 |
|
3458 <li class="index-item method inherited"> |
|
3459 <a href="#method_removeTarget">removeTarget</a> |
|
3460 |
|
3461 |
|
3462 |
|
3463 </li> |
|
3464 |
|
3465 <li class="index-item method inherited"> |
|
3466 <a href="#method_render">render</a> |
|
3467 |
|
3468 |
|
3469 |
|
3470 </li> |
|
3471 |
|
3472 <li class="index-item method protected inherited"> |
|
3473 <a href="#method_renderer">renderer</a> |
|
3474 |
|
3475 |
|
3476 |
|
3477 </li> |
|
3478 |
|
3479 <li class="index-item method protected inherited"> |
|
3480 <a href="#method_renderUI">renderUI</a> |
|
3481 |
|
3482 |
|
3483 |
|
3484 </li> |
|
3485 |
|
3486 <li class="index-item method inherited"> |
|
3487 <a href="#method_reset">reset</a> |
|
3488 |
|
3489 |
|
3490 |
|
3491 </li> |
|
3492 |
|
3493 <li class="index-item method"> |
|
3494 <a href="#method_scrollTo">scrollTo</a> |
|
3495 |
|
3496 |
|
3497 |
|
3498 </li> |
|
3499 |
|
3500 <li class="index-item method inherited inherited"> |
|
3501 <a href="#method_set">set</a> |
|
3502 |
|
3503 |
|
3504 |
|
3505 </li> |
|
3506 |
|
3507 <li class="index-item method inherited inherited"> |
|
3508 <a href="#method_setAttrs">setAttrs</a> |
|
3509 |
|
3510 |
|
3511 |
|
3512 </li> |
|
3513 |
|
3514 <li class="index-item method"> |
|
3515 <a href="#method_setColumnWidth">setColumnWidth</a> |
|
3516 |
|
3517 |
|
3518 |
|
3519 </li> |
|
3520 |
|
3521 <li class="index-item method inherited"> |
|
3522 <a href="#method_show">show</a> |
|
3523 |
|
3524 |
|
3525 |
|
3526 </li> |
|
3527 |
|
3528 <li class="index-item method"> |
|
3529 <a href="#method_showMessage">showMessage</a> |
|
3530 |
|
3531 |
|
3532 |
|
3533 </li> |
|
3534 |
|
3535 <li class="index-item method"> |
|
3536 <a href="#method_sort">sort</a> |
|
3537 |
|
3538 |
|
3539 |
|
3540 </li> |
|
3541 |
|
3542 <li class="index-item method deprecated inherited"> |
|
3543 <a href="#method_subscribe">subscribe</a> |
|
3544 |
|
3545 |
|
3546 |
|
3547 <span class="flag deprecated">deprecated</span> |
|
3548 |
|
3549 </li> |
|
3550 |
|
3551 <li class="index-item method inherited inherited"> |
|
3552 <a href="#method_syncUI">syncUI</a> |
|
3553 |
|
3554 |
|
3555 |
|
3556 </li> |
|
3557 |
|
3558 <li class="index-item method"> |
|
3559 <a href="#method_toggleSort">toggleSort</a> |
|
3560 |
|
3561 |
|
3562 |
|
3563 </li> |
|
3564 |
|
3565 <li class="index-item method inherited inherited"> |
|
3566 <a href="#method_toString">toString</a> |
|
3567 |
|
3568 |
|
3569 |
|
3570 </li> |
|
3571 |
|
3572 <li class="index-item method deprecated inherited"> |
|
3573 <a href="#method_unsubscribe">unsubscribe</a> |
|
3574 |
|
3575 |
|
3576 |
|
3577 <span class="flag deprecated">deprecated</span> |
|
3578 |
|
3579 </li> |
|
3580 |
|
3581 <li class="index-item method deprecated inherited"> |
|
3582 <a href="#method_unsubscribeAll">unsubscribeAll</a> |
|
3583 |
|
3584 |
|
3585 |
|
3586 <span class="flag deprecated">deprecated</span> |
|
3587 |
|
3588 </li> |
|
3589 |
|
3590 </ul> |
|
3591 </div> |
|
3592 |
|
3593 |
|
3594 |
|
3595 <div class="index-section properties"> |
|
3596 <h3>Properties</h3> |
|
3597 |
|
3598 <ul class="index-list properties extends"> |
|
3599 |
|
3600 <li class="index-item property protected inherited"> |
|
3601 <a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a> |
|
3602 |
|
3603 |
|
3604 |
|
3605 </li> |
|
3606 |
|
3607 <li class="index-item property protected"> |
|
3608 <a href="#property__CAPTION_TABLE_TEMPLATE">_CAPTION_TABLE_TEMPLATE</a> |
|
3609 |
|
3610 |
|
3611 |
|
3612 </li> |
|
3613 |
|
3614 <li class="index-item property protected"> |
|
3615 <a href="#property__columnMap">_columnMap</a> |
|
3616 |
|
3617 |
|
3618 |
|
3619 </li> |
|
3620 |
|
3621 <li class="index-item property inherited"> |
|
3622 <a href="#property__displayColumns">_displayColumns</a> |
|
3623 |
|
3624 |
|
3625 |
|
3626 </li> |
|
3627 |
|
3628 <li class="index-item property"> |
|
3629 <a href="#property__messageNode">_messageNode</a> |
|
3630 |
|
3631 |
|
3632 |
|
3633 </li> |
|
3634 |
|
3635 <li class="index-item property protected"> |
|
3636 <a href="#property__SCROLL_LINER_TEMPLATE">_SCROLL_LINER_TEMPLATE</a> |
|
3637 |
|
3638 |
|
3639 |
|
3640 </li> |
|
3641 |
|
3642 <li class="index-item property protected"> |
|
3643 <a href="#property__SCROLLBAR_TEMPLATE">_SCROLLBAR_TEMPLATE</a> |
|
3644 |
|
3645 |
|
3646 |
|
3647 </li> |
|
3648 |
|
3649 <li class="index-item property protected"> |
|
3650 <a href="#property__sortable">_sortable</a> |
|
3651 |
|
3652 |
|
3653 |
|
3654 </li> |
|
3655 |
|
3656 <li class="index-item property protected"> |
|
3657 <a href="#property__sortBy">_sortBy</a> |
|
3658 |
|
3659 |
|
3660 |
|
3661 </li> |
|
3662 |
|
3663 <li class="index-item property protected"> |
|
3664 <a href="#property__tableNode">_tableNode</a> |
|
3665 |
|
3666 |
|
3667 |
|
3668 </li> |
|
3669 |
|
3670 <li class="index-item property private inherited"> |
|
3671 <a href="#property__UI_ATTRS">_UI_ATTRS</a> |
|
3672 |
|
3673 |
|
3674 |
|
3675 </li> |
|
3676 |
|
3677 <li class="index-item property protected"> |
|
3678 <a href="#property__X_SCROLLER_TEMPLATE">_X_SCROLLER_TEMPLATE</a> |
|
3679 |
|
3680 |
|
3681 |
|
3682 </li> |
|
3683 |
|
3684 <li class="index-item property private"> |
|
3685 <a href="#property__xScroll">_xScroll</a> |
|
3686 |
|
3687 |
|
3688 |
|
3689 </li> |
|
3690 |
|
3691 <li class="index-item property protected"> |
|
3692 <a href="#property__xScrollNode">_xScrollNode</a> |
|
3693 |
|
3694 |
|
3695 |
|
3696 </li> |
|
3697 |
|
3698 <li class="index-item property protected"> |
|
3699 <a href="#property__Y_SCROLL_HEADER_TEMPLATE">_Y_SCROLL_HEADER_TEMPLATE</a> |
|
3700 |
|
3701 |
|
3702 |
|
3703 </li> |
|
3704 |
|
3705 <li class="index-item property protected"> |
|
3706 <a href="#property__Y_SCROLLER_TEMPLATE">_Y_SCROLLER_TEMPLATE</a> |
|
3707 |
|
3708 |
|
3709 |
|
3710 </li> |
|
3711 |
|
3712 <li class="index-item property private"> |
|
3713 <a href="#property__yScroll">_yScroll</a> |
|
3714 |
|
3715 |
|
3716 |
|
3717 </li> |
|
3718 |
|
3719 <li class="index-item property protected"> |
|
3720 <a href="#property__yScrollHeader">_yScrollHeader</a> |
|
3721 |
|
3722 |
|
3723 |
|
3724 </li> |
|
3725 |
|
3726 <li class="index-item property protected"> |
|
3727 <a href="#property__yScrollNode">_yScrollNode</a> |
|
3728 |
|
3729 |
|
3730 |
|
3731 </li> |
|
3732 |
|
3733 <li class="index-item property inherited"> |
|
3734 <a href="#property_BOUNDING_TEMPLATE">BOUNDING_TEMPLATE</a> |
|
3735 |
|
3736 |
|
3737 |
|
3738 </li> |
|
3739 |
|
3740 <li class="index-item property"> |
|
3741 <a href="#property_COL_TEMPLATE">COL_TEMPLATE</a> |
|
3742 |
|
3743 |
|
3744 |
|
3745 </li> |
|
3746 |
|
3747 <li class="index-item property"> |
|
3748 <a href="#property_COLGROUP_TEMPLATE">COLGROUP_TEMPLATE</a> |
|
3749 |
|
3750 |
|
3751 |
|
3752 </li> |
|
3753 |
|
3754 <li class="index-item property inherited"> |
|
3755 <a href="#property_CONTENT_TEMPLATE">CONTENT_TEMPLATE</a> |
|
3756 |
|
3757 |
|
3758 |
|
3759 </li> |
|
3760 |
|
3761 <li class="index-item property"> |
|
3762 <a href="#property_data">data</a> |
|
3763 |
|
3764 |
|
3765 |
|
3766 </li> |
|
3767 |
|
3768 <li class="index-item property inherited"> |
|
3769 <a href="#property_DEF_PARENT_NODE">DEF_PARENT_NODE</a> |
|
3770 |
|
3771 |
|
3772 |
|
3773 </li> |
|
3774 |
|
3775 <li class="index-item property inherited"> |
|
3776 <a href="#property_DEF_UNIT">DEF_UNIT</a> |
|
3777 |
|
3778 |
|
3779 |
|
3780 </li> |
|
3781 |
|
3782 <li class="index-item property"> |
|
3783 <a href="#property_MESSAGE_TEMPLATE">MESSAGE_TEMPLATE</a> |
|
3784 |
|
3785 |
|
3786 |
|
3787 </li> |
|
3788 |
|
3789 <li class="index-item property deprecated inherited"> |
|
3790 <a href="#property_name">name</a> |
|
3791 |
|
3792 |
|
3793 |
|
3794 <span class="flag deprecated">deprecated</span> |
|
3795 |
|
3796 </li> |
|
3797 |
|
3798 <li class="index-item property"> |
|
3799 <a href="#property_SORTABLE_HEADER_TEMPLATE">SORTABLE_HEADER_TEMPLATE</a> |
|
3800 |
|
3801 |
|
3802 |
|
3803 </li> |
|
3804 |
|
3805 <li class="index-item property inherited"> |
|
3806 <a href="#property_UI_EVENTS">UI_EVENTS</a> |
|
3807 |
|
3808 |
|
3809 |
|
3810 </li> |
|
3811 |
|
3812 </ul> |
|
3813 </div> |
|
3814 |
|
3815 |
|
3816 |
|
3817 <div class="index-section attrs"> |
|
3818 <h3>Attributes</h3> |
|
3819 |
|
3820 <ul class="index-list attrs extends"> |
|
3821 |
|
3822 <li class="index-item attr"> |
|
3823 <a href="#attr_autoSync">autoSync</a> |
|
3824 </li> |
|
3825 |
|
3826 <li class="index-item attr protected inherited"> |
|
3827 <a href="#attr_bodyConfig">bodyConfig</a> |
|
3828 </li> |
|
3829 |
|
3830 <li class="index-item attr inherited"> |
|
3831 <a href="#attr_bodyView">bodyView</a> |
|
3832 </li> |
|
3833 |
|
3834 <li class="index-item attr inherited"> |
|
3835 <a href="#attr_boundingBox">boundingBox</a> |
|
3836 </li> |
|
3837 |
|
3838 <li class="index-item attr"> |
|
3839 <a href="#attr_caption">caption</a> |
|
3840 </li> |
|
3841 |
|
3842 <li class="index-item attr"> |
|
3843 <a href="#attr_columns">columns</a> |
|
3844 </li> |
|
3845 |
|
3846 <li class="index-item attr deprecated"> |
|
3847 <a href="#attr_columnset">columnset</a> |
|
3848 </li> |
|
3849 |
|
3850 <li class="index-item attr inherited"> |
|
3851 <a href="#attr_contentBox">contentBox</a> |
|
3852 </li> |
|
3853 |
|
3854 <li class="index-item attr"> |
|
3855 <a href="#attr_data">data</a> |
|
3856 </li> |
|
3857 |
|
3858 <li class="index-item attr inherited"> |
|
3859 <a href="#attr_destroyed">destroyed</a> |
|
3860 </li> |
|
3861 |
|
3862 <li class="index-item attr inherited"> |
|
3863 <a href="#attr_disabled">disabled</a> |
|
3864 </li> |
|
3865 |
|
3866 <li class="index-item attr inherited"> |
|
3867 <a href="#attr_focused">focused</a> |
|
3868 </li> |
|
3869 |
|
3870 <li class="index-item attr protected inherited"> |
|
3871 <a href="#attr_footerConfig">footerConfig</a> |
|
3872 </li> |
|
3873 |
|
3874 <li class="index-item attr inherited"> |
|
3875 <a href="#attr_footerView">footerView</a> |
|
3876 </li> |
|
3877 |
|
3878 <li class="index-item attr protected inherited"> |
|
3879 <a href="#attr_headerConfig">headerConfig</a> |
|
3880 </li> |
|
3881 |
|
3882 <li class="index-item attr inherited"> |
|
3883 <a href="#attr_headerView">headerView</a> |
|
3884 </li> |
|
3885 |
|
3886 <li class="index-item attr inherited"> |
|
3887 <a href="#attr_height">height</a> |
|
3888 </li> |
|
3889 |
|
3890 <li class="index-item attr inherited"> |
|
3891 <a href="#attr_id">id</a> |
|
3892 </li> |
|
3893 |
|
3894 <li class="index-item attr inherited"> |
|
3895 <a href="#attr_initialized">initialized</a> |
|
3896 </li> |
|
3897 |
|
3898 <li class="index-item attr deprecated inherited"> |
|
3899 <a href="#attr_locale">locale</a> |
|
3900 </li> |
|
3901 |
|
3902 <li class="index-item attr deprecated"> |
|
3903 <a href="#attr_recordset">recordset</a> |
|
3904 </li> |
|
3905 |
|
3906 <li class="index-item attr"> |
|
3907 <a href="#attr_recordType">recordType</a> |
|
3908 </li> |
|
3909 |
|
3910 <li class="index-item attr inherited"> |
|
3911 <a href="#attr_render">render</a> |
|
3912 </li> |
|
3913 |
|
3914 <li class="index-item attr inherited"> |
|
3915 <a href="#attr_rendered">rendered</a> |
|
3916 </li> |
|
3917 |
|
3918 <li class="index-item attr"> |
|
3919 <a href="#attr_scrollable">scrollable</a> |
|
3920 </li> |
|
3921 |
|
3922 <li class="index-item attr"> |
|
3923 <a href="#attr_showMessages">showMessages</a> |
|
3924 </li> |
|
3925 |
|
3926 <li class="index-item attr"> |
|
3927 <a href="#attr_sortable">sortable</a> |
|
3928 </li> |
|
3929 |
|
3930 <li class="index-item attr"> |
|
3931 <a href="#attr_sortBy">sortBy</a> |
|
3932 </li> |
|
3933 |
|
3934 <li class="index-item attr inherited"> |
|
3935 <a href="#attr_srcNode">srcNode</a> |
|
3936 </li> |
|
3937 |
|
3938 <li class="index-item attr inherited"> |
|
3939 <a href="#attr_strings">strings</a> |
|
3940 </li> |
|
3941 |
|
3942 <li class="index-item attr"> |
|
3943 <a href="#attr_summary">summary</a> |
|
3944 </li> |
|
3945 |
|
3946 <li class="index-item attr inherited"> |
|
3947 <a href="#attr_tabIndex">tabIndex</a> |
|
3948 </li> |
|
3949 |
|
3950 <li class="index-item attr inherited"> |
|
3951 <a href="#attr_view">view</a> |
|
3952 </li> |
|
3953 |
|
3954 <li class="index-item attr protected inherited"> |
|
3955 <a href="#attr_viewConfig">viewConfig</a> |
|
3956 </li> |
|
3957 |
|
3958 <li class="index-item attr inherited"> |
|
3959 <a href="#attr_visible">visible</a> |
|
3960 </li> |
|
3961 |
|
3962 <li class="index-item attr inherited"> |
|
3963 <a href="#attr_width">width</a> |
|
3964 </li> |
|
3965 |
|
3966 </ul> |
|
3967 </div> |
|
3968 |
|
3969 |
|
3970 |
|
3971 <div class="index-section events"> |
|
3972 <h3>Events</h3> |
|
3973 |
|
3974 <ul class="index-list events extends"> |
|
3975 |
|
3976 <li class="index-item event"> |
|
3977 <a href="#event_addColumn">addColumn</a> |
|
3978 |
|
3979 |
|
3980 |
|
3981 </li> |
|
3982 |
|
3983 <li class="index-item event inherited"> |
|
3984 <a href="#event_destroy">destroy</a> |
|
3985 |
|
3986 |
|
3987 |
|
3988 </li> |
|
3989 |
|
3990 <li class="index-item event inherited"> |
|
3991 <a href="#event_init">init</a> |
|
3992 |
|
3993 |
|
3994 |
|
3995 </li> |
|
3996 |
|
3997 <li class="index-item event"> |
|
3998 <a href="#event_modifyColumn">modifyColumn</a> |
|
3999 |
|
4000 |
|
4001 |
|
4002 </li> |
|
4003 |
|
4004 <li class="index-item event"> |
|
4005 <a href="#event_moveColumn">moveColumn</a> |
|
4006 |
|
4007 |
|
4008 |
|
4009 </li> |
|
4010 |
|
4011 <li class="index-item event"> |
|
4012 <a href="#event_removeColumn">removeColumn</a> |
|
4013 |
|
4014 |
|
4015 |
|
4016 </li> |
|
4017 |
|
4018 <li class="index-item event inherited"> |
|
4019 <a href="#event_render">render</a> |
|
4020 |
|
4021 |
|
4022 |
|
4023 </li> |
|
4024 |
|
4025 <li class="index-item event"> |
|
4026 <a href="#event_sort">sort</a> |
|
4027 |
|
4028 |
|
4029 |
|
4030 </li> |
|
4031 |
|
4032 <li class="index-item event inherited"> |
|
4033 <a href="#event_widget:contentUpdate">widget:contentUpdate</a> |
|
4034 |
|
4035 |
|
4036 |
|
4037 </li> |
|
4038 |
|
4039 </ul> |
|
4040 </div> |
|
4041 |
|
4042 </div> |
|
4043 |
|
4044 |
|
4045 <div id="methods" class="api-class-tabpanel"> |
|
4046 <h2 class="off-left">Methods</h2> |
|
4047 |
|
4048 |
|
4049 <div id="method_@renderUI" class="method item protected inherited"> |
|
4050 <h3 class="name"><code>@renderUI</code></h3> |
|
4051 |
|
4052 |
|
4053 <span class="paren">()</span> |
|
4054 |
|
4055 |
|
4056 |
|
4057 |
|
4058 |
|
4059 |
|
4060 |
|
4061 <span class="flag protected">protected</span> |
|
4062 |
|
4063 |
|
4064 |
|
4065 |
|
4066 |
|
4067 |
|
4068 |
|
4069 |
|
4070 |
|
4071 |
|
4072 <div class="meta"> |
|
4073 |
|
4074 |
|
4075 <p>Inherited from |
|
4076 <a href="../classes/DataTable.Base.html#method_@renderUI">DataTable.Base</a>: |
|
4077 |
|
4078 |
|
4079 |
|
4080 <a href="../files/datatable_js_base.js.html#l425"><code>datatable/js/base.js:425</code></a> |
|
4081 |
|
4082 </p> |
|
4083 |
|
4084 |
|
4085 |
|
4086 |
|
4087 |
|
4088 <p>Available since 3.6.0</p> |
|
4089 |
|
4090 </div> |
|
4091 |
|
4092 <div class="description"> |
|
4093 <p>Instantiates the configured <code>view</code> class that will be responsible for |
|
4094 setting up the View class.</p> |
|
4095 </div> |
|
4096 |
|
4097 |
|
4098 |
|
4099 |
|
4100 |
|
4101 |
|
4102 </div> |
|
4103 |
|
4104 |
|
4105 <div id="method__addAttrs" class="method item private inherited"> |
|
4106 <h3 class="name"><code>_addAttrs</code></h3> |
|
4107 |
|
4108 |
|
4109 <div class="args"> |
|
4110 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4111 |
|
4112 <li class="arg"> |
|
4113 |
|
4114 <code>cfgs</code> |
|
4115 |
|
4116 </li> |
|
4117 |
|
4118 <li class="arg"> |
|
4119 |
|
4120 <code>values</code> |
|
4121 |
|
4122 </li> |
|
4123 |
|
4124 <li class="arg"> |
|
4125 |
|
4126 <code>lazy</code> |
|
4127 |
|
4128 </li> |
|
4129 |
|
4130 </ul><span class="paren">)</span> |
|
4131 </div> |
|
4132 |
|
4133 |
|
4134 |
|
4135 |
|
4136 |
|
4137 |
|
4138 |
|
4139 <span class="flag private">private</span> |
|
4140 |
|
4141 |
|
4142 |
|
4143 |
|
4144 |
|
4145 |
|
4146 |
|
4147 |
|
4148 |
|
4149 |
|
4150 <div class="meta"> |
|
4151 |
|
4152 |
|
4153 <p>Inherited from |
|
4154 <a href="../classes/AttributeCore.html#method__addAttrs">AttributeCore</a>: |
|
4155 |
|
4156 |
|
4157 |
|
4158 <a href="../files/attribute_js_AttributeCore.js.html#l836"><code>attribute/js/AttributeCore.js:836</code></a> |
|
4159 |
|
4160 </p> |
|
4161 |
|
4162 |
|
4163 |
|
4164 |
|
4165 |
|
4166 </div> |
|
4167 |
|
4168 <div class="description"> |
|
4169 <p>Implementation behind the public addAttrs method.</p> |
|
4170 |
|
4171 <p>This method is invoked directly by get if it encounters a scenario |
|
4172 in which an attribute's valueFn attempts to obtain the |
|
4173 value an attribute in the same group of attributes, which has not yet |
|
4174 been added (on demand initialization).</p> |
|
4175 </div> |
|
4176 |
|
4177 |
|
4178 <div class="params"> |
|
4179 <h4>Parameters:</h4> |
|
4180 |
|
4181 <ul class="params-list"> |
|
4182 |
|
4183 <li class="param"> |
|
4184 |
|
4185 <code class="param-name">cfgs</code> |
|
4186 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4187 |
|
4188 |
|
4189 |
|
4190 |
|
4191 <div class="param-description"> |
|
4192 <p>An object with attribute name/configuration pairs.</p> |
|
4193 </div> |
|
4194 |
|
4195 |
|
4196 </li> |
|
4197 |
|
4198 <li class="param"> |
|
4199 |
|
4200 <code class="param-name">values</code> |
|
4201 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4202 |
|
4203 |
|
4204 |
|
4205 |
|
4206 <div class="param-description"> |
|
4207 <p>An object with attribute name/value pairs, defining the initial values to apply. |
|
4208 Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p> |
|
4209 </div> |
|
4210 |
|
4211 |
|
4212 </li> |
|
4213 |
|
4214 <li class="param"> |
|
4215 |
|
4216 <code class="param-name">lazy</code> |
|
4217 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
4218 |
|
4219 |
|
4220 |
|
4221 |
|
4222 <div class="param-description"> |
|
4223 <p>Whether or not to delay the intialization of these attributes until the first call to get/set. |
|
4224 Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. |
|
4225 See <a href="#method_addAttr">addAttr</a>.</p> |
|
4226 </div> |
|
4227 |
|
4228 |
|
4229 </li> |
|
4230 |
|
4231 </ul> |
|
4232 </div> |
|
4233 |
|
4234 |
|
4235 |
|
4236 |
|
4237 |
|
4238 </div> |
|
4239 |
|
4240 |
|
4241 <div id="method__addLazyAttr" class="method item private inherited"> |
|
4242 <h3 class="name"><code>_addLazyAttr</code></h3> |
|
4243 |
|
4244 |
|
4245 <div class="args"> |
|
4246 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4247 |
|
4248 <li class="arg"> |
|
4249 |
|
4250 <code>name</code> |
|
4251 |
|
4252 </li> |
|
4253 |
|
4254 <li class="arg"> |
|
4255 |
|
4256 <code class="optional">[lazyCfg]</code> |
|
4257 |
|
4258 </li> |
|
4259 |
|
4260 </ul><span class="paren">)</span> |
|
4261 </div> |
|
4262 |
|
4263 |
|
4264 |
|
4265 |
|
4266 |
|
4267 |
|
4268 |
|
4269 <span class="flag private">private</span> |
|
4270 |
|
4271 |
|
4272 |
|
4273 |
|
4274 |
|
4275 |
|
4276 |
|
4277 |
|
4278 |
|
4279 |
|
4280 <div class="meta"> |
|
4281 |
|
4282 |
|
4283 <p>Inherited from |
|
4284 <a href="../classes/AttributeCore.html#method__addLazyAttr">AttributeCore</a>: |
|
4285 |
|
4286 |
|
4287 |
|
4288 <a href="../files/attribute_js_AttributeCore.js.html#l382"><code>attribute/js/AttributeCore.js:382</code></a> |
|
4289 |
|
4290 </p> |
|
4291 |
|
4292 |
|
4293 |
|
4294 |
|
4295 |
|
4296 </div> |
|
4297 |
|
4298 <div class="description"> |
|
4299 <p>Finishes initializing an attribute which has been lazily added.</p> |
|
4300 </div> |
|
4301 |
|
4302 |
|
4303 <div class="params"> |
|
4304 <h4>Parameters:</h4> |
|
4305 |
|
4306 <ul class="params-list"> |
|
4307 |
|
4308 <li class="param"> |
|
4309 |
|
4310 <code class="param-name">name</code> |
|
4311 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4312 |
|
4313 |
|
4314 |
|
4315 |
|
4316 <div class="param-description"> |
|
4317 <p>The name of the attribute</p> |
|
4318 </div> |
|
4319 |
|
4320 |
|
4321 </li> |
|
4322 |
|
4323 <li class="param"> |
|
4324 |
|
4325 <code class="param-name optional">[lazyCfg]</code> |
|
4326 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4327 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
4328 |
|
4329 |
|
4330 |
|
4331 |
|
4332 <div class="param-description"> |
|
4333 <p>Optional config hash for the attribute. This is added for performance |
|
4334 along the critical path, where the calling method has already obtained lazy config from state.</p> |
|
4335 </div> |
|
4336 |
|
4337 |
|
4338 </li> |
|
4339 |
|
4340 </ul> |
|
4341 </div> |
|
4342 |
|
4343 |
|
4344 |
|
4345 |
|
4346 |
|
4347 </div> |
|
4348 |
|
4349 |
|
4350 <div id="method__addScrollbarPadding" class="method item protected"> |
|
4351 <h3 class="name"><code>_addScrollbarPadding</code></h3> |
|
4352 |
|
4353 |
|
4354 <span class="paren">()</span> |
|
4355 |
|
4356 |
|
4357 |
|
4358 |
|
4359 |
|
4360 |
|
4361 |
|
4362 <span class="flag protected">protected</span> |
|
4363 |
|
4364 |
|
4365 |
|
4366 |
|
4367 |
|
4368 |
|
4369 |
|
4370 |
|
4371 |
|
4372 |
|
4373 <div class="meta"> |
|
4374 |
|
4375 |
|
4376 |
|
4377 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
4378 |
|
4379 <p> |
|
4380 |
|
4381 Defined in |
|
4382 |
|
4383 |
|
4384 |
|
4385 |
|
4386 <a href="../files/datatable_js_scroll.js.html#l193"><code>datatable/js/scroll.js:193</code></a> |
|
4387 |
|
4388 </p> |
|
4389 |
|
4390 |
|
4391 |
|
4392 |
|
4393 |
|
4394 <p>Available since 3.5.0</p> |
|
4395 |
|
4396 </div> |
|
4397 |
|
4398 <div class="description"> |
|
4399 <p>Adds padding to the last cells in the fixed header for vertically scrolling |
|
4400 tables. This padding is equal in width to the scrollbar, so can't be |
|
4401 relegated to a stylesheet.</p> |
|
4402 </div> |
|
4403 |
|
4404 |
|
4405 |
|
4406 |
|
4407 |
|
4408 |
|
4409 </div> |
|
4410 |
|
4411 |
|
4412 <div id="method__afterChildSelectedChange" class="method item protected inherited"> |
|
4413 <h3 class="name"><code>_afterChildSelectedChange</code></h3> |
|
4414 |
|
4415 |
|
4416 <div class="args"> |
|
4417 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4418 |
|
4419 <li class="arg"> |
|
4420 |
|
4421 <code>event</code> |
|
4422 |
|
4423 </li> |
|
4424 |
|
4425 </ul><span class="paren">)</span> |
|
4426 </div> |
|
4427 |
|
4428 |
|
4429 |
|
4430 |
|
4431 |
|
4432 |
|
4433 |
|
4434 <span class="flag protected">protected</span> |
|
4435 |
|
4436 |
|
4437 |
|
4438 |
|
4439 |
|
4440 |
|
4441 |
|
4442 |
|
4443 |
|
4444 |
|
4445 <div class="meta"> |
|
4446 |
|
4447 |
|
4448 <p>Inherited from |
|
4449 <a href="../classes/Widget.html#method__afterChildSelectedChange">Widget</a>: |
|
4450 |
|
4451 |
|
4452 |
|
4453 <a href="../files/widget-child_js_Widget-Child.js.html#l327"><code>widget-child/js/Widget-Child.js:327</code></a> |
|
4454 |
|
4455 </p> |
|
4456 |
|
4457 |
|
4458 |
|
4459 |
|
4460 |
|
4461 </div> |
|
4462 |
|
4463 <div class="description"> |
|
4464 <p>Default attribute change listener for the <code>selected</code> |
|
4465 attribute, responsible for updating the UI, in response to |
|
4466 attribute changes.</p> |
|
4467 </div> |
|
4468 |
|
4469 |
|
4470 <div class="params"> |
|
4471 <h4>Parameters:</h4> |
|
4472 |
|
4473 <ul class="params-list"> |
|
4474 |
|
4475 <li class="param"> |
|
4476 |
|
4477 <code class="param-name">event</code> |
|
4478 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4479 |
|
4480 |
|
4481 |
|
4482 |
|
4483 <div class="param-description"> |
|
4484 <p>The event facade for the attribute change.</p> |
|
4485 </div> |
|
4486 |
|
4487 |
|
4488 </li> |
|
4489 |
|
4490 </ul> |
|
4491 </div> |
|
4492 |
|
4493 |
|
4494 |
|
4495 |
|
4496 |
|
4497 </div> |
|
4498 |
|
4499 |
|
4500 <div id="method__afterColumnsChange" class="method item protected"> |
|
4501 <h3 class="name"><code>_afterColumnsChange</code></h3> |
|
4502 |
|
4503 |
|
4504 <div class="args"> |
|
4505 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4506 |
|
4507 <li class="arg"> |
|
4508 |
|
4509 <code>e</code> |
|
4510 |
|
4511 </li> |
|
4512 |
|
4513 </ul><span class="paren">)</span> |
|
4514 </div> |
|
4515 |
|
4516 |
|
4517 |
|
4518 |
|
4519 |
|
4520 |
|
4521 |
|
4522 <span class="flag protected">protected</span> |
|
4523 |
|
4524 |
|
4525 |
|
4526 |
|
4527 |
|
4528 |
|
4529 |
|
4530 |
|
4531 |
|
4532 |
|
4533 <div class="meta"> |
|
4534 |
|
4535 |
|
4536 |
|
4537 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
4538 |
|
4539 <p> |
|
4540 |
|
4541 Defined in |
|
4542 |
|
4543 |
|
4544 |
|
4545 |
|
4546 <a href="../files/datatable_js_core.js.html#l333"><code>datatable/js/core.js:333</code></a> |
|
4547 |
|
4548 </p> |
|
4549 |
|
4550 |
|
4551 |
|
4552 |
|
4553 |
|
4554 <p>Available since 3.5.0</p> |
|
4555 |
|
4556 </div> |
|
4557 |
|
4558 <div class="description"> |
|
4559 <p>Updates the <code>_columnMap</code> property in response to changes in the <code>columns</code> |
|
4560 attribute.</p> |
|
4561 </div> |
|
4562 |
|
4563 |
|
4564 <div class="params"> |
|
4565 <h4>Parameters:</h4> |
|
4566 |
|
4567 <ul class="params-list"> |
|
4568 |
|
4569 <li class="param"> |
|
4570 |
|
4571 <code class="param-name">e</code> |
|
4572 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4573 |
|
4574 |
|
4575 |
|
4576 |
|
4577 <div class="param-description"> |
|
4578 <p>The <code>columnsChange</code> event object</p> |
|
4579 </div> |
|
4580 |
|
4581 |
|
4582 </li> |
|
4583 |
|
4584 </ul> |
|
4585 </div> |
|
4586 |
|
4587 |
|
4588 |
|
4589 |
|
4590 |
|
4591 </div> |
|
4592 |
|
4593 |
|
4594 <div id="method__afterDataChange" class="method item protected"> |
|
4595 <h3 class="name"><code>_afterDataChange</code></h3> |
|
4596 |
|
4597 |
|
4598 <div class="args"> |
|
4599 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4600 |
|
4601 <li class="arg"> |
|
4602 |
|
4603 <code>e</code> |
|
4604 |
|
4605 </li> |
|
4606 |
|
4607 </ul><span class="paren">)</span> |
|
4608 </div> |
|
4609 |
|
4610 |
|
4611 |
|
4612 |
|
4613 |
|
4614 |
|
4615 |
|
4616 <span class="flag protected">protected</span> |
|
4617 |
|
4618 |
|
4619 |
|
4620 |
|
4621 |
|
4622 |
|
4623 |
|
4624 |
|
4625 |
|
4626 |
|
4627 <div class="meta"> |
|
4628 |
|
4629 |
|
4630 |
|
4631 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
4632 |
|
4633 <p> |
|
4634 |
|
4635 Defined in |
|
4636 |
|
4637 |
|
4638 |
|
4639 |
|
4640 <a href="../files/datatable_js_core.js.html#l346"><code>datatable/js/core.js:346</code></a> |
|
4641 |
|
4642 </p> |
|
4643 |
|
4644 |
|
4645 |
|
4646 |
|
4647 |
|
4648 <p>Available since 3.5.0</p> |
|
4649 |
|
4650 </div> |
|
4651 |
|
4652 <div class="description"> |
|
4653 <p>Updates the <code>modelList</code> attributes of the rendered views in response to the |
|
4654 <code>data</code> attribute being assigned a new ModelList.</p> |
|
4655 </div> |
|
4656 |
|
4657 |
|
4658 <div class="params"> |
|
4659 <h4>Parameters:</h4> |
|
4660 |
|
4661 <ul class="params-list"> |
|
4662 |
|
4663 <li class="param"> |
|
4664 |
|
4665 <code class="param-name">e</code> |
|
4666 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4667 |
|
4668 |
|
4669 |
|
4670 |
|
4671 <div class="param-description"> |
|
4672 <p>the <code>dataChange</code> event</p> |
|
4673 </div> |
|
4674 |
|
4675 |
|
4676 </li> |
|
4677 |
|
4678 </ul> |
|
4679 </div> |
|
4680 |
|
4681 |
|
4682 |
|
4683 |
|
4684 |
|
4685 </div> |
|
4686 |
|
4687 |
|
4688 <div id="method__afterDisplayColumnsChange" class="method item protected inherited"> |
|
4689 <h3 class="name"><code>_afterDisplayColumnsChange</code></h3> |
|
4690 |
|
4691 |
|
4692 <div class="args"> |
|
4693 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4694 |
|
4695 <li class="arg"> |
|
4696 |
|
4697 <code>e</code> |
|
4698 |
|
4699 </li> |
|
4700 |
|
4701 </ul><span class="paren">)</span> |
|
4702 </div> |
|
4703 |
|
4704 |
|
4705 |
|
4706 |
|
4707 |
|
4708 |
|
4709 |
|
4710 <span class="flag protected">protected</span> |
|
4711 |
|
4712 |
|
4713 |
|
4714 |
|
4715 |
|
4716 |
|
4717 |
|
4718 |
|
4719 |
|
4720 |
|
4721 <div class="meta"> |
|
4722 |
|
4723 |
|
4724 <p>Inherited from |
|
4725 <a href="../classes/DataTable.Base.html#method__afterDisplayColumnsChange">DataTable.Base</a>: |
|
4726 |
|
4727 |
|
4728 |
|
4729 <a href="../files/datatable_js_base.js.html#l305"><code>datatable/js/base.js:305</code></a> |
|
4730 |
|
4731 </p> |
|
4732 |
|
4733 |
|
4734 |
|
4735 |
|
4736 |
|
4737 <p>Available since 3.6.0</p> |
|
4738 |
|
4739 </div> |
|
4740 |
|
4741 <div class="description"> |
|
4742 <p>Updates the <code>_displayColumns</code> property.</p> |
|
4743 </div> |
|
4744 |
|
4745 |
|
4746 <div class="params"> |
|
4747 <h4>Parameters:</h4> |
|
4748 |
|
4749 <ul class="params-list"> |
|
4750 |
|
4751 <li class="param"> |
|
4752 |
|
4753 <code class="param-name">e</code> |
|
4754 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4755 |
|
4756 |
|
4757 |
|
4758 |
|
4759 <div class="param-description"> |
|
4760 <p>The <code>columnsChange</code> event</p> |
|
4761 </div> |
|
4762 |
|
4763 |
|
4764 </li> |
|
4765 |
|
4766 </ul> |
|
4767 </div> |
|
4768 |
|
4769 |
|
4770 |
|
4771 |
|
4772 |
|
4773 </div> |
|
4774 |
|
4775 |
|
4776 <div id="method__afterMessageColumnsChange" class="method item protected"> |
|
4777 <h3 class="name"><code>_afterMessageColumnsChange</code></h3> |
|
4778 |
|
4779 |
|
4780 <div class="args"> |
|
4781 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4782 |
|
4783 <li class="arg"> |
|
4784 |
|
4785 <code>e</code> |
|
4786 |
|
4787 </li> |
|
4788 |
|
4789 </ul><span class="paren">)</span> |
|
4790 </div> |
|
4791 |
|
4792 |
|
4793 |
|
4794 |
|
4795 |
|
4796 |
|
4797 |
|
4798 <span class="flag protected">protected</span> |
|
4799 |
|
4800 |
|
4801 |
|
4802 |
|
4803 |
|
4804 |
|
4805 |
|
4806 |
|
4807 |
|
4808 |
|
4809 <div class="meta"> |
|
4810 |
|
4811 |
|
4812 |
|
4813 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
4814 |
|
4815 <p> |
|
4816 |
|
4817 Defined in |
|
4818 |
|
4819 |
|
4820 |
|
4821 |
|
4822 <a href="../files/datatable_js_message.js.html#l110"><code>datatable/js/message.js:110</code></a> |
|
4823 |
|
4824 </p> |
|
4825 |
|
4826 |
|
4827 |
|
4828 |
|
4829 |
|
4830 <p>Available since 3.5.0</p> |
|
4831 |
|
4832 </div> |
|
4833 |
|
4834 <div class="description"> |
|
4835 <p>Updates the colspan of the <code><td></code> used to display the messages.</p> |
|
4836 </div> |
|
4837 |
|
4838 |
|
4839 <div class="params"> |
|
4840 <h4>Parameters:</h4> |
|
4841 |
|
4842 <ul class="params-list"> |
|
4843 |
|
4844 <li class="param"> |
|
4845 |
|
4846 <code class="param-name">e</code> |
|
4847 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4848 |
|
4849 |
|
4850 |
|
4851 |
|
4852 <div class="param-description"> |
|
4853 <p>The columnsChange event</p> |
|
4854 </div> |
|
4855 |
|
4856 |
|
4857 </li> |
|
4858 |
|
4859 </ul> |
|
4860 </div> |
|
4861 |
|
4862 |
|
4863 |
|
4864 |
|
4865 |
|
4866 </div> |
|
4867 |
|
4868 |
|
4869 <div id="method__afterMessageDataChange" class="method item protected"> |
|
4870 <h3 class="name"><code>_afterMessageDataChange</code></h3> |
|
4871 |
|
4872 |
|
4873 <div class="args"> |
|
4874 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4875 |
|
4876 <li class="arg"> |
|
4877 |
|
4878 <code>e</code> |
|
4879 |
|
4880 </li> |
|
4881 |
|
4882 </ul><span class="paren">)</span> |
|
4883 </div> |
|
4884 |
|
4885 |
|
4886 |
|
4887 |
|
4888 |
|
4889 |
|
4890 |
|
4891 <span class="flag protected">protected</span> |
|
4892 |
|
4893 |
|
4894 |
|
4895 |
|
4896 |
|
4897 |
|
4898 |
|
4899 |
|
4900 |
|
4901 |
|
4902 <div class="meta"> |
|
4903 |
|
4904 |
|
4905 |
|
4906 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
4907 |
|
4908 <p> |
|
4909 |
|
4910 Defined in |
|
4911 |
|
4912 |
|
4913 |
|
4914 |
|
4915 <a href="../files/datatable_js_message.js.html#l133"><code>datatable/js/message.js:133</code></a> |
|
4916 |
|
4917 </p> |
|
4918 |
|
4919 |
|
4920 |
|
4921 |
|
4922 |
|
4923 <p>Available since 3.5.0</p> |
|
4924 |
|
4925 </div> |
|
4926 |
|
4927 <div class="description"> |
|
4928 <p>Relays to <code>_uiSetMessage</code> to hide or show the message node.</p> |
|
4929 </div> |
|
4930 |
|
4931 |
|
4932 <div class="params"> |
|
4933 <h4>Parameters:</h4> |
|
4934 |
|
4935 <ul class="params-list"> |
|
4936 |
|
4937 <li class="param"> |
|
4938 |
|
4939 <code class="param-name">e</code> |
|
4940 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4941 |
|
4942 |
|
4943 |
|
4944 |
|
4945 <div class="param-description"> |
|
4946 <p>The dataChange event</p> |
|
4947 </div> |
|
4948 |
|
4949 |
|
4950 </li> |
|
4951 |
|
4952 </ul> |
|
4953 </div> |
|
4954 |
|
4955 |
|
4956 |
|
4957 |
|
4958 |
|
4959 </div> |
|
4960 |
|
4961 |
|
4962 <div id="method__afterRecordTypeChange" class="method item protected"> |
|
4963 <h3 class="name"><code>_afterRecordTypeChange</code></h3> |
|
4964 |
|
4965 |
|
4966 <div class="args"> |
|
4967 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4968 |
|
4969 <li class="arg"> |
|
4970 |
|
4971 <code>e</code> |
|
4972 |
|
4973 </li> |
|
4974 |
|
4975 </ul><span class="paren">)</span> |
|
4976 </div> |
|
4977 |
|
4978 |
|
4979 |
|
4980 |
|
4981 |
|
4982 |
|
4983 |
|
4984 <span class="flag protected">protected</span> |
|
4985 |
|
4986 |
|
4987 |
|
4988 |
|
4989 |
|
4990 |
|
4991 |
|
4992 |
|
4993 |
|
4994 |
|
4995 <div class="meta"> |
|
4996 |
|
4997 |
|
4998 |
|
4999 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
5000 |
|
5001 <p> |
|
5002 |
|
5003 Defined in |
|
5004 |
|
5005 |
|
5006 |
|
5007 |
|
5008 <a href="../files/datatable_js_core.js.html#l367"><code>datatable/js/core.js:367</code></a> |
|
5009 |
|
5010 </p> |
|
5011 |
|
5012 |
|
5013 |
|
5014 |
|
5015 |
|
5016 <p>Available since 3.6.0</p> |
|
5017 |
|
5018 </div> |
|
5019 |
|
5020 <div class="description"> |
|
5021 <p>Assigns to the new recordType as the model for the data ModelList</p> |
|
5022 </div> |
|
5023 |
|
5024 |
|
5025 <div class="params"> |
|
5026 <h4>Parameters:</h4> |
|
5027 |
|
5028 <ul class="params-list"> |
|
5029 |
|
5030 <li class="param"> |
|
5031 |
|
5032 <code class="param-name">e</code> |
|
5033 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
5034 |
|
5035 |
|
5036 |
|
5037 |
|
5038 <div class="param-description"> |
|
5039 <p>recordTypeChange event</p> |
|
5040 </div> |
|
5041 |
|
5042 |
|
5043 </li> |
|
5044 |
|
5045 </ul> |
|
5046 </div> |
|
5047 |
|
5048 |
|
5049 |
|
5050 |
|
5051 |
|
5052 </div> |
|
5053 |
|
5054 |
|
5055 <div id="method__afterScrollableChange" class="method item protected"> |
|
5056 <h3 class="name"><code>_afterScrollableChange</code></h3> |
|
5057 |
|
5058 |
|
5059 <div class="args"> |
|
5060 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5061 |
|
5062 <li class="arg"> |
|
5063 |
|
5064 <code>e</code> |
|
5065 |
|
5066 </li> |
|
5067 |
|
5068 </ul><span class="paren">)</span> |
|
5069 </div> |
|
5070 |
|
5071 |
|
5072 |
|
5073 |
|
5074 |
|
5075 |
|
5076 |
|
5077 <span class="flag protected">protected</span> |
|
5078 |
|
5079 |
|
5080 |
|
5081 |
|
5082 |
|
5083 |
|
5084 |
|
5085 |
|
5086 |
|
5087 |
|
5088 <div class="meta"> |
|
5089 |
|
5090 |
|
5091 |
|
5092 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
5093 |
|
5094 <p> |
|
5095 |
|
5096 Defined in |
|
5097 |
|
5098 |
|
5099 |
|
5100 |
|
5101 <a href="../files/datatable_js_scroll.js.html#l218"><code>datatable/js/scroll.js:218</code></a> |
|
5102 |
|
5103 </p> |
|
5104 |
|
5105 |
|
5106 |
|
5107 |
|
5108 |
|
5109 <p>Available since 3.5.0</p> |
|
5110 |
|
5111 </div> |
|
5112 |
|
5113 <div class="description"> |
|
5114 <p>Reacts to changes in the <code>scrollable</code> attribute by updating the <code>_xScroll</code> |
|
5115 and <code>_yScroll</code> properties and syncing the scrolling structure accordingly.</p> |
|
5116 </div> |
|
5117 |
|
5118 |
|
5119 <div class="params"> |
|
5120 <h4>Parameters:</h4> |
|
5121 |
|
5122 <ul class="params-list"> |
|
5123 |
|
5124 <li class="param"> |
|
5125 |
|
5126 <code class="param-name">e</code> |
|
5127 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
5128 |
|
5129 |
|
5130 |
|
5131 |
|
5132 <div class="param-description"> |
|
5133 <p>The relevant change event (ignored)</p> |
|
5134 </div> |
|
5135 |
|
5136 |
|
5137 </li> |
|
5138 |
|
5139 </ul> |
|
5140 </div> |
|
5141 |
|
5142 |
|
5143 |
|
5144 |
|
5145 |
|
5146 </div> |
|
5147 |
|
5148 |
|
5149 <div id="method__afterScrollCaptionChange" class="method item protected"> |
|
5150 <h3 class="name"><code>_afterScrollCaptionChange</code></h3> |
|
5151 |
|
5152 |
|
5153 <div class="args"> |
|
5154 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5155 |
|
5156 <li class="arg"> |
|
5157 |
|
5158 <code>e</code> |
|
5159 |
|
5160 </li> |
|
5161 |
|
5162 </ul><span class="paren">)</span> |
|
5163 </div> |
|
5164 |
|
5165 |
|
5166 |
|
5167 |
|
5168 |
|
5169 |
|
5170 |
|
5171 <span class="flag protected">protected</span> |
|
5172 |
|
5173 |
|
5174 |
|
5175 |
|
5176 |
|
5177 |
|
5178 |
|
5179 |
|
5180 |
|
5181 |
|
5182 <div class="meta"> |
|
5183 |
|
5184 |
|
5185 |
|
5186 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
5187 |
|
5188 <p> |
|
5189 |
|
5190 Defined in |
|
5191 |
|
5192 |
|
5193 |
|
5194 |
|
5195 <a href="../files/datatable_js_scroll.js.html#l242"><code>datatable/js/scroll.js:242</code></a> |
|
5196 |
|
5197 </p> |
|
5198 |
|
5199 |
|
5200 |
|
5201 |
|
5202 |
|
5203 <p>Available since 3.5.0</p> |
|
5204 |
|
5205 </div> |
|
5206 |
|
5207 <div class="description"> |
|
5208 <p>Reacts to changes in the <code>caption</code> attribute by adding, removing, or |
|
5209 syncing the caption table when the table is set to scroll.</p> |
|
5210 </div> |
|
5211 |
|
5212 |
|
5213 <div class="params"> |
|
5214 <h4>Parameters:</h4> |
|
5215 |
|
5216 <ul class="params-list"> |
|
5217 |
|
5218 <li class="param"> |
|
5219 |
|
5220 <code class="param-name">e</code> |
|
5221 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
5222 |
|
5223 |
|
5224 |
|
5225 |
|
5226 <div class="param-description"> |
|
5227 <p>The relevant change event (ignored)</p> |
|
5228 </div> |
|
5229 |
|
5230 |
|
5231 </li> |
|
5232 |
|
5233 </ul> |
|
5234 </div> |
|
5235 |
|
5236 |
|
5237 |
|
5238 |
|
5239 |
|
5240 </div> |
|
5241 |
|
5242 |
|
5243 <div id="method__afterScrollColumnsChange" class="method item protected"> |
|
5244 <h3 class="name"><code>_afterScrollColumnsChange</code></h3> |
|
5245 |
|
5246 |
|
5247 <div class="args"> |
|
5248 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5249 |
|
5250 <li class="arg"> |
|
5251 |
|
5252 <code>e</code> |
|
5253 |
|
5254 </li> |
|
5255 |
|
5256 </ul><span class="paren">)</span> |
|
5257 </div> |
|
5258 |
|
5259 |
|
5260 |
|
5261 |
|
5262 |
|
5263 |
|
5264 |
|
5265 <span class="flag protected">protected</span> |
|
5266 |
|
5267 |
|
5268 |
|
5269 |
|
5270 |
|
5271 |
|
5272 |
|
5273 |
|
5274 |
|
5275 |
|
5276 <div class="meta"> |
|
5277 |
|
5278 |
|
5279 |
|
5280 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
5281 |
|
5282 <p> |
|
5283 |
|
5284 Defined in |
|
5285 |
|
5286 |
|
5287 |
|
5288 |
|
5289 <a href="../files/datatable_js_scroll.js.html#l257"><code>datatable/js/scroll.js:257</code></a> |
|
5290 |
|
5291 </p> |
|
5292 |
|
5293 |
|
5294 |
|
5295 |
|
5296 |
|
5297 <p>Available since 3.5.0</p> |
|
5298 |
|
5299 </div> |
|
5300 |
|
5301 <div class="description"> |
|
5302 <p>Reacts to changes in the <code>columns</code> attribute of vertically scrolling tables |
|
5303 by refreshing the fixed headers, scroll container, and virtual scrollbar |
|
5304 position.</p> |
|
5305 </div> |
|
5306 |
|
5307 |
|
5308 <div class="params"> |
|
5309 <h4>Parameters:</h4> |
|
5310 |
|
5311 <ul class="params-list"> |
|
5312 |
|
5313 <li class="param"> |
|
5314 |
|
5315 <code class="param-name">e</code> |
|
5316 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
5317 |
|
5318 |
|
5319 |
|
5320 |
|
5321 <div class="param-description"> |
|
5322 <p>The relevant change event (ignored)</p> |
|
5323 </div> |
|
5324 |
|
5325 |
|
5326 </li> |
|
5327 |
|
5328 </ul> |
|
5329 </div> |
|
5330 |
|
5331 |
|
5332 |
|
5333 |
|
5334 |
|
5335 </div> |
|
5336 |
|
5337 |
|
5338 <div id="method__afterScrollDataChange" class="method item protected"> |
|
5339 <h3 class="name"><code>_afterScrollDataChange</code></h3> |
|
5340 |
|
5341 |
|
5342 <div class="args"> |
|
5343 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5344 |
|
5345 <li class="arg"> |
|
5346 |
|
5347 <code>e</code> |
|
5348 |
|
5349 </li> |
|
5350 |
|
5351 </ul><span class="paren">)</span> |
|
5352 </div> |
|
5353 |
|
5354 |
|
5355 |
|
5356 |
|
5357 |
|
5358 |
|
5359 |
|
5360 <span class="flag protected">protected</span> |
|
5361 |
|
5362 |
|
5363 |
|
5364 |
|
5365 |
|
5366 |
|
5367 |
|
5368 |
|
5369 |
|
5370 |
|
5371 <div class="meta"> |
|
5372 |
|
5373 |
|
5374 |
|
5375 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
5376 |
|
5377 <p> |
|
5378 |
|
5379 Defined in |
|
5380 |
|
5381 |
|
5382 |
|
5383 |
|
5384 <a href="../files/datatable_js_scroll.js.html#l277"><code>datatable/js/scroll.js:277</code></a> |
|
5385 |
|
5386 </p> |
|
5387 |
|
5388 |
|
5389 |
|
5390 |
|
5391 |
|
5392 <p>Available since 3.5.0</p> |
|
5393 |
|
5394 </div> |
|
5395 |
|
5396 <div class="description"> |
|
5397 <p>Reacts to changes in vertically scrolling table's <code>data</code> ModelList by |
|
5398 synchronizing the fixed column header widths and virtual scrollbar height.</p> |
|
5399 </div> |
|
5400 |
|
5401 |
|
5402 <div class="params"> |
|
5403 <h4>Parameters:</h4> |
|
5404 |
|
5405 <ul class="params-list"> |
|
5406 |
|
5407 <li class="param"> |
|
5408 |
|
5409 <code class="param-name">e</code> |
|
5410 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
5411 |
|
5412 |
|
5413 |
|
5414 |
|
5415 <div class="param-description"> |
|
5416 <p>The relevant change event (ignored)</p> |
|
5417 </div> |
|
5418 |
|
5419 |
|
5420 </li> |
|
5421 |
|
5422 </ul> |
|
5423 </div> |
|
5424 |
|
5425 |
|
5426 |
|
5427 |
|
5428 |
|
5429 </div> |
|
5430 |
|
5431 |
|
5432 <div id="method__afterScrollHeightChange" class="method item protected"> |
|
5433 <h3 class="name"><code>_afterScrollHeightChange</code></h3> |
|
5434 |
|
5435 |
|
5436 <div class="args"> |
|
5437 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5438 |
|
5439 <li class="arg"> |
|
5440 |
|
5441 <code>e</code> |
|
5442 |
|
5443 </li> |
|
5444 |
|
5445 </ul><span class="paren">)</span> |
|
5446 </div> |
|
5447 |
|
5448 |
|
5449 |
|
5450 |
|
5451 |
|
5452 |
|
5453 |
|
5454 <span class="flag protected">protected</span> |
|
5455 |
|
5456 |
|
5457 |
|
5458 |
|
5459 |
|
5460 |
|
5461 |
|
5462 |
|
5463 |
|
5464 |
|
5465 <div class="meta"> |
|
5466 |
|
5467 |
|
5468 |
|
5469 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
5470 |
|
5471 <p> |
|
5472 |
|
5473 Defined in |
|
5474 |
|
5475 |
|
5476 |
|
5477 |
|
5478 <a href="../files/datatable_js_scroll.js.html#l292"><code>datatable/js/scroll.js:292</code></a> |
|
5479 |
|
5480 </p> |
|
5481 |
|
5482 |
|
5483 |
|
5484 |
|
5485 |
|
5486 <p>Available since 3.5.0</p> |
|
5487 |
|
5488 </div> |
|
5489 |
|
5490 <div class="description"> |
|
5491 <p>Reacts to changes in the <code>height</code> attribute of vertically scrolling tables |
|
5492 by updating the height of the <code><div></code> wrapping the data table and the |
|
5493 virtual scrollbar. If <code>scrollable</code> was set to "y" or "xy" but lacking a |
|
5494 declared <code>height</code> until the received change, <code>_syncScrollUI</code> is called to |
|
5495 create the fixed headers etc.</p> |
|
5496 </div> |
|
5497 |
|
5498 |
|
5499 <div class="params"> |
|
5500 <h4>Parameters:</h4> |
|
5501 |
|
5502 <ul class="params-list"> |
|
5503 |
|
5504 <li class="param"> |
|
5505 |
|
5506 <code class="param-name">e</code> |
|
5507 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
5508 |
|
5509 |
|
5510 |
|
5511 |
|
5512 <div class="param-description"> |
|
5513 <p>The relevant change event (ignored)</p> |
|
5514 </div> |
|
5515 |
|
5516 |
|
5517 </li> |
|
5518 |
|
5519 </ul> |
|
5520 </div> |
|
5521 |
|
5522 |
|
5523 |
|
5524 |
|
5525 |
|
5526 </div> |
|
5527 |
|
5528 |
|
5529 <div id="method__afterScrollWidthChange" class="method item protected"> |
|
5530 <h3 class="name"><code>_afterScrollWidthChange</code></h3> |
|
5531 |
|
5532 |
|
5533 <div class="args"> |
|
5534 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5535 |
|
5536 <li class="arg"> |
|
5537 |
|
5538 <code>e</code> |
|
5539 |
|
5540 </li> |
|
5541 |
|
5542 </ul><span class="paren">)</span> |
|
5543 </div> |
|
5544 |
|
5545 |
|
5546 |
|
5547 |
|
5548 |
|
5549 |
|
5550 |
|
5551 <span class="flag protected">protected</span> |
|
5552 |
|
5553 |
|
5554 |
|
5555 |
|
5556 |
|
5557 |
|
5558 |
|
5559 |
|
5560 |
|
5561 |
|
5562 <div class="meta"> |
|
5563 |
|
5564 |
|
5565 |
|
5566 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
5567 |
|
5568 <p> |
|
5569 |
|
5570 Defined in |
|
5571 |
|
5572 |
|
5573 |
|
5574 |
|
5575 <a href="../files/datatable_js_scroll.js.html#l331"><code>datatable/js/scroll.js:331</code></a> |
|
5576 |
|
5577 </p> |
|
5578 |
|
5579 |
|
5580 |
|
5581 |
|
5582 |
|
5583 <p>Available since 3.5.0</p> |
|
5584 |
|
5585 </div> |
|
5586 |
|
5587 <div class="description"> |
|
5588 <p>Reacts to changes in the width of scrolling tables by expanding the width of |
|
5589 the <code><div></code> wrapping the data table for horizontally scrolling tables or |
|
5590 upding the position of the virtual scrollbar for vertically scrolling |
|
5591 tables.</p> |
|
5592 </div> |
|
5593 |
|
5594 |
|
5595 <div class="params"> |
|
5596 <h4>Parameters:</h4> |
|
5597 |
|
5598 <ul class="params-list"> |
|
5599 |
|
5600 <li class="param"> |
|
5601 |
|
5602 <code class="param-name">e</code> |
|
5603 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
5604 |
|
5605 |
|
5606 |
|
5607 |
|
5608 <div class="param-description"> |
|
5609 <p>The relevant change event (ignored)</p> |
|
5610 </div> |
|
5611 |
|
5612 |
|
5613 </li> |
|
5614 |
|
5615 </ul> |
|
5616 </div> |
|
5617 |
|
5618 |
|
5619 |
|
5620 |
|
5621 |
|
5622 </div> |
|
5623 |
|
5624 |
|
5625 <div id="method__afterShowMessagesChange" class="method item protected"> |
|
5626 <h3 class="name"><code>_afterShowMessagesChange</code></h3> |
|
5627 |
|
5628 |
|
5629 <div class="args"> |
|
5630 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5631 |
|
5632 <li class="arg"> |
|
5633 |
|
5634 <code>e</code> |
|
5635 |
|
5636 </li> |
|
5637 |
|
5638 </ul><span class="paren">)</span> |
|
5639 </div> |
|
5640 |
|
5641 |
|
5642 |
|
5643 |
|
5644 |
|
5645 |
|
5646 |
|
5647 <span class="flag protected">protected</span> |
|
5648 |
|
5649 |
|
5650 |
|
5651 |
|
5652 |
|
5653 |
|
5654 |
|
5655 |
|
5656 |
|
5657 |
|
5658 <div class="meta"> |
|
5659 |
|
5660 |
|
5661 |
|
5662 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
5663 |
|
5664 <p> |
|
5665 |
|
5666 Defined in |
|
5667 |
|
5668 |
|
5669 |
|
5670 |
|
5671 <a href="../files/datatable_js_message.js.html#l145"><code>datatable/js/message.js:145</code></a> |
|
5672 |
|
5673 </p> |
|
5674 |
|
5675 |
|
5676 |
|
5677 |
|
5678 |
|
5679 <p>Available since 3.5.0</p> |
|
5680 |
|
5681 </div> |
|
5682 |
|
5683 <div class="description"> |
|
5684 <p>Removes the message node if <code>showMessages</code> is <code>false</code>, or relays to |
|
5685 <code>_uiSetMessage</code> if <code>true</code>.</p> |
|
5686 </div> |
|
5687 |
|
5688 |
|
5689 <div class="params"> |
|
5690 <h4>Parameters:</h4> |
|
5691 |
|
5692 <ul class="params-list"> |
|
5693 |
|
5694 <li class="param"> |
|
5695 |
|
5696 <code class="param-name">e</code> |
|
5697 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
5698 |
|
5699 |
|
5700 |
|
5701 |
|
5702 <div class="param-description"> |
|
5703 <p>The showMessagesChange event</p> |
|
5704 </div> |
|
5705 |
|
5706 |
|
5707 </li> |
|
5708 |
|
5709 </ul> |
|
5710 </div> |
|
5711 |
|
5712 |
|
5713 |
|
5714 |
|
5715 |
|
5716 </div> |
|
5717 |
|
5718 |
|
5719 <div id="method__afterSortByChange" class="method item protected"> |
|
5720 <h3 class="name"><code>_afterSortByChange</code></h3> |
|
5721 |
|
5722 |
|
5723 <div class="args"> |
|
5724 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5725 |
|
5726 <li class="arg"> |
|
5727 |
|
5728 <code>e</code> |
|
5729 |
|
5730 </li> |
|
5731 |
|
5732 </ul><span class="paren">)</span> |
|
5733 </div> |
|
5734 |
|
5735 |
|
5736 |
|
5737 |
|
5738 |
|
5739 |
|
5740 |
|
5741 <span class="flag protected">protected</span> |
|
5742 |
|
5743 |
|
5744 |
|
5745 |
|
5746 |
|
5747 |
|
5748 |
|
5749 |
|
5750 |
|
5751 |
|
5752 <div class="meta"> |
|
5753 |
|
5754 |
|
5755 |
|
5756 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
5757 |
|
5758 <p> |
|
5759 |
|
5760 Defined in |
|
5761 |
|
5762 |
|
5763 |
|
5764 |
|
5765 <a href="../files/datatable_js_sort.js.html#l288"><code>datatable/js/sort.js:288</code></a> |
|
5766 |
|
5767 </p> |
|
5768 |
|
5769 |
|
5770 |
|
5771 |
|
5772 |
|
5773 <p>Available since 3.5.0</p> |
|
5774 |
|
5775 </div> |
|
5776 |
|
5777 <div class="description"> |
|
5778 <p>Sorts the <code>data</code> ModelList based on the new <code>sortBy</code> configuration.</p> |
|
5779 </div> |
|
5780 |
|
5781 |
|
5782 <div class="params"> |
|
5783 <h4>Parameters:</h4> |
|
5784 |
|
5785 <ul class="params-list"> |
|
5786 |
|
5787 <li class="param"> |
|
5788 |
|
5789 <code class="param-name">e</code> |
|
5790 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
5791 |
|
5792 |
|
5793 |
|
5794 |
|
5795 <div class="param-description"> |
|
5796 <p>The <code>sortByChange</code> event</p> |
|
5797 </div> |
|
5798 |
|
5799 |
|
5800 </li> |
|
5801 |
|
5802 </ul> |
|
5803 </div> |
|
5804 |
|
5805 |
|
5806 |
|
5807 |
|
5808 |
|
5809 </div> |
|
5810 |
|
5811 |
|
5812 <div id="method__afterSortDataChange" class="method item protected"> |
|
5813 <h3 class="name"><code>_afterSortDataChange</code></h3> |
|
5814 |
|
5815 |
|
5816 <div class="args"> |
|
5817 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5818 |
|
5819 <li class="arg"> |
|
5820 |
|
5821 <code>e</code> |
|
5822 |
|
5823 </li> |
|
5824 |
|
5825 </ul><span class="paren">)</span> |
|
5826 </div> |
|
5827 |
|
5828 |
|
5829 |
|
5830 |
|
5831 |
|
5832 |
|
5833 |
|
5834 <span class="flag protected">protected</span> |
|
5835 |
|
5836 |
|
5837 |
|
5838 |
|
5839 |
|
5840 |
|
5841 |
|
5842 |
|
5843 |
|
5844 |
|
5845 <div class="meta"> |
|
5846 |
|
5847 |
|
5848 |
|
5849 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
5850 |
|
5851 <p> |
|
5852 |
|
5853 Defined in |
|
5854 |
|
5855 |
|
5856 |
|
5857 |
|
5858 <a href="../files/datatable_js_sort.js.html#l313"><code>datatable/js/sort.js:313</code></a> |
|
5859 |
|
5860 </p> |
|
5861 |
|
5862 |
|
5863 |
|
5864 |
|
5865 |
|
5866 <p>Available since 3.5.0</p> |
|
5867 |
|
5868 </div> |
|
5869 |
|
5870 <div class="description"> |
|
5871 <p>Applies the sorting logic to the new ModelList if the <code>newVal</code> is a new |
|
5872 ModelList.</p> |
|
5873 </div> |
|
5874 |
|
5875 |
|
5876 <div class="params"> |
|
5877 <h4>Parameters:</h4> |
|
5878 |
|
5879 <ul class="params-list"> |
|
5880 |
|
5881 <li class="param"> |
|
5882 |
|
5883 <code class="param-name">e</code> |
|
5884 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
5885 |
|
5886 |
|
5887 |
|
5888 |
|
5889 <div class="param-description"> |
|
5890 <p>the <code>dataChange</code> event</p> |
|
5891 </div> |
|
5892 |
|
5893 |
|
5894 </li> |
|
5895 |
|
5896 </ul> |
|
5897 </div> |
|
5898 |
|
5899 |
|
5900 |
|
5901 |
|
5902 |
|
5903 </div> |
|
5904 |
|
5905 |
|
5906 <div id="method__afterSortRecordChange" class="method item protected"> |
|
5907 <h3 class="name"><code>_afterSortRecordChange</code></h3> |
|
5908 |
|
5909 |
|
5910 <div class="args"> |
|
5911 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5912 |
|
5913 <li class="arg"> |
|
5914 |
|
5915 <code>e</code> |
|
5916 |
|
5917 </li> |
|
5918 |
|
5919 </ul><span class="paren">)</span> |
|
5920 </div> |
|
5921 |
|
5922 |
|
5923 |
|
5924 |
|
5925 |
|
5926 |
|
5927 |
|
5928 <span class="flag protected">protected</span> |
|
5929 |
|
5930 |
|
5931 |
|
5932 |
|
5933 |
|
5934 |
|
5935 |
|
5936 |
|
5937 |
|
5938 |
|
5939 <div class="meta"> |
|
5940 |
|
5941 |
|
5942 |
|
5943 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
5944 |
|
5945 <p> |
|
5946 |
|
5947 Defined in |
|
5948 |
|
5949 |
|
5950 |
|
5951 |
|
5952 <a href="../files/datatable_js_sort.js.html#l332"><code>datatable/js/sort.js:332</code></a> |
|
5953 |
|
5954 </p> |
|
5955 |
|
5956 |
|
5957 |
|
5958 |
|
5959 |
|
5960 <p>Available since 3.5.0</p> |
|
5961 |
|
5962 </div> |
|
5963 |
|
5964 <div class="description"> |
|
5965 <p>Checks if any of the fields in the modified record are fields that are |
|
5966 currently being sorted by, and if so, resorts the <code>data</code> ModelList.</p> |
|
5967 </div> |
|
5968 |
|
5969 |
|
5970 <div class="params"> |
|
5971 <h4>Parameters:</h4> |
|
5972 |
|
5973 <ul class="params-list"> |
|
5974 |
|
5975 <li class="param"> |
|
5976 |
|
5977 <code class="param-name">e</code> |
|
5978 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
5979 |
|
5980 |
|
5981 |
|
5982 |
|
5983 <div class="param-description"> |
|
5984 <p>The Model's <code>change</code> event</p> |
|
5985 </div> |
|
5986 |
|
5987 |
|
5988 </li> |
|
5989 |
|
5990 </ul> |
|
5991 </div> |
|
5992 |
|
5993 |
|
5994 |
|
5995 |
|
5996 |
|
5997 </div> |
|
5998 |
|
5999 |
|
6000 <div id="method__aggregateAttrs" class="method item private inherited"> |
|
6001 <h3 class="name"><code>_aggregateAttrs</code></h3> |
|
6002 |
|
6003 |
|
6004 <div class="args"> |
|
6005 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6006 |
|
6007 <li class="arg"> |
|
6008 |
|
6009 <code>allAttrs</code> |
|
6010 |
|
6011 </li> |
|
6012 |
|
6013 </ul><span class="paren">)</span> |
|
6014 </div> |
|
6015 |
|
6016 |
|
6017 |
|
6018 <span class="returns-inline"> |
|
6019 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6020 </span> |
|
6021 |
|
6022 |
|
6023 |
|
6024 |
|
6025 |
|
6026 <span class="flag private">private</span> |
|
6027 |
|
6028 |
|
6029 |
|
6030 |
|
6031 |
|
6032 |
|
6033 |
|
6034 |
|
6035 |
|
6036 |
|
6037 <div class="meta"> |
|
6038 |
|
6039 |
|
6040 <p>Inherited from |
|
6041 <a href="../classes/BaseCore.html#method__aggregateAttrs">BaseCore</a>: |
|
6042 |
|
6043 |
|
6044 |
|
6045 <a href="../files/base_js_BaseCore.js.html#l575"><code>base/js/BaseCore.js:575</code></a> |
|
6046 |
|
6047 </p> |
|
6048 |
|
6049 |
|
6050 |
|
6051 |
|
6052 |
|
6053 </div> |
|
6054 |
|
6055 <div class="description"> |
|
6056 <p>A helper method, used by _initHierarchyData to aggregate |
|
6057 attribute configuration across the instances class hierarchy.</p> |
|
6058 |
|
6059 <p>The method will protect the attribute configuration value to protect the statically defined |
|
6060 default value in ATTRS if required (if the value is an object literal, array or the |
|
6061 attribute configuration has cloneDefaultValue set to shallow or deep).</p> |
|
6062 </div> |
|
6063 |
|
6064 |
|
6065 <div class="params"> |
|
6066 <h4>Parameters:</h4> |
|
6067 |
|
6068 <ul class="params-list"> |
|
6069 |
|
6070 <li class="param"> |
|
6071 |
|
6072 <code class="param-name">allAttrs</code> |
|
6073 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
6074 |
|
6075 |
|
6076 |
|
6077 |
|
6078 <div class="param-description"> |
|
6079 <p>An array of ATTRS definitions across classes in the hierarchy |
|
6080 (subclass first, Base last)</p> |
|
6081 </div> |
|
6082 |
|
6083 |
|
6084 </li> |
|
6085 |
|
6086 </ul> |
|
6087 </div> |
|
6088 |
|
6089 |
|
6090 |
|
6091 <div class="returns"> |
|
6092 <h4>Returns:</h4> |
|
6093 |
|
6094 <div class="returns-description"> |
|
6095 |
|
6096 |
|
6097 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
6098 |
|
6099 The aggregate set of ATTRS definitions for the instance |
|
6100 |
|
6101 </div> |
|
6102 </div> |
|
6103 |
|
6104 |
|
6105 |
|
6106 </div> |
|
6107 |
|
6108 |
|
6109 <div id="method__applyParsedConfig" class="method item protected inherited"> |
|
6110 <h3 class="name"><code>_applyParsedConfig</code></h3> |
|
6111 |
|
6112 |
|
6113 <span class="paren">()</span> |
|
6114 |
|
6115 |
|
6116 |
|
6117 <span class="returns-inline"> |
|
6118 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6119 </span> |
|
6120 |
|
6121 |
|
6122 |
|
6123 |
|
6124 |
|
6125 <span class="flag protected">protected</span> |
|
6126 |
|
6127 |
|
6128 |
|
6129 |
|
6130 |
|
6131 |
|
6132 |
|
6133 |
|
6134 |
|
6135 |
|
6136 <div class="meta"> |
|
6137 |
|
6138 |
|
6139 <p>Inherited from |
|
6140 <a href="../classes/Widget.html#method__applyParsedConfig">Widget</a>: |
|
6141 |
|
6142 |
|
6143 |
|
6144 <a href="../files/widget_js_WidgetHTMLParser.js.html#l83"><code>widget/js/WidgetHTMLParser.js:83</code></a> |
|
6145 |
|
6146 </p> |
|
6147 |
|
6148 |
|
6149 |
|
6150 |
|
6151 |
|
6152 </div> |
|
6153 |
|
6154 <div class="description"> |
|
6155 |
|
6156 </div> |
|
6157 |
|
6158 |
|
6159 |
|
6160 |
|
6161 <div class="returns"> |
|
6162 <h4>Returns:</h4> |
|
6163 |
|
6164 <div class="returns-description"> |
|
6165 |
|
6166 |
|
6167 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
6168 |
|
6169 The merged configuration literal |
|
6170 |
|
6171 </div> |
|
6172 </div> |
|
6173 |
|
6174 |
|
6175 |
|
6176 </div> |
|
6177 |
|
6178 |
|
6179 <div id="method__applyParser" class="method item protected inherited"> |
|
6180 <h3 class="name"><code>_applyParser</code></h3> |
|
6181 |
|
6182 |
|
6183 <div class="args"> |
|
6184 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6185 |
|
6186 <li class="arg"> |
|
6187 |
|
6188 <code>config</code> |
|
6189 |
|
6190 </li> |
|
6191 |
|
6192 </ul><span class="paren">)</span> |
|
6193 </div> |
|
6194 |
|
6195 |
|
6196 |
|
6197 |
|
6198 |
|
6199 |
|
6200 |
|
6201 <span class="flag protected">protected</span> |
|
6202 |
|
6203 |
|
6204 |
|
6205 |
|
6206 |
|
6207 |
|
6208 |
|
6209 |
|
6210 |
|
6211 |
|
6212 <div class="meta"> |
|
6213 |
|
6214 |
|
6215 <p>Inherited from |
|
6216 <a href="../classes/Widget.html#method__applyParser">Widget</a>: |
|
6217 |
|
6218 |
|
6219 |
|
6220 <a href="../files/widget_js_WidgetHTMLParser.js.html#l92"><code>widget/js/WidgetHTMLParser.js:92</code></a> |
|
6221 |
|
6222 </p> |
|
6223 |
|
6224 |
|
6225 |
|
6226 |
|
6227 |
|
6228 </div> |
|
6229 |
|
6230 <div class="description"> |
|
6231 <p>Utility method used to apply the <code>HTML_PARSER</code> configuration for the |
|
6232 instance, to retrieve config data values.</p> |
|
6233 </div> |
|
6234 |
|
6235 |
|
6236 <div class="params"> |
|
6237 <h4>Parameters:</h4> |
|
6238 |
|
6239 <ul class="params-list"> |
|
6240 |
|
6241 <li class="param"> |
|
6242 |
|
6243 <code class="param-name">config</code> |
|
6244 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6245 |
|
6246 |
|
6247 |
|
6248 |
|
6249 <div class="param-description"> |
|
6250 <p>User configuration object (will be populated with values from Node)</p> |
|
6251 </div> |
|
6252 |
|
6253 |
|
6254 </li> |
|
6255 |
|
6256 </ul> |
|
6257 </div> |
|
6258 |
|
6259 |
|
6260 |
|
6261 |
|
6262 |
|
6263 </div> |
|
6264 |
|
6265 |
|
6266 <div id="method__attrCfgHash" class="method item private inherited"> |
|
6267 <h3 class="name"><code>_attrCfgHash</code></h3> |
|
6268 |
|
6269 |
|
6270 <span class="paren">()</span> |
|
6271 |
|
6272 |
|
6273 |
|
6274 |
|
6275 |
|
6276 |
|
6277 |
|
6278 <span class="flag private">private</span> |
|
6279 |
|
6280 |
|
6281 |
|
6282 |
|
6283 |
|
6284 |
|
6285 |
|
6286 |
|
6287 |
|
6288 |
|
6289 <div class="meta"> |
|
6290 |
|
6291 |
|
6292 <p>Inherited from |
|
6293 <a href="../classes/BaseCore.html#method__attrCfgHash">BaseCore</a>: |
|
6294 |
|
6295 |
|
6296 |
|
6297 <a href="../files/base_js_BaseCore.js.html#l538"><code>base/js/BaseCore.js:538</code></a> |
|
6298 |
|
6299 </p> |
|
6300 |
|
6301 |
|
6302 |
|
6303 |
|
6304 |
|
6305 </div> |
|
6306 |
|
6307 <div class="description"> |
|
6308 <p>Utility method to define the attribute hash used to filter/whitelist property mixes for |
|
6309 this class for iteration performance reasons.</p> |
|
6310 </div> |
|
6311 |
|
6312 |
|
6313 |
|
6314 |
|
6315 |
|
6316 |
|
6317 </div> |
|
6318 |
|
6319 |
|
6320 <div id="method__baseDestroy" class="method item private inherited"> |
|
6321 <h3 class="name"><code>_baseDestroy</code></h3> |
|
6322 |
|
6323 |
|
6324 <span class="paren">()</span> |
|
6325 |
|
6326 |
|
6327 |
|
6328 |
|
6329 |
|
6330 |
|
6331 |
|
6332 <span class="flag private">private</span> |
|
6333 |
|
6334 |
|
6335 |
|
6336 |
|
6337 |
|
6338 |
|
6339 |
|
6340 |
|
6341 |
|
6342 |
|
6343 <div class="meta"> |
|
6344 |
|
6345 |
|
6346 <p>Inherited from |
|
6347 <a href="../classes/BaseCore.html#method__baseDestroy">BaseCore</a>: |
|
6348 |
|
6349 |
|
6350 |
|
6351 <a href="../files/base_js_BaseCore.js.html#l309"><code>base/js/BaseCore.js:309</code></a> |
|
6352 |
|
6353 </p> |
|
6354 |
|
6355 |
|
6356 |
|
6357 |
|
6358 |
|
6359 </div> |
|
6360 |
|
6361 <div class="description"> |
|
6362 <p>Internal destroy implementation for BaseCore</p> |
|
6363 </div> |
|
6364 |
|
6365 |
|
6366 |
|
6367 |
|
6368 |
|
6369 |
|
6370 </div> |
|
6371 |
|
6372 |
|
6373 <div id="method__baseInit" class="method item private inherited"> |
|
6374 <h3 class="name"><code>_baseInit</code></h3> |
|
6375 |
|
6376 |
|
6377 <span class="paren">()</span> |
|
6378 |
|
6379 |
|
6380 |
|
6381 |
|
6382 |
|
6383 |
|
6384 |
|
6385 <span class="flag private">private</span> |
|
6386 |
|
6387 |
|
6388 |
|
6389 |
|
6390 |
|
6391 |
|
6392 |
|
6393 |
|
6394 |
|
6395 |
|
6396 <div class="meta"> |
|
6397 |
|
6398 |
|
6399 <p>Inherited from |
|
6400 <a href="../classes/BaseCore.html#method__baseInit">BaseCore</a>: |
|
6401 |
|
6402 |
|
6403 |
|
6404 <a href="../files/base_js_BaseCore.js.html#l281"><code>base/js/BaseCore.js:281</code></a> |
|
6405 |
|
6406 </p> |
|
6407 |
|
6408 |
|
6409 |
|
6410 |
|
6411 |
|
6412 </div> |
|
6413 |
|
6414 <div class="description"> |
|
6415 <p>Internal initialization implementation for BaseCore</p> |
|
6416 </div> |
|
6417 |
|
6418 |
|
6419 |
|
6420 |
|
6421 |
|
6422 |
|
6423 </div> |
|
6424 |
|
6425 |
|
6426 <div id="method__bindAttrUI" class="method item private inherited"> |
|
6427 <h3 class="name"><code>_bindAttrUI</code></h3> |
|
6428 |
|
6429 |
|
6430 <div class="args"> |
|
6431 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6432 |
|
6433 <li class="arg"> |
|
6434 |
|
6435 <code>attrs</code> |
|
6436 |
|
6437 </li> |
|
6438 |
|
6439 </ul><span class="paren">)</span> |
|
6440 </div> |
|
6441 |
|
6442 |
|
6443 |
|
6444 |
|
6445 |
|
6446 |
|
6447 |
|
6448 <span class="flag private">private</span> |
|
6449 |
|
6450 |
|
6451 |
|
6452 |
|
6453 |
|
6454 |
|
6455 |
|
6456 |
|
6457 |
|
6458 |
|
6459 <div class="meta"> |
|
6460 |
|
6461 |
|
6462 <p>Inherited from |
|
6463 <a href="../classes/Widget.html#method__bindAttrUI">Widget</a>: |
|
6464 |
|
6465 |
|
6466 |
|
6467 <a href="../files/widget_js_Widget.js.html#l1170"><code>widget/js/Widget.js:1170</code></a> |
|
6468 |
|
6469 </p> |
|
6470 |
|
6471 |
|
6472 |
|
6473 |
|
6474 |
|
6475 </div> |
|
6476 |
|
6477 <div class="description"> |
|
6478 <p>Binds after listeners for the list of attributes provided</p> |
|
6479 </div> |
|
6480 |
|
6481 |
|
6482 <div class="params"> |
|
6483 <h4>Parameters:</h4> |
|
6484 |
|
6485 <ul class="params-list"> |
|
6486 |
|
6487 <li class="param"> |
|
6488 |
|
6489 <code class="param-name">attrs</code> |
|
6490 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
6491 |
|
6492 |
|
6493 |
|
6494 |
|
6495 <div class="param-description"> |
|
6496 |
|
6497 </div> |
|
6498 |
|
6499 |
|
6500 </li> |
|
6501 |
|
6502 </ul> |
|
6503 </div> |
|
6504 |
|
6505 |
|
6506 |
|
6507 |
|
6508 |
|
6509 </div> |
|
6510 |
|
6511 |
|
6512 <div id="method__bindDOM" class="method item protected inherited"> |
|
6513 <h3 class="name"><code>_bindDOM</code></h3> |
|
6514 |
|
6515 |
|
6516 <span class="paren">()</span> |
|
6517 |
|
6518 |
|
6519 |
|
6520 |
|
6521 |
|
6522 |
|
6523 |
|
6524 <span class="flag protected">protected</span> |
|
6525 |
|
6526 |
|
6527 |
|
6528 |
|
6529 |
|
6530 |
|
6531 |
|
6532 |
|
6533 |
|
6534 |
|
6535 <div class="meta"> |
|
6536 |
|
6537 |
|
6538 <p>Inherited from |
|
6539 <a href="../classes/Widget.html#method__bindDOM">Widget</a>: |
|
6540 |
|
6541 |
|
6542 |
|
6543 <a href="../files/widget_js_Widget.js.html#l902"><code>widget/js/Widget.js:902</code></a> |
|
6544 |
|
6545 </p> |
|
6546 |
|
6547 |
|
6548 |
|
6549 |
|
6550 |
|
6551 </div> |
|
6552 |
|
6553 <div class="description"> |
|
6554 <p>Sets up DOM listeners, on elements rendered by the widget.</p> |
|
6555 </div> |
|
6556 |
|
6557 |
|
6558 |
|
6559 |
|
6560 |
|
6561 |
|
6562 </div> |
|
6563 |
|
6564 |
|
6565 <div id="method__bindMessageUI" class="method item protected"> |
|
6566 <h3 class="name"><code>_bindMessageUI</code></h3> |
|
6567 |
|
6568 |
|
6569 <span class="paren">()</span> |
|
6570 |
|
6571 |
|
6572 |
|
6573 |
|
6574 |
|
6575 |
|
6576 |
|
6577 <span class="flag protected">protected</span> |
|
6578 |
|
6579 |
|
6580 |
|
6581 |
|
6582 |
|
6583 |
|
6584 |
|
6585 |
|
6586 |
|
6587 |
|
6588 <div class="meta"> |
|
6589 |
|
6590 |
|
6591 |
|
6592 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
6593 |
|
6594 <p> |
|
6595 |
|
6596 Defined in |
|
6597 |
|
6598 |
|
6599 |
|
6600 |
|
6601 <a href="../files/datatable_js_message.js.html#l166"><code>datatable/js/message.js:166</code></a> |
|
6602 |
|
6603 </p> |
|
6604 |
|
6605 |
|
6606 |
|
6607 |
|
6608 |
|
6609 <p>Available since 3.5.0</p> |
|
6610 |
|
6611 </div> |
|
6612 |
|
6613 <div class="description"> |
|
6614 <p>Binds the events necessary to keep the message node in sync with the current |
|
6615 table and configuration state.</p> |
|
6616 </div> |
|
6617 |
|
6618 |
|
6619 |
|
6620 |
|
6621 |
|
6622 |
|
6623 </div> |
|
6624 |
|
6625 |
|
6626 <div id="method__bindScrollbar" class="method item protected"> |
|
6627 <h3 class="name"><code>_bindScrollbar</code></h3> |
|
6628 |
|
6629 |
|
6630 <span class="paren">()</span> |
|
6631 |
|
6632 |
|
6633 |
|
6634 |
|
6635 |
|
6636 |
|
6637 |
|
6638 <span class="flag protected">protected</span> |
|
6639 |
|
6640 |
|
6641 |
|
6642 |
|
6643 |
|
6644 |
|
6645 |
|
6646 |
|
6647 |
|
6648 |
|
6649 <div class="meta"> |
|
6650 |
|
6651 |
|
6652 |
|
6653 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
6654 |
|
6655 <p> |
|
6656 |
|
6657 Defined in |
|
6658 |
|
6659 |
|
6660 |
|
6661 |
|
6662 <a href="../files/datatable_js_scroll.js.html#l348"><code>datatable/js/scroll.js:348</code></a> |
|
6663 |
|
6664 </p> |
|
6665 |
|
6666 |
|
6667 |
|
6668 |
|
6669 |
|
6670 <p>Available since 3.5.0</p> |
|
6671 |
|
6672 </div> |
|
6673 |
|
6674 <div class="description"> |
|
6675 <p>Binds virtual scrollbar interaction to the <code>_yScrollNode</code>'s <code>scrollTop</code> and |
|
6676 vice versa.</p> |
|
6677 </div> |
|
6678 |
|
6679 |
|
6680 |
|
6681 |
|
6682 |
|
6683 |
|
6684 </div> |
|
6685 |
|
6686 |
|
6687 <div id="method__bindScrollResize" class="method item protected"> |
|
6688 <h3 class="name"><code>_bindScrollResize</code></h3> |
|
6689 |
|
6690 |
|
6691 <span class="paren">()</span> |
|
6692 |
|
6693 |
|
6694 |
|
6695 |
|
6696 |
|
6697 |
|
6698 |
|
6699 <span class="flag protected">protected</span> |
|
6700 |
|
6701 |
|
6702 |
|
6703 |
|
6704 |
|
6705 |
|
6706 |
|
6707 |
|
6708 |
|
6709 |
|
6710 <div class="meta"> |
|
6711 |
|
6712 |
|
6713 |
|
6714 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
6715 |
|
6716 <p> |
|
6717 |
|
6718 Defined in |
|
6719 |
|
6720 |
|
6721 |
|
6722 |
|
6723 <a href="../files/datatable_js_scroll.js.html#l368"><code>datatable/js/scroll.js:368</code></a> |
|
6724 |
|
6725 </p> |
|
6726 |
|
6727 |
|
6728 |
|
6729 |
|
6730 |
|
6731 <p>Available since 3.5.0</p> |
|
6732 |
|
6733 </div> |
|
6734 |
|
6735 <div class="description"> |
|
6736 <p>Binds to the window resize event to update the vertical scrolling table |
|
6737 headers and wrapper <code><div></code> dimensions.</p> |
|
6738 </div> |
|
6739 |
|
6740 |
|
6741 |
|
6742 |
|
6743 |
|
6744 |
|
6745 </div> |
|
6746 |
|
6747 |
|
6748 <div id="method__bindScrollUI" class="method item protected"> |
|
6749 <h3 class="name"><code>_bindScrollUI</code></h3> |
|
6750 |
|
6751 |
|
6752 <span class="paren">()</span> |
|
6753 |
|
6754 |
|
6755 |
|
6756 |
|
6757 |
|
6758 |
|
6759 |
|
6760 <span class="flag protected">protected</span> |
|
6761 |
|
6762 |
|
6763 |
|
6764 |
|
6765 |
|
6766 |
|
6767 |
|
6768 |
|
6769 |
|
6770 |
|
6771 <div class="meta"> |
|
6772 |
|
6773 |
|
6774 |
|
6775 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
6776 |
|
6777 <p> |
|
6778 |
|
6779 Defined in |
|
6780 |
|
6781 |
|
6782 |
|
6783 |
|
6784 <a href="../files/datatable_js_scroll.js.html#l385"><code>datatable/js/scroll.js:385</code></a> |
|
6785 |
|
6786 </p> |
|
6787 |
|
6788 |
|
6789 |
|
6790 |
|
6791 |
|
6792 <p>Available since 3.5.0</p> |
|
6793 |
|
6794 </div> |
|
6795 |
|
6796 <div class="description"> |
|
6797 <p>Attaches internal subscriptions to keep the scrolling structure up to date |
|
6798 with changes in the table's <code>data</code>, <code>columns</code>, <code>caption</code>, or <code>height</code>. The |
|
6799 <code>width</code> is taken care of already.</p> |
|
6800 |
|
6801 <p>This executes after the table's native <code>bindUI</code> method.</p> |
|
6802 </div> |
|
6803 |
|
6804 |
|
6805 |
|
6806 |
|
6807 |
|
6808 |
|
6809 </div> |
|
6810 |
|
6811 |
|
6812 <div id="method__bindSortUI" class="method item protected"> |
|
6813 <h3 class="name"><code>_bindSortUI</code></h3> |
|
6814 |
|
6815 |
|
6816 <span class="paren">()</span> |
|
6817 |
|
6818 |
|
6819 |
|
6820 |
|
6821 |
|
6822 |
|
6823 |
|
6824 <span class="flag protected">protected</span> |
|
6825 |
|
6826 |
|
6827 |
|
6828 |
|
6829 |
|
6830 |
|
6831 |
|
6832 |
|
6833 |
|
6834 |
|
6835 <div class="meta"> |
|
6836 |
|
6837 |
|
6838 |
|
6839 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
6840 |
|
6841 <p> |
|
6842 |
|
6843 Defined in |
|
6844 |
|
6845 |
|
6846 |
|
6847 |
|
6848 <a href="../files/datatable_js_sort.js.html#l352"><code>datatable/js/sort.js:352</code></a> |
|
6849 |
|
6850 </p> |
|
6851 |
|
6852 |
|
6853 |
|
6854 |
|
6855 |
|
6856 <p>Available since 3.5.0</p> |
|
6857 |
|
6858 </div> |
|
6859 |
|
6860 <div class="description"> |
|
6861 <p>Subscribes to state changes that warrant updating the UI, and adds the |
|
6862 click handler for triggering the sort operation from the UI.</p> |
|
6863 </div> |
|
6864 |
|
6865 |
|
6866 |
|
6867 |
|
6868 |
|
6869 |
|
6870 </div> |
|
6871 |
|
6872 |
|
6873 <div id="method__bindUI" class="method item protected inherited"> |
|
6874 <h3 class="name"><code>_bindUI</code></h3> |
|
6875 |
|
6876 |
|
6877 <span class="paren">()</span> |
|
6878 |
|
6879 |
|
6880 |
|
6881 |
|
6882 |
|
6883 |
|
6884 |
|
6885 <span class="flag protected">protected</span> |
|
6886 |
|
6887 |
|
6888 |
|
6889 |
|
6890 |
|
6891 |
|
6892 |
|
6893 |
|
6894 |
|
6895 |
|
6896 <div class="meta"> |
|
6897 |
|
6898 |
|
6899 <p>Inherited from |
|
6900 <a href="../classes/Widget.html#method__bindUI">Widget</a>: |
|
6901 |
|
6902 |
|
6903 |
|
6904 <a href="../files/widget_js_Widget.js.html#l883"><code>widget/js/Widget.js:883</code></a> |
|
6905 |
|
6906 </p> |
|
6907 |
|
6908 |
|
6909 |
|
6910 |
|
6911 |
|
6912 </div> |
|
6913 |
|
6914 <div class="description"> |
|
6915 <p>Sets up DOM and CustomEvent listeners for the widget.</p> |
|
6916 </div> |
|
6917 |
|
6918 |
|
6919 |
|
6920 |
|
6921 |
|
6922 |
|
6923 </div> |
|
6924 |
|
6925 |
|
6926 <div id="method__bindUIChild" class="method item protected inherited"> |
|
6927 <h3 class="name"><code>_bindUIChild</code></h3> |
|
6928 |
|
6929 |
|
6930 <span class="paren">()</span> |
|
6931 |
|
6932 |
|
6933 |
|
6934 |
|
6935 |
|
6936 |
|
6937 |
|
6938 <span class="flag protected">protected</span> |
|
6939 |
|
6940 |
|
6941 |
|
6942 |
|
6943 |
|
6944 |
|
6945 |
|
6946 |
|
6947 |
|
6948 |
|
6949 <div class="meta"> |
|
6950 |
|
6951 |
|
6952 <p>Inherited from |
|
6953 <a href="../classes/Widget.html#method__bindUIChild">Widget</a>: |
|
6954 |
|
6955 |
|
6956 |
|
6957 <a href="../files/widget-child_js_Widget-Child.js.html#l356"><code>widget-child/js/Widget-Child.js:356</code></a> |
|
6958 |
|
6959 </p> |
|
6960 |
|
6961 |
|
6962 |
|
6963 |
|
6964 |
|
6965 </div> |
|
6966 |
|
6967 <div class="description"> |
|
6968 <p>Binds event listeners responsible for updating the UI state in response |
|
6969 to WidgetChild related state changes.</p> |
|
6970 |
|
6971 <p> |
|
6972 This method is invoked after bindUI is invoked for the Widget class |
|
6973 using YUI's aop infrastructure. |
|
6974 </p> |
|
6975 </div> |
|
6976 |
|
6977 |
|
6978 |
|
6979 |
|
6980 |
|
6981 |
|
6982 </div> |
|
6983 |
|
6984 |
|
6985 <div id="method__clearScrollLock" class="method item protected"> |
|
6986 <h3 class="name"><code>_clearScrollLock</code></h3> |
|
6987 |
|
6988 |
|
6989 <span class="paren">()</span> |
|
6990 |
|
6991 |
|
6992 |
|
6993 |
|
6994 |
|
6995 |
|
6996 |
|
6997 <span class="flag protected">protected</span> |
|
6998 |
|
6999 |
|
7000 |
|
7001 |
|
7002 |
|
7003 |
|
7004 |
|
7005 |
|
7006 |
|
7007 |
|
7008 <div class="meta"> |
|
7009 |
|
7010 |
|
7011 |
|
7012 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
7013 |
|
7014 <p> |
|
7015 |
|
7016 Defined in |
|
7017 |
|
7018 |
|
7019 |
|
7020 |
|
7021 <a href="../files/datatable_js_scroll.js.html#l413"><code>datatable/js/scroll.js:413</code></a> |
|
7022 |
|
7023 </p> |
|
7024 |
|
7025 |
|
7026 |
|
7027 |
|
7028 |
|
7029 <p>Available since 3.5.0</p> |
|
7030 |
|
7031 </div> |
|
7032 |
|
7033 <div class="description"> |
|
7034 <p>Clears the lock and timer used to manage synchronizing the scroll position |
|
7035 between the vertical scroll container and the virtual scrollbar.</p> |
|
7036 </div> |
|
7037 |
|
7038 |
|
7039 |
|
7040 |
|
7041 |
|
7042 |
|
7043 </div> |
|
7044 |
|
7045 |
|
7046 <div id="method__cloneDefaultValue" class="method item private inherited"> |
|
7047 <h3 class="name"><code>_cloneDefaultValue</code></h3> |
|
7048 |
|
7049 |
|
7050 <div class="args"> |
|
7051 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7052 |
|
7053 <li class="arg"> |
|
7054 |
|
7055 <code>cfg</code> |
|
7056 |
|
7057 </li> |
|
7058 |
|
7059 </ul><span class="paren">)</span> |
|
7060 </div> |
|
7061 |
|
7062 |
|
7063 |
|
7064 |
|
7065 |
|
7066 |
|
7067 |
|
7068 <span class="flag private">private</span> |
|
7069 |
|
7070 |
|
7071 |
|
7072 |
|
7073 |
|
7074 |
|
7075 |
|
7076 |
|
7077 |
|
7078 |
|
7079 <div class="meta"> |
|
7080 |
|
7081 |
|
7082 <p>Inherited from |
|
7083 <a href="../classes/BaseCore.html#method__cloneDefaultValue">BaseCore</a>: |
|
7084 |
|
7085 |
|
7086 |
|
7087 <a href="../files/base_js_BaseCore.js.html#l549"><code>base/js/BaseCore.js:549</code></a> |
|
7088 |
|
7089 </p> |
|
7090 |
|
7091 |
|
7092 |
|
7093 |
|
7094 |
|
7095 </div> |
|
7096 |
|
7097 <div class="description"> |
|
7098 <p>This method assumes that the value has already been checked to be an object. |
|
7099 Since it's on a critical path, we don't want to re-do the check.</p> |
|
7100 </div> |
|
7101 |
|
7102 |
|
7103 <div class="params"> |
|
7104 <h4>Parameters:</h4> |
|
7105 |
|
7106 <ul class="params-list"> |
|
7107 |
|
7108 <li class="param"> |
|
7109 |
|
7110 <code class="param-name">cfg</code> |
|
7111 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7112 |
|
7113 |
|
7114 |
|
7115 |
|
7116 <div class="param-description"> |
|
7117 |
|
7118 </div> |
|
7119 |
|
7120 |
|
7121 </li> |
|
7122 |
|
7123 </ul> |
|
7124 </div> |
|
7125 |
|
7126 |
|
7127 |
|
7128 |
|
7129 |
|
7130 </div> |
|
7131 |
|
7132 |
|
7133 <div id="method__createColumnGroup" class="method item protected"> |
|
7134 <h3 class="name"><code>_createColumnGroup</code></h3> |
|
7135 |
|
7136 |
|
7137 <span class="paren">()</span> |
|
7138 |
|
7139 |
|
7140 |
|
7141 |
|
7142 |
|
7143 |
|
7144 |
|
7145 <span class="flag protected">protected</span> |
|
7146 |
|
7147 |
|
7148 |
|
7149 |
|
7150 |
|
7151 |
|
7152 |
|
7153 |
|
7154 |
|
7155 |
|
7156 <div class="meta"> |
|
7157 |
|
7158 |
|
7159 |
|
7160 <p>Provided by the <a href="../modules/datatable-column-widths.html">datatable-column-widths</a> module.</p> |
|
7161 |
|
7162 <p> |
|
7163 |
|
7164 Defined in |
|
7165 |
|
7166 |
|
7167 |
|
7168 |
|
7169 <a href="../files/datatable_js_colwidths.js.html#l175"><code>datatable/js/colwidths.js:175</code></a> |
|
7170 |
|
7171 </p> |
|
7172 |
|
7173 |
|
7174 |
|
7175 |
|
7176 |
|
7177 <p>Available since 3.5.0</p> |
|
7178 |
|
7179 </div> |
|
7180 |
|
7181 <div class="description"> |
|
7182 <p>Renders the table's <code><colgroup></code> and populates the <code>_colgroupNode</code> property.</p> |
|
7183 </div> |
|
7184 |
|
7185 |
|
7186 |
|
7187 |
|
7188 |
|
7189 |
|
7190 </div> |
|
7191 |
|
7192 |
|
7193 <div id="method__createRecordClass" class="method item protected"> |
|
7194 <h3 class="name"><code>_createRecordClass</code></h3> |
|
7195 |
|
7196 |
|
7197 <div class="args"> |
|
7198 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7199 |
|
7200 <li class="arg"> |
|
7201 |
|
7202 <code>attrs</code> |
|
7203 |
|
7204 </li> |
|
7205 |
|
7206 </ul><span class="paren">)</span> |
|
7207 </div> |
|
7208 |
|
7209 |
|
7210 |
|
7211 <span class="returns-inline"> |
|
7212 <span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span> |
|
7213 </span> |
|
7214 |
|
7215 |
|
7216 |
|
7217 |
|
7218 |
|
7219 <span class="flag protected">protected</span> |
|
7220 |
|
7221 |
|
7222 |
|
7223 |
|
7224 |
|
7225 |
|
7226 |
|
7227 |
|
7228 |
|
7229 |
|
7230 <div class="meta"> |
|
7231 |
|
7232 |
|
7233 |
|
7234 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
7235 |
|
7236 <p> |
|
7237 |
|
7238 Defined in |
|
7239 |
|
7240 |
|
7241 |
|
7242 |
|
7243 <a href="../files/datatable_js_core.js.html#l391"><code>datatable/js/core.js:391</code></a> |
|
7244 |
|
7245 </p> |
|
7246 |
|
7247 |
|
7248 |
|
7249 |
|
7250 |
|
7251 <p>Available since 3.5.0</p> |
|
7252 |
|
7253 </div> |
|
7254 |
|
7255 <div class="description"> |
|
7256 <p>Creates a Model subclass from an array of attribute names or an object of |
|
7257 attribute definitions. This is used to generate a class suitable to |
|
7258 represent the data passed to the <code>data</code> attribute if no <code>recordType</code> is |
|
7259 set.</p> |
|
7260 </div> |
|
7261 |
|
7262 |
|
7263 <div class="params"> |
|
7264 <h4>Parameters:</h4> |
|
7265 |
|
7266 <ul class="params-list"> |
|
7267 |
|
7268 <li class="param"> |
|
7269 |
|
7270 <code class="param-name">attrs</code> |
|
7271 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7272 |
|
7273 |
|
7274 |
|
7275 |
|
7276 <div class="param-description"> |
|
7277 <p>Names assigned to the Model subclass's |
|
7278 <code>ATTRS</code> or its entire <code>ATTRS</code> definition object</p> |
|
7279 </div> |
|
7280 |
|
7281 |
|
7282 </li> |
|
7283 |
|
7284 </ul> |
|
7285 </div> |
|
7286 |
|
7287 |
|
7288 |
|
7289 <div class="returns"> |
|
7290 <h4>Returns:</h4> |
|
7291 |
|
7292 <div class="returns-description"> |
|
7293 |
|
7294 |
|
7295 <span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>: |
|
7296 |
|
7297 |
|
7298 </div> |
|
7299 </div> |
|
7300 |
|
7301 |
|
7302 |
|
7303 </div> |
|
7304 |
|
7305 |
|
7306 <div id="method__createScrollbar" class="method item protected"> |
|
7307 <h3 class="name"><code>_createScrollbar</code></h3> |
|
7308 |
|
7309 |
|
7310 <span class="paren">()</span> |
|
7311 |
|
7312 |
|
7313 |
|
7314 <span class="returns-inline"> |
|
7315 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
7316 </span> |
|
7317 |
|
7318 |
|
7319 |
|
7320 |
|
7321 |
|
7322 <span class="flag protected">protected</span> |
|
7323 |
|
7324 |
|
7325 |
|
7326 |
|
7327 |
|
7328 |
|
7329 |
|
7330 |
|
7331 |
|
7332 |
|
7333 <div class="meta"> |
|
7334 |
|
7335 |
|
7336 |
|
7337 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
7338 |
|
7339 <p> |
|
7340 |
|
7341 Defined in |
|
7342 |
|
7343 |
|
7344 |
|
7345 |
|
7346 <a href="../files/datatable_js_scroll.js.html#l428"><code>datatable/js/scroll.js:428</code></a> |
|
7347 |
|
7348 </p> |
|
7349 |
|
7350 |
|
7351 |
|
7352 |
|
7353 |
|
7354 <p>Available since 3.5.0</p> |
|
7355 |
|
7356 </div> |
|
7357 |
|
7358 <div class="description"> |
|
7359 <p>Creates a virtual scrollbar from the <code>_SCROLLBAR_TEMPLATE</code>, assigning it to |
|
7360 the <code>_scrollbarNode</code> property.</p> |
|
7361 </div> |
|
7362 |
|
7363 |
|
7364 |
|
7365 |
|
7366 <div class="returns"> |
|
7367 <h4>Returns:</h4> |
|
7368 |
|
7369 <div class="returns-description"> |
|
7370 |
|
7371 |
|
7372 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
7373 |
|
7374 The created Node |
|
7375 |
|
7376 </div> |
|
7377 </div> |
|
7378 |
|
7379 |
|
7380 |
|
7381 </div> |
|
7382 |
|
7383 |
|
7384 <div id="method__createScrollCaptionTable" class="method item protected"> |
|
7385 <h3 class="name"><code>_createScrollCaptionTable</code></h3> |
|
7386 |
|
7387 |
|
7388 <span class="paren">()</span> |
|
7389 |
|
7390 |
|
7391 |
|
7392 <span class="returns-inline"> |
|
7393 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
7394 </span> |
|
7395 |
|
7396 |
|
7397 |
|
7398 |
|
7399 |
|
7400 <span class="flag protected">protected</span> |
|
7401 |
|
7402 |
|
7403 |
|
7404 |
|
7405 |
|
7406 |
|
7407 |
|
7408 |
|
7409 |
|
7410 |
|
7411 <div class="meta"> |
|
7412 |
|
7413 |
|
7414 |
|
7415 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
7416 |
|
7417 <p> |
|
7418 |
|
7419 Defined in |
|
7420 |
|
7421 |
|
7422 |
|
7423 |
|
7424 <a href="../files/datatable_js_scroll.js.html#l454"><code>datatable/js/scroll.js:454</code></a> |
|
7425 |
|
7426 </p> |
|
7427 |
|
7428 |
|
7429 |
|
7430 |
|
7431 |
|
7432 <p>Available since 3.5.0</p> |
|
7433 |
|
7434 </div> |
|
7435 |
|
7436 <div class="description"> |
|
7437 <p>Creates a separate table to contain the caption when the table is |
|
7438 configured to scroll vertically or horizontally.</p> |
|
7439 </div> |
|
7440 |
|
7441 |
|
7442 |
|
7443 |
|
7444 <div class="returns"> |
|
7445 <h4>Returns:</h4> |
|
7446 |
|
7447 <div class="returns-description"> |
|
7448 |
|
7449 |
|
7450 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
7451 |
|
7452 The created Node |
|
7453 |
|
7454 </div> |
|
7455 </div> |
|
7456 |
|
7457 |
|
7458 |
|
7459 </div> |
|
7460 |
|
7461 |
|
7462 <div id="method__createUIEvent" class="method item private inherited"> |
|
7463 <h3 class="name"><code>_createUIEvent</code></h3> |
|
7464 |
|
7465 |
|
7466 <div class="args"> |
|
7467 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7468 |
|
7469 <li class="arg"> |
|
7470 |
|
7471 <code>type</code> |
|
7472 |
|
7473 </li> |
|
7474 |
|
7475 </ul><span class="paren">)</span> |
|
7476 </div> |
|
7477 |
|
7478 |
|
7479 |
|
7480 |
|
7481 |
|
7482 |
|
7483 |
|
7484 <span class="flag private">private</span> |
|
7485 |
|
7486 |
|
7487 |
|
7488 |
|
7489 |
|
7490 |
|
7491 |
|
7492 |
|
7493 |
|
7494 |
|
7495 <div class="meta"> |
|
7496 |
|
7497 |
|
7498 <p>Inherited from |
|
7499 <a href="../classes/Widget.html#method__createUIEvent">Widget</a>: |
|
7500 |
|
7501 |
|
7502 |
|
7503 <a href="../files/widget_js_WidgetUIEvents.js.html#l73"><code>widget/js/WidgetUIEvents.js:73</code></a> |
|
7504 |
|
7505 </p> |
|
7506 |
|
7507 |
|
7508 |
|
7509 |
|
7510 |
|
7511 </div> |
|
7512 |
|
7513 <div class="description"> |
|
7514 <p>Binds a delegated DOM event listener of the specified type to the |
|
7515 Widget's outtermost DOM element to facilitate the firing of a Custom |
|
7516 Event of the same type for the Widget instance.</p> |
|
7517 </div> |
|
7518 |
|
7519 |
|
7520 <div class="params"> |
|
7521 <h4>Parameters:</h4> |
|
7522 |
|
7523 <ul class="params-list"> |
|
7524 |
|
7525 <li class="param"> |
|
7526 |
|
7527 <code class="param-name">type</code> |
|
7528 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7529 |
|
7530 |
|
7531 |
|
7532 |
|
7533 <div class="param-description"> |
|
7534 <p>String representing the name of the event</p> |
|
7535 </div> |
|
7536 |
|
7537 |
|
7538 </li> |
|
7539 |
|
7540 </ul> |
|
7541 </div> |
|
7542 |
|
7543 |
|
7544 |
|
7545 |
|
7546 |
|
7547 </div> |
|
7548 |
|
7549 |
|
7550 <div id="method__createXScrollNode" class="method item protected"> |
|
7551 <h3 class="name"><code>_createXScrollNode</code></h3> |
|
7552 |
|
7553 |
|
7554 <span class="paren">()</span> |
|
7555 |
|
7556 |
|
7557 |
|
7558 <span class="returns-inline"> |
|
7559 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
7560 </span> |
|
7561 |
|
7562 |
|
7563 |
|
7564 |
|
7565 |
|
7566 <span class="flag protected">protected</span> |
|
7567 |
|
7568 |
|
7569 |
|
7570 |
|
7571 |
|
7572 |
|
7573 |
|
7574 |
|
7575 |
|
7576 |
|
7577 <div class="meta"> |
|
7578 |
|
7579 |
|
7580 |
|
7581 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
7582 |
|
7583 <p> |
|
7584 |
|
7585 Defined in |
|
7586 |
|
7587 |
|
7588 |
|
7589 |
|
7590 <a href="../files/datatable_js_scroll.js.html#l476"><code>datatable/js/scroll.js:476</code></a> |
|
7591 |
|
7592 </p> |
|
7593 |
|
7594 |
|
7595 |
|
7596 |
|
7597 |
|
7598 <p>Available since 3.5.0</p> |
|
7599 |
|
7600 </div> |
|
7601 |
|
7602 <div class="description"> |
|
7603 <p>Populates the <code>_xScrollNode</code> property by creating the <code><div></code> Node described |
|
7604 by the <code>_X_SCROLLER_TEMPLATE</code>.</p> |
|
7605 </div> |
|
7606 |
|
7607 |
|
7608 |
|
7609 |
|
7610 <div class="returns"> |
|
7611 <h4>Returns:</h4> |
|
7612 |
|
7613 <div class="returns-description"> |
|
7614 |
|
7615 |
|
7616 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
7617 |
|
7618 The created Node |
|
7619 |
|
7620 </div> |
|
7621 </div> |
|
7622 |
|
7623 |
|
7624 |
|
7625 </div> |
|
7626 |
|
7627 |
|
7628 <div id="method__createYScrollHeader" class="method item protected"> |
|
7629 <h3 class="name"><code>_createYScrollHeader</code></h3> |
|
7630 |
|
7631 |
|
7632 <span class="paren">()</span> |
|
7633 |
|
7634 |
|
7635 |
|
7636 <span class="returns-inline"> |
|
7637 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
7638 </span> |
|
7639 |
|
7640 |
|
7641 |
|
7642 |
|
7643 |
|
7644 <span class="flag protected">protected</span> |
|
7645 |
|
7646 |
|
7647 |
|
7648 |
|
7649 |
|
7650 |
|
7651 |
|
7652 |
|
7653 |
|
7654 |
|
7655 <div class="meta"> |
|
7656 |
|
7657 |
|
7658 |
|
7659 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
7660 |
|
7661 <p> |
|
7662 |
|
7663 Defined in |
|
7664 |
|
7665 |
|
7666 |
|
7667 |
|
7668 <a href="../files/datatable_js_scroll.js.html#l496"><code>datatable/js/scroll.js:496</code></a> |
|
7669 |
|
7670 </p> |
|
7671 |
|
7672 |
|
7673 |
|
7674 |
|
7675 |
|
7676 <p>Available since 3.5.0</p> |
|
7677 |
|
7678 </div> |
|
7679 |
|
7680 <div class="description"> |
|
7681 <p>Populates the <code>_yScrollHeader</code> property by creating the <code><table></code> Node |
|
7682 described by the <code>_Y_SCROLL_HEADER_TEMPLATE</code>.</p> |
|
7683 </div> |
|
7684 |
|
7685 |
|
7686 |
|
7687 |
|
7688 <div class="returns"> |
|
7689 <h4>Returns:</h4> |
|
7690 |
|
7691 <div class="returns-description"> |
|
7692 |
|
7693 |
|
7694 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
7695 |
|
7696 The created Node |
|
7697 |
|
7698 </div> |
|
7699 </div> |
|
7700 |
|
7701 |
|
7702 |
|
7703 </div> |
|
7704 |
|
7705 |
|
7706 <div id="method__createYScrollNode" class="method item protected"> |
|
7707 <h3 class="name"><code>_createYScrollNode</code></h3> |
|
7708 |
|
7709 |
|
7710 <span class="paren">()</span> |
|
7711 |
|
7712 |
|
7713 |
|
7714 <span class="returns-inline"> |
|
7715 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
7716 </span> |
|
7717 |
|
7718 |
|
7719 |
|
7720 |
|
7721 |
|
7722 <span class="flag protected">protected</span> |
|
7723 |
|
7724 |
|
7725 |
|
7726 |
|
7727 |
|
7728 |
|
7729 |
|
7730 |
|
7731 |
|
7732 |
|
7733 <div class="meta"> |
|
7734 |
|
7735 |
|
7736 |
|
7737 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
7738 |
|
7739 <p> |
|
7740 |
|
7741 Defined in |
|
7742 |
|
7743 |
|
7744 |
|
7745 |
|
7746 <a href="../files/datatable_js_scroll.js.html#l518"><code>datatable/js/scroll.js:518</code></a> |
|
7747 |
|
7748 </p> |
|
7749 |
|
7750 |
|
7751 |
|
7752 |
|
7753 |
|
7754 <p>Available since 3.5.0</p> |
|
7755 |
|
7756 </div> |
|
7757 |
|
7758 <div class="description"> |
|
7759 <p>Populates the <code>_yScrollNode</code> property by creating the <code><div></code> Node described |
|
7760 by the <code>_Y_SCROLLER_TEMPLATE</code>.</p> |
|
7761 </div> |
|
7762 |
|
7763 |
|
7764 |
|
7765 |
|
7766 <div class="returns"> |
|
7767 <h4>Returns:</h4> |
|
7768 |
|
7769 <div class="returns-description"> |
|
7770 |
|
7771 |
|
7772 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
7773 |
|
7774 The created Node |
|
7775 |
|
7776 </div> |
|
7777 </div> |
|
7778 |
|
7779 |
|
7780 |
|
7781 </div> |
|
7782 |
|
7783 |
|
7784 <div id="method__defAddColumnFn" class="method item protected"> |
|
7785 <h3 class="name"><code>_defAddColumnFn</code></h3> |
|
7786 |
|
7787 |
|
7788 <div class="args"> |
|
7789 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7790 |
|
7791 <li class="arg"> |
|
7792 |
|
7793 <code>e</code> |
|
7794 |
|
7795 </li> |
|
7796 |
|
7797 </ul><span class="paren">)</span> |
|
7798 </div> |
|
7799 |
|
7800 |
|
7801 |
|
7802 |
|
7803 |
|
7804 |
|
7805 |
|
7806 <span class="flag protected">protected</span> |
|
7807 |
|
7808 |
|
7809 |
|
7810 |
|
7811 |
|
7812 |
|
7813 |
|
7814 |
|
7815 |
|
7816 |
|
7817 <div class="meta"> |
|
7818 |
|
7819 |
|
7820 |
|
7821 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
7822 |
|
7823 <p> |
|
7824 |
|
7825 Defined in |
|
7826 |
|
7827 |
|
7828 |
|
7829 |
|
7830 <a href="../files/datatable_js_mutable.js.html#l394"><code>datatable/js/mutable.js:394</code></a> |
|
7831 |
|
7832 </p> |
|
7833 |
|
7834 |
|
7835 |
|
7836 |
|
7837 |
|
7838 <p>Available since 3.5.0</p> |
|
7839 |
|
7840 </div> |
|
7841 |
|
7842 <div class="description"> |
|
7843 <p>Default function for the <code>addColumn</code> event.</p> |
|
7844 |
|
7845 <p>Inserts the specified column at the provided index.</p> |
|
7846 </div> |
|
7847 |
|
7848 |
|
7849 <div class="params"> |
|
7850 <h4>Parameters:</h4> |
|
7851 |
|
7852 <ul class="params-list"> |
|
7853 |
|
7854 <li class="param"> |
|
7855 |
|
7856 <code class="param-name">e</code> |
|
7857 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
7858 |
|
7859 |
|
7860 |
|
7861 |
|
7862 <div class="param-description"> |
|
7863 <p>The <code>addColumn</code> event</p> |
|
7864 </div> |
|
7865 |
|
7866 |
|
7867 <ul class="params-list"> |
|
7868 |
|
7869 <li class="param"> |
|
7870 |
|
7871 <code class="param-name">column</code> |
|
7872 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7873 |
|
7874 |
|
7875 <div class="param-description"> |
|
7876 <p>The new column definition object</p> |
|
7877 </div> |
|
7878 |
|
7879 |
|
7880 </li> |
|
7881 |
|
7882 <li class="param"> |
|
7883 |
|
7884 <code class="param-name">index</code> |
|
7885 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span> |
|
7886 |
|
7887 |
|
7888 <div class="param-description"> |
|
7889 <p>The array index to insert the new column</p> |
|
7890 </div> |
|
7891 |
|
7892 |
|
7893 </li> |
|
7894 |
|
7895 </ul> |
|
7896 |
|
7897 </li> |
|
7898 |
|
7899 </ul> |
|
7900 </div> |
|
7901 |
|
7902 |
|
7903 |
|
7904 |
|
7905 |
|
7906 </div> |
|
7907 |
|
7908 |
|
7909 <div id="method__defAttrChangeFn" class="method item private inherited"> |
|
7910 <h3 class="name"><code>_defAttrChangeFn</code></h3> |
|
7911 |
|
7912 |
|
7913 <div class="args"> |
|
7914 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7915 |
|
7916 <li class="arg"> |
|
7917 |
|
7918 <code>e</code> |
|
7919 |
|
7920 </li> |
|
7921 |
|
7922 </ul><span class="paren">)</span> |
|
7923 </div> |
|
7924 |
|
7925 |
|
7926 |
|
7927 |
|
7928 |
|
7929 |
|
7930 |
|
7931 <span class="flag private">private</span> |
|
7932 |
|
7933 |
|
7934 |
|
7935 |
|
7936 |
|
7937 |
|
7938 |
|
7939 |
|
7940 |
|
7941 |
|
7942 <div class="meta"> |
|
7943 |
|
7944 |
|
7945 <p>Inherited from |
|
7946 <a href="../classes/AttributeObservable.html#method__defAttrChangeFn">AttributeObservable</a>: |
|
7947 |
|
7948 |
|
7949 |
|
7950 <a href="../files/attribute_js_AttributeObservable.js.html#l186"><code>attribute/js/AttributeObservable.js:186</code></a> |
|
7951 |
|
7952 </p> |
|
7953 |
|
7954 |
|
7955 |
|
7956 |
|
7957 |
|
7958 </div> |
|
7959 |
|
7960 <div class="description"> |
|
7961 <p>Default function for attribute change events.</p> |
|
7962 </div> |
|
7963 |
|
7964 |
|
7965 <div class="params"> |
|
7966 <h4>Parameters:</h4> |
|
7967 |
|
7968 <ul class="params-list"> |
|
7969 |
|
7970 <li class="param"> |
|
7971 |
|
7972 <code class="param-name">e</code> |
|
7973 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
7974 |
|
7975 |
|
7976 |
|
7977 |
|
7978 <div class="param-description"> |
|
7979 <p>The event object for attribute change events.</p> |
|
7980 </div> |
|
7981 |
|
7982 |
|
7983 </li> |
|
7984 |
|
7985 </ul> |
|
7986 </div> |
|
7987 |
|
7988 |
|
7989 |
|
7990 |
|
7991 |
|
7992 </div> |
|
7993 |
|
7994 |
|
7995 <div id="method__defaultCB" class="method item protected inherited"> |
|
7996 <h3 class="name"><code>_defaultCB</code></h3> |
|
7997 |
|
7998 |
|
7999 <span class="paren">()</span> |
|
8000 |
|
8001 |
|
8002 |
|
8003 |
|
8004 |
|
8005 |
|
8006 |
|
8007 <span class="flag protected">protected</span> |
|
8008 |
|
8009 |
|
8010 |
|
8011 |
|
8012 |
|
8013 |
|
8014 |
|
8015 |
|
8016 |
|
8017 |
|
8018 <div class="meta"> |
|
8019 |
|
8020 |
|
8021 <p>Inherited from |
|
8022 <a href="../classes/Widget.html#method__defaultCB">Widget</a>: |
|
8023 |
|
8024 |
|
8025 |
|
8026 <a href="../files/widget_js_Widget.js.html#l780"><code>widget/js/Widget.js:780</code></a> |
|
8027 |
|
8028 </p> |
|
8029 |
|
8030 |
|
8031 |
|
8032 |
|
8033 |
|
8034 </div> |
|
8035 |
|
8036 <div class="description"> |
|
8037 <p>Returns the default value for the contentBox attribute.</p> |
|
8038 |
|
8039 <p>For the Widget class, this will be the srcNode if provided, otherwise null (resulting in |
|
8040 a new contentBox node instance being created)</p> |
|
8041 </div> |
|
8042 |
|
8043 |
|
8044 |
|
8045 |
|
8046 |
|
8047 |
|
8048 </div> |
|
8049 |
|
8050 |
|
8051 <div id="method__defDestroyFn" class="method item protected inherited"> |
|
8052 <h3 class="name"><code>_defDestroyFn</code></h3> |
|
8053 |
|
8054 |
|
8055 <div class="args"> |
|
8056 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8057 |
|
8058 <li class="arg"> |
|
8059 |
|
8060 <code>e</code> |
|
8061 |
|
8062 </li> |
|
8063 |
|
8064 </ul><span class="paren">)</span> |
|
8065 </div> |
|
8066 |
|
8067 |
|
8068 |
|
8069 |
|
8070 |
|
8071 |
|
8072 |
|
8073 <span class="flag protected">protected</span> |
|
8074 |
|
8075 |
|
8076 |
|
8077 |
|
8078 |
|
8079 |
|
8080 |
|
8081 |
|
8082 |
|
8083 |
|
8084 <div class="meta"> |
|
8085 |
|
8086 |
|
8087 <p>Inherited from |
|
8088 <a href="../classes/BaseObservable.html#method__defDestroyFn">BaseObservable</a>: |
|
8089 |
|
8090 |
|
8091 |
|
8092 <a href="../files/base_js_BaseObservable.js.html#l190"><code>base/js/BaseObservable.js:190</code></a> |
|
8093 |
|
8094 </p> |
|
8095 |
|
8096 |
|
8097 |
|
8098 |
|
8099 |
|
8100 </div> |
|
8101 |
|
8102 <div class="description"> |
|
8103 <p>Default destroy event handler</p> |
|
8104 </div> |
|
8105 |
|
8106 |
|
8107 <div class="params"> |
|
8108 <h4>Parameters:</h4> |
|
8109 |
|
8110 <ul class="params-list"> |
|
8111 |
|
8112 <li class="param"> |
|
8113 |
|
8114 <code class="param-name">e</code> |
|
8115 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
8116 |
|
8117 |
|
8118 |
|
8119 |
|
8120 <div class="param-description"> |
|
8121 <p>Event object</p> |
|
8122 </div> |
|
8123 |
|
8124 |
|
8125 </li> |
|
8126 |
|
8127 </ul> |
|
8128 </div> |
|
8129 |
|
8130 |
|
8131 |
|
8132 |
|
8133 |
|
8134 </div> |
|
8135 |
|
8136 |
|
8137 <div id="method__defInitFn" class="method item protected inherited"> |
|
8138 <h3 class="name"><code>_defInitFn</code></h3> |
|
8139 |
|
8140 |
|
8141 <div class="args"> |
|
8142 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8143 |
|
8144 <li class="arg"> |
|
8145 |
|
8146 <code>e</code> |
|
8147 |
|
8148 </li> |
|
8149 |
|
8150 </ul><span class="paren">)</span> |
|
8151 </div> |
|
8152 |
|
8153 |
|
8154 |
|
8155 |
|
8156 |
|
8157 |
|
8158 |
|
8159 <span class="flag protected">protected</span> |
|
8160 |
|
8161 |
|
8162 |
|
8163 |
|
8164 |
|
8165 |
|
8166 |
|
8167 |
|
8168 |
|
8169 |
|
8170 <div class="meta"> |
|
8171 |
|
8172 |
|
8173 <p>Inherited from |
|
8174 <a href="../classes/BaseObservable.html#method__defInitFn">BaseObservable</a>: |
|
8175 |
|
8176 |
|
8177 |
|
8178 <a href="../files/base_js_BaseObservable.js.html#l178"><code>base/js/BaseObservable.js:178</code></a> |
|
8179 |
|
8180 </p> |
|
8181 |
|
8182 |
|
8183 |
|
8184 |
|
8185 |
|
8186 </div> |
|
8187 |
|
8188 <div class="description"> |
|
8189 <p>Default init event handler</p> |
|
8190 </div> |
|
8191 |
|
8192 |
|
8193 <div class="params"> |
|
8194 <h4>Parameters:</h4> |
|
8195 |
|
8196 <ul class="params-list"> |
|
8197 |
|
8198 <li class="param"> |
|
8199 |
|
8200 <code class="param-name">e</code> |
|
8201 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
8202 |
|
8203 |
|
8204 |
|
8205 |
|
8206 <div class="param-description"> |
|
8207 <p>Event object, with a cfg property which |
|
8208 refers to the configuration object passed to the constructor.</p> |
|
8209 </div> |
|
8210 |
|
8211 |
|
8212 </li> |
|
8213 |
|
8214 </ul> |
|
8215 </div> |
|
8216 |
|
8217 |
|
8218 |
|
8219 |
|
8220 |
|
8221 </div> |
|
8222 |
|
8223 |
|
8224 <div id="method__defModifyColumnFn" class="method item protected"> |
|
8225 <h3 class="name"><code>_defModifyColumnFn</code></h3> |
|
8226 |
|
8227 |
|
8228 <div class="args"> |
|
8229 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8230 |
|
8231 <li class="arg"> |
|
8232 |
|
8233 <code>e</code> |
|
8234 |
|
8235 </li> |
|
8236 |
|
8237 </ul><span class="paren">)</span> |
|
8238 </div> |
|
8239 |
|
8240 |
|
8241 |
|
8242 |
|
8243 |
|
8244 |
|
8245 |
|
8246 <span class="flag protected">protected</span> |
|
8247 |
|
8248 |
|
8249 |
|
8250 |
|
8251 |
|
8252 |
|
8253 |
|
8254 |
|
8255 |
|
8256 |
|
8257 <div class="meta"> |
|
8258 |
|
8259 |
|
8260 |
|
8261 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
8262 |
|
8263 <p> |
|
8264 |
|
8265 Defined in |
|
8266 |
|
8267 |
|
8268 |
|
8269 |
|
8270 <a href="../files/datatable_js_mutable.js.html#l424"><code>datatable/js/mutable.js:424</code></a> |
|
8271 |
|
8272 </p> |
|
8273 |
|
8274 |
|
8275 |
|
8276 |
|
8277 |
|
8278 <p>Available since 3.5.0</p> |
|
8279 |
|
8280 </div> |
|
8281 |
|
8282 <div class="description"> |
|
8283 <p>Default function for the <code>modifyColumn</code> event.</p> |
|
8284 |
|
8285 <p>Mixes the new column properties into the specified column definition.</p> |
|
8286 </div> |
|
8287 |
|
8288 |
|
8289 <div class="params"> |
|
8290 <h4>Parameters:</h4> |
|
8291 |
|
8292 <ul class="params-list"> |
|
8293 |
|
8294 <li class="param"> |
|
8295 |
|
8296 <code class="param-name">e</code> |
|
8297 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
8298 |
|
8299 |
|
8300 |
|
8301 |
|
8302 <div class="param-description"> |
|
8303 <p>The <code>modifyColumn</code> event</p> |
|
8304 </div> |
|
8305 |
|
8306 |
|
8307 <ul class="params-list"> |
|
8308 |
|
8309 <li class="param"> |
|
8310 |
|
8311 <code class="param-name">column</code> |
|
8312 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span> |
|
8313 |
|
8314 |
|
8315 <div class="param-description"> |
|
8316 <p>The column definition object or identifier</p> |
|
8317 </div> |
|
8318 |
|
8319 |
|
8320 </li> |
|
8321 |
|
8322 <li class="param"> |
|
8323 |
|
8324 <code class="param-name">newColumnDef</code> |
|
8325 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8326 |
|
8327 |
|
8328 <div class="param-description"> |
|
8329 <p>The properties to assign to the column</p> |
|
8330 </div> |
|
8331 |
|
8332 |
|
8333 </li> |
|
8334 |
|
8335 </ul> |
|
8336 |
|
8337 </li> |
|
8338 |
|
8339 </ul> |
|
8340 </div> |
|
8341 |
|
8342 |
|
8343 |
|
8344 |
|
8345 |
|
8346 </div> |
|
8347 |
|
8348 |
|
8349 <div id="method__defMoveColumnFn" class="method item protected"> |
|
8350 <h3 class="name"><code>_defMoveColumnFn</code></h3> |
|
8351 |
|
8352 |
|
8353 <div class="args"> |
|
8354 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8355 |
|
8356 <li class="arg"> |
|
8357 |
|
8358 <code>e</code> |
|
8359 |
|
8360 </li> |
|
8361 |
|
8362 </ul><span class="paren">)</span> |
|
8363 </div> |
|
8364 |
|
8365 |
|
8366 |
|
8367 |
|
8368 |
|
8369 |
|
8370 |
|
8371 <span class="flag protected">protected</span> |
|
8372 |
|
8373 |
|
8374 |
|
8375 |
|
8376 |
|
8377 |
|
8378 |
|
8379 |
|
8380 |
|
8381 |
|
8382 <div class="meta"> |
|
8383 |
|
8384 |
|
8385 |
|
8386 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
8387 |
|
8388 <p> |
|
8389 |
|
8390 Defined in |
|
8391 |
|
8392 |
|
8393 |
|
8394 |
|
8395 <a href="../files/datatable_js_mutable.js.html#l448"><code>datatable/js/mutable.js:448</code></a> |
|
8396 |
|
8397 </p> |
|
8398 |
|
8399 |
|
8400 |
|
8401 |
|
8402 |
|
8403 <p>Available since 3.5.0</p> |
|
8404 |
|
8405 </div> |
|
8406 |
|
8407 <div class="description"> |
|
8408 <p>Default function for the <code>moveColumn</code> event.</p> |
|
8409 |
|
8410 <p>Removes the specified column from its current location and inserts it at the |
|
8411 specified array index (may be an array of indexes for nested headers).</p> |
|
8412 </div> |
|
8413 |
|
8414 |
|
8415 <div class="params"> |
|
8416 <h4>Parameters:</h4> |
|
8417 |
|
8418 <ul class="params-list"> |
|
8419 |
|
8420 <li class="param"> |
|
8421 |
|
8422 <code class="param-name">e</code> |
|
8423 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
8424 |
|
8425 |
|
8426 |
|
8427 |
|
8428 <div class="param-description"> |
|
8429 <p>The <code>moveColumn</code> event</p> |
|
8430 </div> |
|
8431 |
|
8432 |
|
8433 <ul class="params-list"> |
|
8434 |
|
8435 <li class="param"> |
|
8436 |
|
8437 <code class="param-name">column</code> |
|
8438 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span> |
|
8439 |
|
8440 |
|
8441 <div class="param-description"> |
|
8442 <p>The column definition object or identifier</p> |
|
8443 </div> |
|
8444 |
|
8445 |
|
8446 </li> |
|
8447 |
|
8448 <li class="param"> |
|
8449 |
|
8450 <code class="param-name">index</code> |
|
8451 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8452 |
|
8453 |
|
8454 <div class="param-description"> |
|
8455 <p>The destination index to move to</p> |
|
8456 </div> |
|
8457 |
|
8458 |
|
8459 </li> |
|
8460 |
|
8461 </ul> |
|
8462 |
|
8463 </li> |
|
8464 |
|
8465 </ul> |
|
8466 </div> |
|
8467 |
|
8468 |
|
8469 |
|
8470 |
|
8471 |
|
8472 </div> |
|
8473 |
|
8474 |
|
8475 <div id="method__defRemoveColumnFn" class="method item protected"> |
|
8476 <h3 class="name"><code>_defRemoveColumnFn</code></h3> |
|
8477 |
|
8478 |
|
8479 <div class="args"> |
|
8480 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8481 |
|
8482 <li class="arg"> |
|
8483 |
|
8484 <code>e</code> |
|
8485 |
|
8486 </li> |
|
8487 |
|
8488 </ul><span class="paren">)</span> |
|
8489 </div> |
|
8490 |
|
8491 |
|
8492 |
|
8493 |
|
8494 |
|
8495 |
|
8496 |
|
8497 <span class="flag protected">protected</span> |
|
8498 |
|
8499 |
|
8500 |
|
8501 |
|
8502 |
|
8503 |
|
8504 |
|
8505 |
|
8506 |
|
8507 |
|
8508 <div class="meta"> |
|
8509 |
|
8510 |
|
8511 |
|
8512 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
8513 |
|
8514 <p> |
|
8515 |
|
8516 Defined in |
|
8517 |
|
8518 |
|
8519 |
|
8520 |
|
8521 <a href="../files/datatable_js_mutable.js.html#l501"><code>datatable/js/mutable.js:501</code></a> |
|
8522 |
|
8523 </p> |
|
8524 |
|
8525 |
|
8526 |
|
8527 |
|
8528 |
|
8529 <p>Available since 3.5.0</p> |
|
8530 |
|
8531 </div> |
|
8532 |
|
8533 <div class="description"> |
|
8534 <p>Default function for the <code>removeColumn</code> event.</p> |
|
8535 |
|
8536 <p>Splices the specified column from its containing columns array.</p> |
|
8537 </div> |
|
8538 |
|
8539 |
|
8540 <div class="params"> |
|
8541 <h4>Parameters:</h4> |
|
8542 |
|
8543 <ul class="params-list"> |
|
8544 |
|
8545 <li class="param"> |
|
8546 |
|
8547 <code class="param-name">e</code> |
|
8548 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
8549 |
|
8550 |
|
8551 |
|
8552 |
|
8553 <div class="param-description"> |
|
8554 <p>The <code>removeColumn</code> event</p> |
|
8555 </div> |
|
8556 |
|
8557 |
|
8558 <ul class="params-list"> |
|
8559 |
|
8560 <li class="param"> |
|
8561 |
|
8562 <code class="param-name">column</code> |
|
8563 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span> |
|
8564 |
|
8565 |
|
8566 <div class="param-description"> |
|
8567 <p>The column definition object or identifier</p> |
|
8568 </div> |
|
8569 |
|
8570 |
|
8571 </li> |
|
8572 |
|
8573 </ul> |
|
8574 |
|
8575 </li> |
|
8576 |
|
8577 </ul> |
|
8578 </div> |
|
8579 |
|
8580 |
|
8581 |
|
8582 |
|
8583 |
|
8584 </div> |
|
8585 |
|
8586 |
|
8587 <div id="method__defRenderFn" class="method item protected inherited"> |
|
8588 <h3 class="name"><code>_defRenderFn</code></h3> |
|
8589 |
|
8590 |
|
8591 <div class="args"> |
|
8592 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8593 |
|
8594 <li class="arg"> |
|
8595 |
|
8596 <code>e</code> |
|
8597 |
|
8598 </li> |
|
8599 |
|
8600 <li class="arg"> |
|
8601 |
|
8602 <code>parentNode</code> |
|
8603 |
|
8604 </li> |
|
8605 |
|
8606 </ul><span class="paren">)</span> |
|
8607 </div> |
|
8608 |
|
8609 |
|
8610 |
|
8611 |
|
8612 |
|
8613 |
|
8614 |
|
8615 <span class="flag protected">protected</span> |
|
8616 |
|
8617 |
|
8618 |
|
8619 |
|
8620 |
|
8621 |
|
8622 |
|
8623 |
|
8624 |
|
8625 |
|
8626 <div class="meta"> |
|
8627 |
|
8628 |
|
8629 <p>Inherited from |
|
8630 <a href="../classes/Widget.html#method__defRenderFn">Widget</a>: |
|
8631 |
|
8632 |
|
8633 |
|
8634 <a href="../files/widget_js_Widget.js.html#l571"><code>widget/js/Widget.js:571</code></a> |
|
8635 |
|
8636 </p> |
|
8637 |
|
8638 |
|
8639 |
|
8640 |
|
8641 |
|
8642 </div> |
|
8643 |
|
8644 <div class="description"> |
|
8645 <p>Default render handler</p> |
|
8646 </div> |
|
8647 |
|
8648 |
|
8649 <div class="params"> |
|
8650 <h4>Parameters:</h4> |
|
8651 |
|
8652 <ul class="params-list"> |
|
8653 |
|
8654 <li class="param"> |
|
8655 |
|
8656 <code class="param-name">e</code> |
|
8657 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
8658 |
|
8659 |
|
8660 |
|
8661 |
|
8662 <div class="param-description"> |
|
8663 <p>The Event object</p> |
|
8664 </div> |
|
8665 |
|
8666 |
|
8667 </li> |
|
8668 |
|
8669 <li class="param"> |
|
8670 |
|
8671 <code class="param-name">parentNode</code> |
|
8672 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
8673 |
|
8674 |
|
8675 |
|
8676 |
|
8677 <div class="param-description"> |
|
8678 <p>The parent node to render to, if passed in to the <code>render</code> method</p> |
|
8679 </div> |
|
8680 |
|
8681 |
|
8682 </li> |
|
8683 |
|
8684 </ul> |
|
8685 </div> |
|
8686 |
|
8687 |
|
8688 |
|
8689 |
|
8690 |
|
8691 </div> |
|
8692 |
|
8693 |
|
8694 <div id="method__defRenderViewFn" class="method item protected inherited"> |
|
8695 <h3 class="name"><code>_defRenderViewFn</code></h3> |
|
8696 |
|
8697 |
|
8698 <div class="args"> |
|
8699 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8700 |
|
8701 <li class="arg"> |
|
8702 |
|
8703 <code>e</code> |
|
8704 |
|
8705 </li> |
|
8706 |
|
8707 </ul><span class="paren">)</span> |
|
8708 </div> |
|
8709 |
|
8710 |
|
8711 |
|
8712 |
|
8713 |
|
8714 |
|
8715 |
|
8716 <span class="flag protected">protected</span> |
|
8717 |
|
8718 |
|
8719 |
|
8720 |
|
8721 |
|
8722 |
|
8723 |
|
8724 |
|
8725 |
|
8726 |
|
8727 <div class="meta"> |
|
8728 |
|
8729 |
|
8730 <p>Inherited from |
|
8731 <a href="../classes/DataTable.Base.html#method__defRenderViewFn">DataTable.Base</a>: |
|
8732 |
|
8733 |
|
8734 |
|
8735 <a href="../files/datatable_js_base.js.html#l336"><code>datatable/js/base.js:336</code></a> |
|
8736 |
|
8737 </p> |
|
8738 |
|
8739 |
|
8740 |
|
8741 |
|
8742 |
|
8743 </div> |
|
8744 |
|
8745 <div class="description"> |
|
8746 <p>The default behavior of the <code>renderView</code> event. Calls <code>render()</code> on the |
|
8747 <code>View</code> instance on the event.</p> |
|
8748 </div> |
|
8749 |
|
8750 |
|
8751 <div class="params"> |
|
8752 <h4>Parameters:</h4> |
|
8753 |
|
8754 <ul class="params-list"> |
|
8755 |
|
8756 <li class="param"> |
|
8757 |
|
8758 <code class="param-name">e</code> |
|
8759 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
8760 |
|
8761 |
|
8762 |
|
8763 |
|
8764 <div class="param-description"> |
|
8765 <p>The <code>renderView</code> event</p> |
|
8766 </div> |
|
8767 |
|
8768 |
|
8769 </li> |
|
8770 |
|
8771 </ul> |
|
8772 </div> |
|
8773 |
|
8774 |
|
8775 |
|
8776 |
|
8777 |
|
8778 </div> |
|
8779 |
|
8780 |
|
8781 <div id="method__defSortFn" class="method item protected"> |
|
8782 <h3 class="name"><code>_defSortFn</code></h3> |
|
8783 |
|
8784 |
|
8785 <div class="args"> |
|
8786 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8787 |
|
8788 <li class="arg"> |
|
8789 |
|
8790 <code>e</code> |
|
8791 |
|
8792 </li> |
|
8793 |
|
8794 </ul><span class="paren">)</span> |
|
8795 </div> |
|
8796 |
|
8797 |
|
8798 |
|
8799 |
|
8800 |
|
8801 |
|
8802 |
|
8803 <span class="flag protected">protected</span> |
|
8804 |
|
8805 |
|
8806 |
|
8807 |
|
8808 |
|
8809 |
|
8810 |
|
8811 |
|
8812 |
|
8813 |
|
8814 <div class="meta"> |
|
8815 |
|
8816 |
|
8817 |
|
8818 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
8819 |
|
8820 <p> |
|
8821 |
|
8822 Defined in |
|
8823 |
|
8824 |
|
8825 |
|
8826 |
|
8827 <a href="../files/datatable_js_sort.js.html#l376"><code>datatable/js/sort.js:376</code></a> |
|
8828 |
|
8829 </p> |
|
8830 |
|
8831 |
|
8832 |
|
8833 |
|
8834 |
|
8835 <p>Available since 3.5.0</p> |
|
8836 |
|
8837 </div> |
|
8838 |
|
8839 <div class="description"> |
|
8840 <p>Sets the <code>sortBy</code> attribute from the <code>sort</code> event's <code>e.sortBy</code> value.</p> |
|
8841 </div> |
|
8842 |
|
8843 |
|
8844 <div class="params"> |
|
8845 <h4>Parameters:</h4> |
|
8846 |
|
8847 <ul class="params-list"> |
|
8848 |
|
8849 <li class="param"> |
|
8850 |
|
8851 <code class="param-name">e</code> |
|
8852 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
8853 |
|
8854 |
|
8855 |
|
8856 |
|
8857 <div class="param-description"> |
|
8858 <p>The <code>sort</code> event</p> |
|
8859 </div> |
|
8860 |
|
8861 |
|
8862 </li> |
|
8863 |
|
8864 </ul> |
|
8865 </div> |
|
8866 |
|
8867 |
|
8868 |
|
8869 |
|
8870 |
|
8871 </div> |
|
8872 |
|
8873 |
|
8874 <div id="method__destroyBox" class="method item protected inherited"> |
|
8875 <h3 class="name"><code>_destroyBox</code></h3> |
|
8876 |
|
8877 |
|
8878 <span class="paren">()</span> |
|
8879 |
|
8880 |
|
8881 |
|
8882 |
|
8883 |
|
8884 |
|
8885 |
|
8886 <span class="flag protected">protected</span> |
|
8887 |
|
8888 |
|
8889 |
|
8890 |
|
8891 |
|
8892 |
|
8893 |
|
8894 |
|
8895 |
|
8896 |
|
8897 <div class="meta"> |
|
8898 |
|
8899 |
|
8900 <p>Inherited from |
|
8901 <a href="../classes/Widget.html#method__destroyBox">Widget</a>: |
|
8902 |
|
8903 |
|
8904 |
|
8905 <a href="../files/widget_js_Widget.js.html#l476"><code>widget/js/Widget.js:476</code></a> |
|
8906 |
|
8907 </p> |
|
8908 |
|
8909 |
|
8910 |
|
8911 |
|
8912 |
|
8913 </div> |
|
8914 |
|
8915 <div class="description"> |
|
8916 <p>Removes and destroys the widgets rendered boundingBox, contentBox, |
|
8917 and detaches bound UI events.</p> |
|
8918 </div> |
|
8919 |
|
8920 |
|
8921 |
|
8922 |
|
8923 |
|
8924 |
|
8925 </div> |
|
8926 |
|
8927 |
|
8928 <div id="method__destroyHierarchy" class="method item private inherited"> |
|
8929 <h3 class="name"><code>_destroyHierarchy</code></h3> |
|
8930 |
|
8931 |
|
8932 <span class="paren">()</span> |
|
8933 |
|
8934 |
|
8935 |
|
8936 |
|
8937 |
|
8938 |
|
8939 |
|
8940 <span class="flag private">private</span> |
|
8941 |
|
8942 |
|
8943 |
|
8944 |
|
8945 |
|
8946 |
|
8947 |
|
8948 |
|
8949 |
|
8950 |
|
8951 <div class="meta"> |
|
8952 |
|
8953 |
|
8954 <p>Inherited from |
|
8955 <a href="../classes/BaseCore.html#method__destroyHierarchy">BaseCore</a>: |
|
8956 |
|
8957 |
|
8958 |
|
8959 <a href="../files/base_js_BaseCore.js.html#l721"><code>base/js/BaseCore.js:721</code></a> |
|
8960 |
|
8961 </p> |
|
8962 |
|
8963 |
|
8964 |
|
8965 |
|
8966 |
|
8967 </div> |
|
8968 |
|
8969 <div class="description"> |
|
8970 <p>Destroys the class hierarchy for this instance by invoking |
|
8971 the destructor method on the prototype of each class in the hierarchy.</p> |
|
8972 </div> |
|
8973 |
|
8974 |
|
8975 |
|
8976 |
|
8977 |
|
8978 |
|
8979 </div> |
|
8980 |
|
8981 |
|
8982 <div id="method__destroyUIEvents" class="method item private inherited"> |
|
8983 <h3 class="name"><code>_destroyUIEvents</code></h3> |
|
8984 |
|
8985 |
|
8986 <span class="paren">()</span> |
|
8987 |
|
8988 |
|
8989 |
|
8990 |
|
8991 |
|
8992 |
|
8993 |
|
8994 <span class="flag private">private</span> |
|
8995 |
|
8996 |
|
8997 |
|
8998 |
|
8999 |
|
9000 |
|
9001 |
|
9002 |
|
9003 |
|
9004 |
|
9005 <div class="meta"> |
|
9006 |
|
9007 |
|
9008 <p>Inherited from |
|
9009 <a href="../classes/Widget.html#method__destroyUIEvents">Widget</a>: |
|
9010 |
|
9011 |
|
9012 |
|
9013 <a href="../files/widget_js_WidgetUIEvents.js.html#l20"><code>widget/js/WidgetUIEvents.js:20</code></a> |
|
9014 |
|
9015 </p> |
|
9016 |
|
9017 |
|
9018 |
|
9019 |
|
9020 |
|
9021 </div> |
|
9022 |
|
9023 <div class="description"> |
|
9024 <p>Destructor logic for UI event infrastructure, |
|
9025 invoked during Widget destruction.</p> |
|
9026 </div> |
|
9027 |
|
9028 |
|
9029 |
|
9030 |
|
9031 |
|
9032 |
|
9033 </div> |
|
9034 |
|
9035 |
|
9036 <div id="method__disableScrolling" class="method item protected"> |
|
9037 <h3 class="name"><code>_disableScrolling</code></h3> |
|
9038 |
|
9039 |
|
9040 <span class="paren">()</span> |
|
9041 |
|
9042 |
|
9043 |
|
9044 |
|
9045 |
|
9046 |
|
9047 |
|
9048 <span class="flag protected">protected</span> |
|
9049 |
|
9050 |
|
9051 |
|
9052 |
|
9053 |
|
9054 |
|
9055 |
|
9056 |
|
9057 |
|
9058 |
|
9059 <div class="meta"> |
|
9060 |
|
9061 |
|
9062 |
|
9063 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
9064 |
|
9065 <p> |
|
9066 |
|
9067 Defined in |
|
9068 |
|
9069 |
|
9070 |
|
9071 |
|
9072 <a href="../files/datatable_js_scroll.js.html#l546"><code>datatable/js/scroll.js:546</code></a> |
|
9073 |
|
9074 </p> |
|
9075 |
|
9076 |
|
9077 |
|
9078 |
|
9079 |
|
9080 <p>Available since 3.5.0</p> |
|
9081 |
|
9082 </div> |
|
9083 |
|
9084 <div class="description"> |
|
9085 <p>Removes the nodes used to create horizontal and vertical scrolling and |
|
9086 rejoins the caption to the main table if needed.</p> |
|
9087 </div> |
|
9088 |
|
9089 |
|
9090 |
|
9091 |
|
9092 |
|
9093 |
|
9094 </div> |
|
9095 |
|
9096 |
|
9097 <div id="method__disableXScrolling" class="method item protected"> |
|
9098 <h3 class="name"><code>_disableXScrolling</code></h3> |
|
9099 |
|
9100 |
|
9101 <span class="paren">()</span> |
|
9102 |
|
9103 |
|
9104 |
|
9105 |
|
9106 |
|
9107 |
|
9108 |
|
9109 <span class="flag protected">protected</span> |
|
9110 |
|
9111 |
|
9112 |
|
9113 |
|
9114 |
|
9115 |
|
9116 |
|
9117 |
|
9118 |
|
9119 |
|
9120 <div class="meta"> |
|
9121 |
|
9122 |
|
9123 |
|
9124 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
9125 |
|
9126 <p> |
|
9127 |
|
9128 Defined in |
|
9129 |
|
9130 |
|
9131 |
|
9132 |
|
9133 <a href="../files/datatable_js_scroll.js.html#l563"><code>datatable/js/scroll.js:563</code></a> |
|
9134 |
|
9135 </p> |
|
9136 |
|
9137 |
|
9138 |
|
9139 |
|
9140 |
|
9141 <p>Available since 3.5.0</p> |
|
9142 |
|
9143 </div> |
|
9144 |
|
9145 <div class="description"> |
|
9146 <p>Removes the nodes used to allow horizontal scrolling.</p> |
|
9147 </div> |
|
9148 |
|
9149 |
|
9150 |
|
9151 |
|
9152 |
|
9153 |
|
9154 </div> |
|
9155 |
|
9156 |
|
9157 <div id="method__disableYScrolling" class="method item protected"> |
|
9158 <h3 class="name"><code>_disableYScrolling</code></h3> |
|
9159 |
|
9160 |
|
9161 <span class="paren">()</span> |
|
9162 |
|
9163 |
|
9164 |
|
9165 |
|
9166 |
|
9167 |
|
9168 |
|
9169 <span class="flag protected">protected</span> |
|
9170 |
|
9171 |
|
9172 |
|
9173 |
|
9174 |
|
9175 |
|
9176 |
|
9177 |
|
9178 |
|
9179 |
|
9180 <div class="meta"> |
|
9181 |
|
9182 |
|
9183 |
|
9184 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
9185 |
|
9186 <p> |
|
9187 |
|
9188 Defined in |
|
9189 |
|
9190 |
|
9191 |
|
9192 |
|
9193 <a href="../files/datatable_js_scroll.js.html#l574"><code>datatable/js/scroll.js:574</code></a> |
|
9194 |
|
9195 </p> |
|
9196 |
|
9197 |
|
9198 |
|
9199 |
|
9200 |
|
9201 <p>Available since 3.5.0</p> |
|
9202 |
|
9203 </div> |
|
9204 |
|
9205 <div class="description"> |
|
9206 <p>Removes the nodes used to allow vertical scrolling.</p> |
|
9207 </div> |
|
9208 |
|
9209 |
|
9210 |
|
9211 |
|
9212 |
|
9213 |
|
9214 </div> |
|
9215 |
|
9216 |
|
9217 <div id="method__extractDisplayColumns" class="method item protected inherited"> |
|
9218 <h3 class="name"><code>_extractDisplayColumns</code></h3> |
|
9219 |
|
9220 |
|
9221 <div class="args"> |
|
9222 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9223 |
|
9224 <li class="arg"> |
|
9225 |
|
9226 <code>columns</code> |
|
9227 |
|
9228 </li> |
|
9229 |
|
9230 </ul><span class="paren">)</span> |
|
9231 </div> |
|
9232 |
|
9233 |
|
9234 |
|
9235 |
|
9236 |
|
9237 |
|
9238 |
|
9239 <span class="flag protected">protected</span> |
|
9240 |
|
9241 |
|
9242 |
|
9243 |
|
9244 |
|
9245 |
|
9246 |
|
9247 |
|
9248 |
|
9249 |
|
9250 <div class="meta"> |
|
9251 |
|
9252 |
|
9253 <p>Inherited from |
|
9254 <a href="../classes/DataTable.Base.html#method__extractDisplayColumns">DataTable.Base</a>: |
|
9255 |
|
9256 |
|
9257 |
|
9258 <a href="../files/datatable_js_base.js.html#l348"><code>datatable/js/base.js:348</code></a> |
|
9259 |
|
9260 </p> |
|
9261 |
|
9262 |
|
9263 |
|
9264 |
|
9265 |
|
9266 </div> |
|
9267 |
|
9268 <div class="description"> |
|
9269 <p>Processes the full column array, distilling the columns down to those that |
|
9270 correspond to cell data columns.</p> |
|
9271 </div> |
|
9272 |
|
9273 |
|
9274 <div class="params"> |
|
9275 <h4>Parameters:</h4> |
|
9276 |
|
9277 <ul class="params-list"> |
|
9278 |
|
9279 <li class="param"> |
|
9280 |
|
9281 <code class="param-name">columns</code> |
|
9282 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
9283 |
|
9284 |
|
9285 |
|
9286 |
|
9287 <div class="param-description"> |
|
9288 <p>The full set of table columns</p> |
|
9289 </div> |
|
9290 |
|
9291 |
|
9292 </li> |
|
9293 |
|
9294 </ul> |
|
9295 </div> |
|
9296 |
|
9297 |
|
9298 |
|
9299 |
|
9300 |
|
9301 </div> |
|
9302 |
|
9303 |
|
9304 <div id="method__filterAdHocAttrs" class="method item private inherited"> |
|
9305 <h3 class="name"><code>_filterAdHocAttrs</code></h3> |
|
9306 |
|
9307 |
|
9308 <div class="args"> |
|
9309 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9310 |
|
9311 <li class="arg"> |
|
9312 |
|
9313 <code>allAttrs</code> |
|
9314 |
|
9315 </li> |
|
9316 |
|
9317 <li class="arg"> |
|
9318 |
|
9319 <code>userVals</code> |
|
9320 |
|
9321 </li> |
|
9322 |
|
9323 </ul><span class="paren">)</span> |
|
9324 </div> |
|
9325 |
|
9326 |
|
9327 |
|
9328 <span class="returns-inline"> |
|
9329 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9330 </span> |
|
9331 |
|
9332 |
|
9333 |
|
9334 |
|
9335 |
|
9336 <span class="flag private">private</span> |
|
9337 |
|
9338 |
|
9339 |
|
9340 |
|
9341 |
|
9342 |
|
9343 |
|
9344 |
|
9345 |
|
9346 |
|
9347 <div class="meta"> |
|
9348 |
|
9349 |
|
9350 <p>Inherited from |
|
9351 <a href="../classes/BaseCore.html#method__filterAdHocAttrs">BaseCore</a>: |
|
9352 |
|
9353 |
|
9354 |
|
9355 <a href="../files/base_js_BaseCore.js.html#l427"><code>base/js/BaseCore.js:427</code></a> |
|
9356 |
|
9357 </p> |
|
9358 |
|
9359 |
|
9360 |
|
9361 |
|
9362 |
|
9363 </div> |
|
9364 |
|
9365 <div class="description"> |
|
9366 |
|
9367 </div> |
|
9368 |
|
9369 |
|
9370 <div class="params"> |
|
9371 <h4>Parameters:</h4> |
|
9372 |
|
9373 <ul class="params-list"> |
|
9374 |
|
9375 <li class="param"> |
|
9376 |
|
9377 <code class="param-name">allAttrs</code> |
|
9378 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9379 |
|
9380 |
|
9381 |
|
9382 |
|
9383 <div class="param-description"> |
|
9384 <p>The set of all attribute configurations for this instance. |
|
9385 Attributes will be removed from this set, if they belong to the filtered class, so |
|
9386 that by the time all classes are processed, allCfgs will be empty.</p> |
|
9387 </div> |
|
9388 |
|
9389 |
|
9390 </li> |
|
9391 |
|
9392 <li class="param"> |
|
9393 |
|
9394 <code class="param-name">userVals</code> |
|
9395 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9396 |
|
9397 |
|
9398 |
|
9399 |
|
9400 <div class="param-description"> |
|
9401 <p>The config object passed in by the user, from which adhoc attrs are to be filtered.</p> |
|
9402 </div> |
|
9403 |
|
9404 |
|
9405 </li> |
|
9406 |
|
9407 </ul> |
|
9408 </div> |
|
9409 |
|
9410 |
|
9411 |
|
9412 <div class="returns"> |
|
9413 <h4>Returns:</h4> |
|
9414 |
|
9415 <div class="returns-description"> |
|
9416 |
|
9417 |
|
9418 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
9419 |
|
9420 The set of adhoc attributes passed in, in the form |
|
9421 of an object with attribute name/configuration pairs. |
|
9422 |
|
9423 </div> |
|
9424 </div> |
|
9425 |
|
9426 |
|
9427 |
|
9428 </div> |
|
9429 |
|
9430 |
|
9431 <div id="method__filterAttrCfgs" class="method item private inherited"> |
|
9432 <h3 class="name"><code>_filterAttrCfgs</code></h3> |
|
9433 |
|
9434 |
|
9435 <div class="args"> |
|
9436 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9437 |
|
9438 <li class="arg"> |
|
9439 |
|
9440 <code>clazz</code> |
|
9441 |
|
9442 </li> |
|
9443 |
|
9444 <li class="arg"> |
|
9445 |
|
9446 <code>allCfgs</code> |
|
9447 |
|
9448 </li> |
|
9449 |
|
9450 </ul><span class="paren">)</span> |
|
9451 </div> |
|
9452 |
|
9453 |
|
9454 |
|
9455 <span class="returns-inline"> |
|
9456 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9457 </span> |
|
9458 |
|
9459 |
|
9460 |
|
9461 |
|
9462 |
|
9463 <span class="flag private">private</span> |
|
9464 |
|
9465 |
|
9466 |
|
9467 |
|
9468 |
|
9469 |
|
9470 |
|
9471 |
|
9472 |
|
9473 |
|
9474 <div class="meta"> |
|
9475 |
|
9476 |
|
9477 <p>Inherited from |
|
9478 <a href="../classes/BaseCore.html#method__filterAttrCfgs">BaseCore</a>: |
|
9479 |
|
9480 |
|
9481 |
|
9482 <a href="../files/base_js_BaseCore.js.html#l356"><code>base/js/BaseCore.js:356</code></a> |
|
9483 |
|
9484 </p> |
|
9485 |
|
9486 |
|
9487 |
|
9488 |
|
9489 |
|
9490 </div> |
|
9491 |
|
9492 <div class="description"> |
|
9493 <p>A helper method used when processing ATTRS across the class hierarchy during |
|
9494 initialization. Returns a disposable object with the attributes defined for |
|
9495 the provided class, extracted from the set of all attributes passed in.</p> |
|
9496 </div> |
|
9497 |
|
9498 |
|
9499 <div class="params"> |
|
9500 <h4>Parameters:</h4> |
|
9501 |
|
9502 <ul class="params-list"> |
|
9503 |
|
9504 <li class="param"> |
|
9505 |
|
9506 <code class="param-name">clazz</code> |
|
9507 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
9508 |
|
9509 |
|
9510 |
|
9511 |
|
9512 <div class="param-description"> |
|
9513 <p>The class for which the desired attributes are required.</p> |
|
9514 </div> |
|
9515 |
|
9516 |
|
9517 </li> |
|
9518 |
|
9519 <li class="param"> |
|
9520 |
|
9521 <code class="param-name">allCfgs</code> |
|
9522 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9523 |
|
9524 |
|
9525 |
|
9526 |
|
9527 <div class="param-description"> |
|
9528 <p>The set of all attribute configurations for this instance. |
|
9529 Attributes will be removed from this set, if they belong to the filtered class, so |
|
9530 that by the time all classes are processed, allCfgs will be empty.</p> |
|
9531 </div> |
|
9532 |
|
9533 |
|
9534 </li> |
|
9535 |
|
9536 </ul> |
|
9537 </div> |
|
9538 |
|
9539 |
|
9540 |
|
9541 <div class="returns"> |
|
9542 <h4>Returns:</h4> |
|
9543 |
|
9544 <div class="returns-description"> |
|
9545 |
|
9546 |
|
9547 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
9548 |
|
9549 The set of attributes belonging to the class passed in, in the form |
|
9550 of an object with attribute name/configuration pairs. |
|
9551 |
|
9552 </div> |
|
9553 </div> |
|
9554 |
|
9555 |
|
9556 |
|
9557 </div> |
|
9558 |
|
9559 |
|
9560 <div id="method__filterUIEvent" class="method item private inherited"> |
|
9561 <h3 class="name"><code>_filterUIEvent</code></h3> |
|
9562 |
|
9563 |
|
9564 <div class="args"> |
|
9565 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9566 |
|
9567 <li class="arg"> |
|
9568 |
|
9569 <code>evt</code> |
|
9570 |
|
9571 </li> |
|
9572 |
|
9573 </ul><span class="paren">)</span> |
|
9574 </div> |
|
9575 |
|
9576 |
|
9577 |
|
9578 <span class="returns-inline"> |
|
9579 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
9580 </span> |
|
9581 |
|
9582 |
|
9583 |
|
9584 |
|
9585 |
|
9586 <span class="flag private">private</span> |
|
9587 |
|
9588 |
|
9589 |
|
9590 |
|
9591 |
|
9592 |
|
9593 |
|
9594 |
|
9595 |
|
9596 |
|
9597 <div class="meta"> |
|
9598 |
|
9599 |
|
9600 <p>Inherited from |
|
9601 <a href="../classes/Widget.html#method__filterUIEvent">Widget</a>: |
|
9602 |
|
9603 |
|
9604 |
|
9605 <a href="../files/widget_js_WidgetUIEvents.js.html#l117"><code>widget/js/WidgetUIEvents.js:117</code></a> |
|
9606 |
|
9607 </p> |
|
9608 |
|
9609 |
|
9610 |
|
9611 |
|
9612 |
|
9613 </div> |
|
9614 |
|
9615 <div class="description"> |
|
9616 <p>This method is used to determine if we should fire |
|
9617 the UI Event or not. The default implementation makes sure |
|
9618 that for nested delegates (nested unrelated widgets), we don't |
|
9619 fire the UI event listener more than once at each level.</p> |
|
9620 |
|
9621 <p>For example, without the additional filter, if you have nested |
|
9622 widgets, each widget will have a delegate listener. If you |
|
9623 click on the inner widget, the inner delegate listener's |
|
9624 filter will match once, but the outer will match twice |
|
9625 (based on delegate's design) - once for the inner widget, |
|
9626 and once for the outer.</p> |
|
9627 </div> |
|
9628 |
|
9629 |
|
9630 <div class="params"> |
|
9631 <h4>Parameters:</h4> |
|
9632 |
|
9633 <ul class="params-list"> |
|
9634 |
|
9635 <li class="param"> |
|
9636 |
|
9637 <code class="param-name">evt</code> |
|
9638 <span class="type"><a href="../classes/DOMEventFacade.html" class="crosslink">DOMEventFacade</a></span> |
|
9639 |
|
9640 |
|
9641 |
|
9642 |
|
9643 <div class="param-description"> |
|
9644 |
|
9645 </div> |
|
9646 |
|
9647 |
|
9648 </li> |
|
9649 |
|
9650 </ul> |
|
9651 </div> |
|
9652 |
|
9653 |
|
9654 |
|
9655 <div class="returns"> |
|
9656 <h4>Returns:</h4> |
|
9657 |
|
9658 <div class="returns-description"> |
|
9659 |
|
9660 |
|
9661 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
9662 |
|
9663 true if it's OK to fire the custom UI event, false if not. |
|
9664 |
|
9665 </div> |
|
9666 </div> |
|
9667 |
|
9668 |
|
9669 |
|
9670 </div> |
|
9671 |
|
9672 |
|
9673 <div id="method__fireAttrChange" class="method item private inherited"> |
|
9674 <h3 class="name"><code>_fireAttrChange</code></h3> |
|
9675 |
|
9676 |
|
9677 <div class="args"> |
|
9678 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9679 |
|
9680 <li class="arg"> |
|
9681 |
|
9682 <code>attrName</code> |
|
9683 |
|
9684 </li> |
|
9685 |
|
9686 <li class="arg"> |
|
9687 |
|
9688 <code>subAttrName</code> |
|
9689 |
|
9690 </li> |
|
9691 |
|
9692 <li class="arg"> |
|
9693 |
|
9694 <code>currVal</code> |
|
9695 |
|
9696 </li> |
|
9697 |
|
9698 <li class="arg"> |
|
9699 |
|
9700 <code>newVal</code> |
|
9701 |
|
9702 </li> |
|
9703 |
|
9704 <li class="arg"> |
|
9705 |
|
9706 <code>opts</code> |
|
9707 |
|
9708 </li> |
|
9709 |
|
9710 <li class="arg"> |
|
9711 |
|
9712 <code class="optional">[cfg]</code> |
|
9713 |
|
9714 </li> |
|
9715 |
|
9716 </ul><span class="paren">)</span> |
|
9717 </div> |
|
9718 |
|
9719 |
|
9720 |
|
9721 |
|
9722 |
|
9723 |
|
9724 |
|
9725 <span class="flag private">private</span> |
|
9726 |
|
9727 |
|
9728 |
|
9729 |
|
9730 |
|
9731 |
|
9732 |
|
9733 |
|
9734 |
|
9735 |
|
9736 <div class="meta"> |
|
9737 |
|
9738 |
|
9739 <p>Inherited from |
|
9740 <a href="../classes/AttributeObservable.html#method__fireAttrChange">AttributeObservable</a>: |
|
9741 |
|
9742 |
|
9743 |
|
9744 <a href="../files/attribute_js_AttributeObservable.js.html#l120"><code>attribute/js/AttributeObservable.js:120</code></a> |
|
9745 |
|
9746 </p> |
|
9747 |
|
9748 |
|
9749 |
|
9750 |
|
9751 |
|
9752 </div> |
|
9753 |
|
9754 <div class="description"> |
|
9755 <p>Utility method to help setup the event payload and fire the attribute change event.</p> |
|
9756 </div> |
|
9757 |
|
9758 |
|
9759 <div class="params"> |
|
9760 <h4>Parameters:</h4> |
|
9761 |
|
9762 <ul class="params-list"> |
|
9763 |
|
9764 <li class="param"> |
|
9765 |
|
9766 <code class="param-name">attrName</code> |
|
9767 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9768 |
|
9769 |
|
9770 |
|
9771 |
|
9772 <div class="param-description"> |
|
9773 <p>The name of the attribute</p> |
|
9774 </div> |
|
9775 |
|
9776 |
|
9777 </li> |
|
9778 |
|
9779 <li class="param"> |
|
9780 |
|
9781 <code class="param-name">subAttrName</code> |
|
9782 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9783 |
|
9784 |
|
9785 |
|
9786 |
|
9787 <div class="param-description"> |
|
9788 <p>The full path of the property being changed, |
|
9789 if this is a sub-attribute value being change. Otherwise null.</p> |
|
9790 </div> |
|
9791 |
|
9792 |
|
9793 </li> |
|
9794 |
|
9795 <li class="param"> |
|
9796 |
|
9797 <code class="param-name">currVal</code> |
|
9798 <span class="type">Any</span> |
|
9799 |
|
9800 |
|
9801 |
|
9802 |
|
9803 <div class="param-description"> |
|
9804 <p>The current value of the attribute</p> |
|
9805 </div> |
|
9806 |
|
9807 |
|
9808 </li> |
|
9809 |
|
9810 <li class="param"> |
|
9811 |
|
9812 <code class="param-name">newVal</code> |
|
9813 <span class="type">Any</span> |
|
9814 |
|
9815 |
|
9816 |
|
9817 |
|
9818 <div class="param-description"> |
|
9819 <p>The new value of the attribute</p> |
|
9820 </div> |
|
9821 |
|
9822 |
|
9823 </li> |
|
9824 |
|
9825 <li class="param"> |
|
9826 |
|
9827 <code class="param-name">opts</code> |
|
9828 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9829 |
|
9830 |
|
9831 |
|
9832 |
|
9833 <div class="param-description"> |
|
9834 <p>Any additional event data to mix into the attribute change event's event facade.</p> |
|
9835 </div> |
|
9836 |
|
9837 |
|
9838 </li> |
|
9839 |
|
9840 <li class="param"> |
|
9841 |
|
9842 <code class="param-name optional">[cfg]</code> |
|
9843 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9844 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
9845 |
|
9846 |
|
9847 |
|
9848 |
|
9849 <div class="param-description"> |
|
9850 <p>The attribute config stored in State, if already available.</p> |
|
9851 </div> |
|
9852 |
|
9853 |
|
9854 </li> |
|
9855 |
|
9856 </ul> |
|
9857 </div> |
|
9858 |
|
9859 |
|
9860 |
|
9861 |
|
9862 |
|
9863 </div> |
|
9864 |
|
9865 |
|
9866 <div id="method__getAttr" class="method item protected inherited"> |
|
9867 <h3 class="name"><code>_getAttr</code></h3> |
|
9868 |
|
9869 |
|
9870 <div class="args"> |
|
9871 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9872 |
|
9873 <li class="arg"> |
|
9874 |
|
9875 <code>name</code> |
|
9876 |
|
9877 </li> |
|
9878 |
|
9879 </ul><span class="paren">)</span> |
|
9880 </div> |
|
9881 |
|
9882 |
|
9883 |
|
9884 <span class="returns-inline"> |
|
9885 <span class="type">Any</span> |
|
9886 </span> |
|
9887 |
|
9888 |
|
9889 |
|
9890 |
|
9891 |
|
9892 <span class="flag protected">protected</span> |
|
9893 |
|
9894 |
|
9895 |
|
9896 |
|
9897 |
|
9898 |
|
9899 |
|
9900 <span class="flag chainable">chainable</span> |
|
9901 |
|
9902 |
|
9903 |
|
9904 |
|
9905 <div class="meta"> |
|
9906 |
|
9907 |
|
9908 <p>Inherited from |
|
9909 <a href="../classes/AttributeCore.html#method__getAttr">AttributeCore</a>: |
|
9910 |
|
9911 |
|
9912 |
|
9913 <a href="../files/attribute_js_AttributeCore.js.html#l543"><code>attribute/js/AttributeCore.js:543</code></a> |
|
9914 |
|
9915 </p> |
|
9916 |
|
9917 |
|
9918 |
|
9919 |
|
9920 |
|
9921 </div> |
|
9922 |
|
9923 <div class="description"> |
|
9924 <p>Provides the common implementation for the public get method, |
|
9925 allowing Attribute hosts to over-ride either method.</p> |
|
9926 |
|
9927 <p>See <a href="#method_get">get</a> for argument details.</p> |
|
9928 </div> |
|
9929 |
|
9930 |
|
9931 <div class="params"> |
|
9932 <h4>Parameters:</h4> |
|
9933 |
|
9934 <ul class="params-list"> |
|
9935 |
|
9936 <li class="param"> |
|
9937 |
|
9938 <code class="param-name">name</code> |
|
9939 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9940 |
|
9941 |
|
9942 |
|
9943 |
|
9944 <div class="param-description"> |
|
9945 <p>The name of the attribute.</p> |
|
9946 </div> |
|
9947 |
|
9948 |
|
9949 </li> |
|
9950 |
|
9951 </ul> |
|
9952 </div> |
|
9953 |
|
9954 |
|
9955 |
|
9956 <div class="returns"> |
|
9957 <h4>Returns:</h4> |
|
9958 |
|
9959 <div class="returns-description"> |
|
9960 |
|
9961 |
|
9962 <span class="type">Any</span>: |
|
9963 |
|
9964 The value of the attribute. |
|
9965 |
|
9966 </div> |
|
9967 </div> |
|
9968 |
|
9969 |
|
9970 |
|
9971 </div> |
|
9972 |
|
9973 |
|
9974 <div id="method__getAttrCfg" class="method item protected inherited"> |
|
9975 <h3 class="name"><code>_getAttrCfg</code></h3> |
|
9976 |
|
9977 |
|
9978 <div class="args"> |
|
9979 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9980 |
|
9981 <li class="arg"> |
|
9982 |
|
9983 <code>name</code> |
|
9984 |
|
9985 </li> |
|
9986 |
|
9987 </ul><span class="paren">)</span> |
|
9988 </div> |
|
9989 |
|
9990 |
|
9991 |
|
9992 <span class="returns-inline"> |
|
9993 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9994 </span> |
|
9995 |
|
9996 |
|
9997 |
|
9998 |
|
9999 |
|
10000 <span class="flag protected">protected</span> |
|
10001 |
|
10002 |
|
10003 |
|
10004 |
|
10005 |
|
10006 |
|
10007 |
|
10008 |
|
10009 |
|
10010 |
|
10011 <div class="meta"> |
|
10012 |
|
10013 |
|
10014 <p>Inherited from |
|
10015 <a href="../classes/AttributeExtras.html#method__getAttrCfg">AttributeExtras</a>: |
|
10016 |
|
10017 |
|
10018 |
|
10019 <a href="../files/attribute_js_AttributeExtras.js.html#l114"><code>attribute/js/AttributeExtras.js:114</code></a> |
|
10020 |
|
10021 </p> |
|
10022 |
|
10023 |
|
10024 |
|
10025 |
|
10026 |
|
10027 </div> |
|
10028 |
|
10029 <div class="description"> |
|
10030 <p>Returns an object with the configuration properties (and value) |
|
10031 for the given attribute. If attrName is not provided, returns the |
|
10032 configuration properties for all attributes.</p> |
|
10033 </div> |
|
10034 |
|
10035 |
|
10036 <div class="params"> |
|
10037 <h4>Parameters:</h4> |
|
10038 |
|
10039 <ul class="params-list"> |
|
10040 |
|
10041 <li class="param"> |
|
10042 |
|
10043 <code class="param-name">name</code> |
|
10044 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10045 |
|
10046 |
|
10047 |
|
10048 |
|
10049 <div class="param-description"> |
|
10050 <p>Optional. The attribute name. If not provided, the method will return the configuration for all attributes.</p> |
|
10051 </div> |
|
10052 |
|
10053 |
|
10054 </li> |
|
10055 |
|
10056 </ul> |
|
10057 </div> |
|
10058 |
|
10059 |
|
10060 |
|
10061 <div class="returns"> |
|
10062 <h4>Returns:</h4> |
|
10063 |
|
10064 <div class="returns-description"> |
|
10065 |
|
10066 |
|
10067 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
10068 |
|
10069 The configuration properties for the given attribute, or all attributes. |
|
10070 |
|
10071 </div> |
|
10072 </div> |
|
10073 |
|
10074 |
|
10075 |
|
10076 </div> |
|
10077 |
|
10078 |
|
10079 <div id="method__getAttrCfgs" class="method item protected inherited"> |
|
10080 <h3 class="name"><code>_getAttrCfgs</code></h3> |
|
10081 |
|
10082 |
|
10083 <span class="paren">()</span> |
|
10084 |
|
10085 |
|
10086 |
|
10087 <span class="returns-inline"> |
|
10088 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10089 </span> |
|
10090 |
|
10091 |
|
10092 |
|
10093 |
|
10094 |
|
10095 <span class="flag protected">protected</span> |
|
10096 |
|
10097 |
|
10098 |
|
10099 |
|
10100 |
|
10101 |
|
10102 |
|
10103 |
|
10104 |
|
10105 |
|
10106 <div class="meta"> |
|
10107 |
|
10108 |
|
10109 <p>Inherited from |
|
10110 <a href="../classes/BaseCore.html#method__getAttrCfgs">BaseCore</a>: |
|
10111 |
|
10112 |
|
10113 |
|
10114 <a href="../files/base_js_BaseCore.js.html#l339"><code>base/js/BaseCore.js:339</code></a> |
|
10115 |
|
10116 </p> |
|
10117 |
|
10118 |
|
10119 |
|
10120 |
|
10121 |
|
10122 </div> |
|
10123 |
|
10124 <div class="description"> |
|
10125 <p>Returns an aggregated set of attribute configurations, by traversing |
|
10126 the class hierarchy.</p> |
|
10127 </div> |
|
10128 |
|
10129 |
|
10130 |
|
10131 |
|
10132 <div class="returns"> |
|
10133 <h4>Returns:</h4> |
|
10134 |
|
10135 <div class="returns-description"> |
|
10136 |
|
10137 |
|
10138 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
10139 |
|
10140 The hash of attribute configurations, aggregated across classes in the hierarchy |
|
10141 This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return |
|
10142 the cached value. |
|
10143 |
|
10144 </div> |
|
10145 </div> |
|
10146 |
|
10147 |
|
10148 |
|
10149 </div> |
|
10150 |
|
10151 |
|
10152 <div id="method__getAttrInitVal" class="method item private inherited"> |
|
10153 <h3 class="name"><code>_getAttrInitVal</code></h3> |
|
10154 |
|
10155 |
|
10156 <div class="args"> |
|
10157 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10158 |
|
10159 <li class="arg"> |
|
10160 |
|
10161 <code>attr</code> |
|
10162 |
|
10163 </li> |
|
10164 |
|
10165 <li class="arg"> |
|
10166 |
|
10167 <code>cfg</code> |
|
10168 |
|
10169 </li> |
|
10170 |
|
10171 <li class="arg"> |
|
10172 |
|
10173 <code>initValues</code> |
|
10174 |
|
10175 </li> |
|
10176 |
|
10177 </ul><span class="paren">)</span> |
|
10178 </div> |
|
10179 |
|
10180 |
|
10181 |
|
10182 <span class="returns-inline"> |
|
10183 <span class="type">Any</span> |
|
10184 </span> |
|
10185 |
|
10186 |
|
10187 |
|
10188 |
|
10189 |
|
10190 <span class="flag private">private</span> |
|
10191 |
|
10192 |
|
10193 |
|
10194 |
|
10195 |
|
10196 |
|
10197 |
|
10198 |
|
10199 |
|
10200 |
|
10201 <div class="meta"> |
|
10202 |
|
10203 |
|
10204 <p>Inherited from |
|
10205 <a href="../classes/AttributeCore.html#method__getAttrInitVal">AttributeCore</a>: |
|
10206 |
|
10207 |
|
10208 |
|
10209 <a href="../files/attribute_js_AttributeCore.js.html#l945"><code>attribute/js/AttributeCore.js:945</code></a> |
|
10210 |
|
10211 </p> |
|
10212 |
|
10213 |
|
10214 |
|
10215 |
|
10216 |
|
10217 </div> |
|
10218 |
|
10219 <div class="description"> |
|
10220 <p>Returns the initial value of the given attribute from |
|
10221 either the default configuration provided, or the |
|
10222 over-ridden value if it exists in the set of initValues |
|
10223 provided and the attribute is not read-only.</p> |
|
10224 </div> |
|
10225 |
|
10226 |
|
10227 <div class="params"> |
|
10228 <h4>Parameters:</h4> |
|
10229 |
|
10230 <ul class="params-list"> |
|
10231 |
|
10232 <li class="param"> |
|
10233 |
|
10234 <code class="param-name">attr</code> |
|
10235 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10236 |
|
10237 |
|
10238 |
|
10239 |
|
10240 <div class="param-description"> |
|
10241 <p>The name of the attribute</p> |
|
10242 </div> |
|
10243 |
|
10244 |
|
10245 </li> |
|
10246 |
|
10247 <li class="param"> |
|
10248 |
|
10249 <code class="param-name">cfg</code> |
|
10250 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10251 |
|
10252 |
|
10253 |
|
10254 |
|
10255 <div class="param-description"> |
|
10256 <p>The attribute configuration object</p> |
|
10257 </div> |
|
10258 |
|
10259 |
|
10260 </li> |
|
10261 |
|
10262 <li class="param"> |
|
10263 |
|
10264 <code class="param-name">initValues</code> |
|
10265 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10266 |
|
10267 |
|
10268 |
|
10269 |
|
10270 <div class="param-description"> |
|
10271 <p>The object with simple and complex attribute name/value pairs returned from _normAttrVals</p> |
|
10272 </div> |
|
10273 |
|
10274 |
|
10275 </li> |
|
10276 |
|
10277 </ul> |
|
10278 </div> |
|
10279 |
|
10280 |
|
10281 |
|
10282 <div class="returns"> |
|
10283 <h4>Returns:</h4> |
|
10284 |
|
10285 <div class="returns-description"> |
|
10286 |
|
10287 |
|
10288 <span class="type">Any</span>: |
|
10289 |
|
10290 The initial value of the attribute. |
|
10291 |
|
10292 </div> |
|
10293 </div> |
|
10294 |
|
10295 |
|
10296 |
|
10297 </div> |
|
10298 |
|
10299 |
|
10300 <div id="method__getAttrs" class="method item protected inherited"> |
|
10301 <h3 class="name"><code>_getAttrs</code></h3> |
|
10302 |
|
10303 |
|
10304 <div class="args"> |
|
10305 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10306 |
|
10307 <li class="arg"> |
|
10308 |
|
10309 <code>attrs</code> |
|
10310 |
|
10311 </li> |
|
10312 |
|
10313 </ul><span class="paren">)</span> |
|
10314 </div> |
|
10315 |
|
10316 |
|
10317 |
|
10318 <span class="returns-inline"> |
|
10319 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10320 </span> |
|
10321 |
|
10322 |
|
10323 |
|
10324 |
|
10325 |
|
10326 <span class="flag protected">protected</span> |
|
10327 |
|
10328 |
|
10329 |
|
10330 |
|
10331 |
|
10332 |
|
10333 |
|
10334 |
|
10335 |
|
10336 |
|
10337 <div class="meta"> |
|
10338 |
|
10339 |
|
10340 <p>Inherited from |
|
10341 <a href="../classes/AttributeCore.html#method__getAttrs">AttributeCore</a>: |
|
10342 |
|
10343 |
|
10344 |
|
10345 <a href="../files/attribute_js_AttributeCore.js.html#l774"><code>attribute/js/AttributeCore.js:774</code></a> |
|
10346 |
|
10347 </p> |
|
10348 |
|
10349 |
|
10350 |
|
10351 |
|
10352 |
|
10353 </div> |
|
10354 |
|
10355 <div class="description"> |
|
10356 <p>Implementation behind the public getAttrs method, to get multiple attribute values.</p> |
|
10357 </div> |
|
10358 |
|
10359 |
|
10360 <div class="params"> |
|
10361 <h4>Parameters:</h4> |
|
10362 |
|
10363 <ul class="params-list"> |
|
10364 |
|
10365 <li class="param"> |
|
10366 |
|
10367 <code class="param-name">attrs</code> |
|
10368 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span> |
|
10369 |
|
10370 |
|
10371 |
|
10372 |
|
10373 <div class="param-description"> |
|
10374 <p>Optional. An array of attribute names. If omitted, all attribute values are |
|
10375 returned. If set to true, all attributes modified from their initial values are returned.</p> |
|
10376 </div> |
|
10377 |
|
10378 |
|
10379 </li> |
|
10380 |
|
10381 </ul> |
|
10382 </div> |
|
10383 |
|
10384 |
|
10385 |
|
10386 <div class="returns"> |
|
10387 <h4>Returns:</h4> |
|
10388 |
|
10389 <div class="returns-description"> |
|
10390 |
|
10391 |
|
10392 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
10393 |
|
10394 An object with attribute name/value pairs. |
|
10395 |
|
10396 </div> |
|
10397 </div> |
|
10398 |
|
10399 |
|
10400 |
|
10401 </div> |
|
10402 |
|
10403 |
|
10404 <div id="method__getClasses" class="method item protected inherited"> |
|
10405 <h3 class="name"><code>_getClasses</code></h3> |
|
10406 |
|
10407 |
|
10408 <span class="paren">()</span> |
|
10409 |
|
10410 |
|
10411 |
|
10412 <span class="returns-inline"> |
|
10413 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span> |
|
10414 </span> |
|
10415 |
|
10416 |
|
10417 |
|
10418 |
|
10419 |
|
10420 <span class="flag protected">protected</span> |
|
10421 |
|
10422 |
|
10423 |
|
10424 |
|
10425 |
|
10426 |
|
10427 |
|
10428 |
|
10429 |
|
10430 |
|
10431 <div class="meta"> |
|
10432 |
|
10433 |
|
10434 <p>Inherited from |
|
10435 <a href="../classes/BaseCore.html#method__getClasses">BaseCore</a>: |
|
10436 |
|
10437 |
|
10438 |
|
10439 <a href="../files/base_js_BaseCore.js.html#l323"><code>base/js/BaseCore.js:323</code></a> |
|
10440 |
|
10441 </p> |
|
10442 |
|
10443 |
|
10444 |
|
10445 |
|
10446 |
|
10447 </div> |
|
10448 |
|
10449 <div class="description"> |
|
10450 <p>Returns the class hierarchy for this object, with BaseCore being the last class in the array.</p> |
|
10451 </div> |
|
10452 |
|
10453 |
|
10454 |
|
10455 |
|
10456 <div class="returns"> |
|
10457 <h4>Returns:</h4> |
|
10458 |
|
10459 <div class="returns-description"> |
|
10460 |
|
10461 |
|
10462 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>: |
|
10463 |
|
10464 An array of classes (constructor functions), making up the class hierarchy for this object. |
|
10465 This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the |
|
10466 cached value. |
|
10467 |
|
10468 </div> |
|
10469 </div> |
|
10470 |
|
10471 |
|
10472 |
|
10473 </div> |
|
10474 |
|
10475 |
|
10476 <div id="method__getColumns" class="method item protected"> |
|
10477 <h3 class="name"><code>_getColumns</code></h3> |
|
10478 |
|
10479 |
|
10480 <div class="args"> |
|
10481 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10482 |
|
10483 <li class="arg"> |
|
10484 |
|
10485 <code>columns</code> |
|
10486 |
|
10487 </li> |
|
10488 |
|
10489 <li class="arg"> |
|
10490 |
|
10491 <code>name</code> |
|
10492 |
|
10493 </li> |
|
10494 |
|
10495 </ul><span class="paren">)</span> |
|
10496 </div> |
|
10497 |
|
10498 |
|
10499 |
|
10500 |
|
10501 |
|
10502 |
|
10503 |
|
10504 <span class="flag protected">protected</span> |
|
10505 |
|
10506 |
|
10507 |
|
10508 |
|
10509 |
|
10510 |
|
10511 |
|
10512 |
|
10513 |
|
10514 |
|
10515 <div class="meta"> |
|
10516 |
|
10517 |
|
10518 |
|
10519 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
10520 |
|
10521 <p> |
|
10522 |
|
10523 Defined in |
|
10524 |
|
10525 |
|
10526 |
|
10527 |
|
10528 <a href="../files/datatable_js_core.js.html#l431"><code>datatable/js/core.js:431</code></a> |
|
10529 |
|
10530 </p> |
|
10531 |
|
10532 |
|
10533 |
|
10534 |
|
10535 |
|
10536 <p>Available since 3.5.0</p> |
|
10537 |
|
10538 </div> |
|
10539 |
|
10540 <div class="description"> |
|
10541 <p>The getter for the <code>columns</code> attribute. Returns the array of column |
|
10542 configuration objects if <code>instance.get('columns')</code> is called, or the |
|
10543 specific column object if <code>instance.get('columns.columnKey')</code> is called.</p> |
|
10544 </div> |
|
10545 |
|
10546 |
|
10547 <div class="params"> |
|
10548 <h4>Parameters:</h4> |
|
10549 |
|
10550 <ul class="params-list"> |
|
10551 |
|
10552 <li class="param"> |
|
10553 |
|
10554 <code class="param-name">columns</code> |
|
10555 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
10556 |
|
10557 |
|
10558 |
|
10559 |
|
10560 <div class="param-description"> |
|
10561 <p>The full array of column objects</p> |
|
10562 </div> |
|
10563 |
|
10564 |
|
10565 </li> |
|
10566 |
|
10567 <li class="param"> |
|
10568 |
|
10569 <code class="param-name">name</code> |
|
10570 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10571 |
|
10572 |
|
10573 |
|
10574 |
|
10575 <div class="param-description"> |
|
10576 <p>The attribute name requested |
|
10577 (e.g. 'columns' or 'columns.foo');</p> |
|
10578 </div> |
|
10579 |
|
10580 |
|
10581 </li> |
|
10582 |
|
10583 </ul> |
|
10584 </div> |
|
10585 |
|
10586 |
|
10587 |
|
10588 |
|
10589 |
|
10590 </div> |
|
10591 |
|
10592 |
|
10593 <div id="method__getColumnset" class="method item protected deprecated"> |
|
10594 <h3 class="name"><code>_getColumnset</code></h3> |
|
10595 |
|
10596 |
|
10597 <div class="args"> |
|
10598 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10599 |
|
10600 <li class="arg"> |
|
10601 |
|
10602 <code>ignored</code> |
|
10603 |
|
10604 </li> |
|
10605 |
|
10606 <li class="arg"> |
|
10607 |
|
10608 <code>name</code> |
|
10609 |
|
10610 </li> |
|
10611 |
|
10612 </ul><span class="paren">)</span> |
|
10613 </div> |
|
10614 |
|
10615 |
|
10616 |
|
10617 |
|
10618 |
|
10619 <span class="flag deprecated" title="This will be removed with the `columnset` attribute in a future |
|
10620 version.">deprecated</span> |
|
10621 |
|
10622 |
|
10623 |
|
10624 <span class="flag protected">protected</span> |
|
10625 |
|
10626 |
|
10627 |
|
10628 |
|
10629 |
|
10630 |
|
10631 |
|
10632 |
|
10633 |
|
10634 |
|
10635 <div class="meta"> |
|
10636 |
|
10637 |
|
10638 |
|
10639 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
10640 |
|
10641 <p> |
|
10642 |
|
10643 Defined in |
|
10644 |
|
10645 |
|
10646 |
|
10647 |
|
10648 <a href="../files/datatable_js_core.js.html#l450"><code>datatable/js/core.js:450</code></a> |
|
10649 |
|
10650 </p> |
|
10651 |
|
10652 |
|
10653 |
|
10654 <p>Deprecated: This will be removed with the `columnset` attribute in a future |
|
10655 version.</p> |
|
10656 |
|
10657 |
|
10658 |
|
10659 <p>Available since 3.5.0</p> |
|
10660 |
|
10661 </div> |
|
10662 |
|
10663 <div class="description"> |
|
10664 <p>Relays the <code>get()</code> request for the deprecated <code>columnset</code> attribute to the |
|
10665 <code>columns</code> attribute.</p> |
|
10666 |
|
10667 <p>THIS BREAKS BACKWARD COMPATIBILITY. 3.4.1 and prior implementations will |
|
10668 expect a Columnset instance returned from <code>get('columnset')</code>.</p> |
|
10669 </div> |
|
10670 |
|
10671 |
|
10672 <div class="params"> |
|
10673 <h4>Parameters:</h4> |
|
10674 |
|
10675 <ul class="params-list"> |
|
10676 |
|
10677 <li class="param"> |
|
10678 |
|
10679 <code class="param-name">ignored</code> |
|
10680 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10681 |
|
10682 |
|
10683 |
|
10684 |
|
10685 <div class="param-description"> |
|
10686 <p>The current value stored in the <code>columnset</code> state</p> |
|
10687 </div> |
|
10688 |
|
10689 |
|
10690 </li> |
|
10691 |
|
10692 <li class="param"> |
|
10693 |
|
10694 <code class="param-name">name</code> |
|
10695 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10696 |
|
10697 |
|
10698 |
|
10699 |
|
10700 <div class="param-description"> |
|
10701 <p>The attribute name requested |
|
10702 (e.g. 'columnset' or 'columnset.foo');</p> |
|
10703 </div> |
|
10704 |
|
10705 |
|
10706 </li> |
|
10707 |
|
10708 </ul> |
|
10709 </div> |
|
10710 |
|
10711 |
|
10712 |
|
10713 |
|
10714 |
|
10715 </div> |
|
10716 |
|
10717 |
|
10718 <div id="method__getFullType" class="method item private inherited"> |
|
10719 <h3 class="name"><code>_getFullType</code></h3> |
|
10720 |
|
10721 |
|
10722 <div class="args"> |
|
10723 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10724 |
|
10725 <li class="arg"> |
|
10726 |
|
10727 <code>type</code> |
|
10728 |
|
10729 </li> |
|
10730 |
|
10731 </ul><span class="paren">)</span> |
|
10732 </div> |
|
10733 |
|
10734 |
|
10735 |
|
10736 <span class="returns-inline"> |
|
10737 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10738 </span> |
|
10739 |
|
10740 |
|
10741 |
|
10742 |
|
10743 |
|
10744 <span class="flag private">private</span> |
|
10745 |
|
10746 |
|
10747 |
|
10748 |
|
10749 |
|
10750 |
|
10751 |
|
10752 |
|
10753 |
|
10754 |
|
10755 <div class="meta"> |
|
10756 |
|
10757 |
|
10758 <p>Inherited from |
|
10759 <a href="../classes/EventTarget.html#method__getFullType">EventTarget</a>: |
|
10760 |
|
10761 |
|
10762 |
|
10763 <a href="../files/event-custom_js_event-target.js.html#l586"><code>event-custom/js/event-target.js:586</code></a> |
|
10764 |
|
10765 </p> |
|
10766 |
|
10767 |
|
10768 |
|
10769 |
|
10770 |
|
10771 </div> |
|
10772 |
|
10773 <div class="description"> |
|
10774 <p>Returns the fully qualified type, given a short type string. |
|
10775 That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.</p> |
|
10776 |
|
10777 <p>NOTE: This method, unlike _getType, does no checking of the value passed in, and |
|
10778 is designed to be used with the low level _publish() method, for critical path |
|
10779 implementations which need to fast-track publish for performance reasons.</p> |
|
10780 </div> |
|
10781 |
|
10782 |
|
10783 <div class="params"> |
|
10784 <h4>Parameters:</h4> |
|
10785 |
|
10786 <ul class="params-list"> |
|
10787 |
|
10788 <li class="param"> |
|
10789 |
|
10790 <code class="param-name">type</code> |
|
10791 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10792 |
|
10793 |
|
10794 |
|
10795 |
|
10796 <div class="param-description"> |
|
10797 <p>The short type to prefix</p> |
|
10798 </div> |
|
10799 |
|
10800 |
|
10801 </li> |
|
10802 |
|
10803 </ul> |
|
10804 </div> |
|
10805 |
|
10806 |
|
10807 |
|
10808 <div class="returns"> |
|
10809 <h4>Returns:</h4> |
|
10810 |
|
10811 <div class="returns-description"> |
|
10812 |
|
10813 |
|
10814 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
10815 |
|
10816 The prefixed type, if a prefix is set, otherwise the type passed in |
|
10817 |
|
10818 </div> |
|
10819 </div> |
|
10820 |
|
10821 |
|
10822 |
|
10823 </div> |
|
10824 |
|
10825 |
|
10826 <div id="method__getHtmlParser" class="method item private inherited"> |
|
10827 <h3 class="name"><code>_getHtmlParser</code></h3> |
|
10828 |
|
10829 |
|
10830 <span class="paren">()</span> |
|
10831 |
|
10832 |
|
10833 |
|
10834 <span class="returns-inline"> |
|
10835 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10836 </span> |
|
10837 |
|
10838 |
|
10839 |
|
10840 |
|
10841 |
|
10842 <span class="flag private">private</span> |
|
10843 |
|
10844 |
|
10845 |
|
10846 |
|
10847 |
|
10848 |
|
10849 |
|
10850 |
|
10851 |
|
10852 |
|
10853 <div class="meta"> |
|
10854 |
|
10855 |
|
10856 <p>Inherited from |
|
10857 <a href="../classes/Widget.html#method__getHtmlParser">Widget</a>: |
|
10858 |
|
10859 |
|
10860 |
|
10861 <a href="../files/widget_js_WidgetHTMLParser.js.html#l149"><code>widget/js/WidgetHTMLParser.js:149</code></a> |
|
10862 |
|
10863 </p> |
|
10864 |
|
10865 |
|
10866 |
|
10867 |
|
10868 |
|
10869 </div> |
|
10870 |
|
10871 <div class="description"> |
|
10872 <p>Gets the HTML<em>PARSER definition for this instance, by merging HTML</em>PARSER |
|
10873 definitions across the class hierarchy.</p> |
|
10874 </div> |
|
10875 |
|
10876 |
|
10877 |
|
10878 |
|
10879 <div class="returns"> |
|
10880 <h4>Returns:</h4> |
|
10881 |
|
10882 <div class="returns-description"> |
|
10883 |
|
10884 |
|
10885 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
10886 |
|
10887 HTML_PARSER definition for this instance |
|
10888 |
|
10889 </div> |
|
10890 </div> |
|
10891 |
|
10892 |
|
10893 |
|
10894 </div> |
|
10895 |
|
10896 |
|
10897 <div id="method__getNodeToParse" class="method item private inherited"> |
|
10898 <h3 class="name"><code>_getNodeToParse</code></h3> |
|
10899 |
|
10900 |
|
10901 <span class="paren">()</span> |
|
10902 |
|
10903 |
|
10904 |
|
10905 <span class="returns-inline"> |
|
10906 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
10907 </span> |
|
10908 |
|
10909 |
|
10910 |
|
10911 |
|
10912 |
|
10913 <span class="flag private">private</span> |
|
10914 |
|
10915 |
|
10916 |
|
10917 |
|
10918 |
|
10919 |
|
10920 |
|
10921 |
|
10922 |
|
10923 |
|
10924 <div class="meta"> |
|
10925 |
|
10926 |
|
10927 <p>Inherited from |
|
10928 <a href="../classes/Widget.html#method__getNodeToParse">Widget</a>: |
|
10929 |
|
10930 |
|
10931 |
|
10932 <a href="../files/widget_js_WidgetHTMLParser.js.html#l134"><code>widget/js/WidgetHTMLParser.js:134</code></a> |
|
10933 |
|
10934 </p> |
|
10935 |
|
10936 |
|
10937 |
|
10938 |
|
10939 |
|
10940 </div> |
|
10941 |
|
10942 <div class="description"> |
|
10943 <p>Determines whether we have a node reference which we should try and parse.</p> |
|
10944 |
|
10945 <p>The current implementation does not parse nodes generated from CONTENT_TEMPLATE, |
|
10946 only explicitly set srcNode, or contentBox attributes.</p> |
|
10947 </div> |
|
10948 |
|
10949 |
|
10950 |
|
10951 |
|
10952 <div class="returns"> |
|
10953 <h4>Returns:</h4> |
|
10954 |
|
10955 <div class="returns-description"> |
|
10956 |
|
10957 |
|
10958 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
10959 |
|
10960 The node reference to apply HTML_PARSER to. |
|
10961 |
|
10962 </div> |
|
10963 </div> |
|
10964 |
|
10965 |
|
10966 |
|
10967 </div> |
|
10968 |
|
10969 |
|
10970 <div id="method__getRecordType" class="method item"> |
|
10971 <h3 class="name"><code>_getRecordType</code></h3> |
|
10972 |
|
10973 |
|
10974 <div class="args"> |
|
10975 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10976 |
|
10977 <li class="arg"> |
|
10978 |
|
10979 <code>val</code> |
|
10980 |
|
10981 </li> |
|
10982 |
|
10983 </ul><span class="paren">)</span> |
|
10984 </div> |
|
10985 |
|
10986 |
|
10987 |
|
10988 <span class="returns-inline"> |
|
10989 <span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span> |
|
10990 </span> |
|
10991 |
|
10992 |
|
10993 |
|
10994 |
|
10995 |
|
10996 |
|
10997 |
|
10998 |
|
10999 |
|
11000 |
|
11001 |
|
11002 |
|
11003 |
|
11004 |
|
11005 <div class="meta"> |
|
11006 |
|
11007 |
|
11008 |
|
11009 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
11010 |
|
11011 <p> |
|
11012 |
|
11013 Defined in |
|
11014 |
|
11015 |
|
11016 |
|
11017 |
|
11018 <a href="../files/datatable_js_core.js.html#l470"><code>datatable/js/core.js:470</code></a> |
|
11019 |
|
11020 </p> |
|
11021 |
|
11022 |
|
11023 |
|
11024 |
|
11025 |
|
11026 </div> |
|
11027 |
|
11028 <div class="description"> |
|
11029 <p>Returns the Model class of the instance's <code>data</code> attribute ModelList. If |
|
11030 not set, returns the explicitly configured value.</p> |
|
11031 </div> |
|
11032 |
|
11033 |
|
11034 <div class="params"> |
|
11035 <h4>Parameters:</h4> |
|
11036 |
|
11037 <ul class="params-list"> |
|
11038 |
|
11039 <li class="param"> |
|
11040 |
|
11041 <code class="param-name">val</code> |
|
11042 <span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span> |
|
11043 |
|
11044 |
|
11045 |
|
11046 |
|
11047 <div class="param-description"> |
|
11048 <p>The currently configured value</p> |
|
11049 </div> |
|
11050 |
|
11051 |
|
11052 </li> |
|
11053 |
|
11054 </ul> |
|
11055 </div> |
|
11056 |
|
11057 |
|
11058 |
|
11059 <div class="returns"> |
|
11060 <h4>Returns:</h4> |
|
11061 |
|
11062 <div class="returns-description"> |
|
11063 |
|
11064 |
|
11065 <span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>: |
|
11066 |
|
11067 |
|
11068 </div> |
|
11069 </div> |
|
11070 |
|
11071 |
|
11072 |
|
11073 </div> |
|
11074 |
|
11075 |
|
11076 <div id="method__getSortBy" class="method item protected"> |
|
11077 <h3 class="name"><code>_getSortBy</code></h3> |
|
11078 |
|
11079 |
|
11080 <div class="args"> |
|
11081 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11082 |
|
11083 <li class="arg"> |
|
11084 |
|
11085 <code>val</code> |
|
11086 |
|
11087 </li> |
|
11088 |
|
11089 <li class="arg"> |
|
11090 |
|
11091 <code>detail</code> |
|
11092 |
|
11093 </li> |
|
11094 |
|
11095 </ul><span class="paren">)</span> |
|
11096 </div> |
|
11097 |
|
11098 |
|
11099 |
|
11100 |
|
11101 |
|
11102 |
|
11103 |
|
11104 <span class="flag protected">protected</span> |
|
11105 |
|
11106 |
|
11107 |
|
11108 |
|
11109 |
|
11110 |
|
11111 |
|
11112 |
|
11113 |
|
11114 |
|
11115 <div class="meta"> |
|
11116 |
|
11117 |
|
11118 |
|
11119 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
11120 |
|
11121 <p> |
|
11122 |
|
11123 Defined in |
|
11124 |
|
11125 |
|
11126 |
|
11127 |
|
11128 <a href="../files/datatable_js_sort.js.html#l388"><code>datatable/js/sort.js:388</code></a> |
|
11129 |
|
11130 </p> |
|
11131 |
|
11132 |
|
11133 |
|
11134 |
|
11135 |
|
11136 <p>Available since 3.5.0</p> |
|
11137 |
|
11138 </div> |
|
11139 |
|
11140 <div class="description"> |
|
11141 <p>Getter for the <code>sortBy</code> attribute.</p> |
|
11142 |
|
11143 <p>Supports the special subattribute "sortBy.state" to get a normalized JSON |
|
11144 version of the current sort state. Otherwise, returns the last assigned |
|
11145 value.</p> |
|
11146 |
|
11147 <p>For example:</p> |
|
11148 |
|
11149 <pre class="code prettyprint"><code>var table = new Y.DataTable({ |
|
11150 columns: [ ... ], |
|
11151 data: [ ... ], |
|
11152 sortBy: 'username' |
|
11153 }); |
|
11154 |
|
11155 table.get('sortBy'); // 'username' |
|
11156 table.get('sortBy.state'); // { key: 'username', dir: 1 } |
|
11157 |
|
11158 table.sort(['lastName', { firstName: "desc" }]); |
|
11159 table.get('sortBy'); // ['lastName', { firstName: "desc" }] |
|
11160 table.get('sortBy.state'); // [{ key: "lastName", dir: 1 }, { key: "firstName", dir: -1 }] |
|
11161 </code></pre> |
|
11162 </div> |
|
11163 |
|
11164 |
|
11165 <div class="params"> |
|
11166 <h4>Parameters:</h4> |
|
11167 |
|
11168 <ul class="params-list"> |
|
11169 |
|
11170 <li class="param"> |
|
11171 |
|
11172 <code class="param-name">val</code> |
|
11173 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
11174 |
|
11175 |
|
11176 |
|
11177 |
|
11178 <div class="param-description"> |
|
11179 <p>The current sortBy value</p> |
|
11180 </div> |
|
11181 |
|
11182 |
|
11183 </li> |
|
11184 |
|
11185 <li class="param"> |
|
11186 |
|
11187 <code class="param-name">detail</code> |
|
11188 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11189 |
|
11190 |
|
11191 |
|
11192 |
|
11193 <div class="param-description"> |
|
11194 <p>String passed to <code>get(HERE)</code>. to parse subattributes</p> |
|
11195 </div> |
|
11196 |
|
11197 |
|
11198 </li> |
|
11199 |
|
11200 </ul> |
|
11201 </div> |
|
11202 |
|
11203 |
|
11204 |
|
11205 |
|
11206 |
|
11207 </div> |
|
11208 |
|
11209 |
|
11210 <div id="method__getSrcNode" class="method item protected inherited"> |
|
11211 <h3 class="name"><code>_getSrcNode</code></h3> |
|
11212 |
|
11213 |
|
11214 <span class="paren">()</span> |
|
11215 |
|
11216 |
|
11217 |
|
11218 <span class="returns-inline"> |
|
11219 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
11220 </span> |
|
11221 |
|
11222 |
|
11223 |
|
11224 |
|
11225 |
|
11226 <span class="flag protected">protected</span> |
|
11227 |
|
11228 |
|
11229 |
|
11230 |
|
11231 |
|
11232 |
|
11233 |
|
11234 |
|
11235 |
|
11236 |
|
11237 <div class="meta"> |
|
11238 |
|
11239 |
|
11240 <p>Inherited from |
|
11241 <a href="../classes/Widget.html#method__getSrcNode">Widget</a>: |
|
11242 |
|
11243 |
|
11244 |
|
11245 <a href="../files/widget_js_WidgetHTMLParser.js.html#l74"><code>widget/js/WidgetHTMLParser.js:74</code></a> |
|
11246 |
|
11247 </p> |
|
11248 |
|
11249 |
|
11250 |
|
11251 |
|
11252 |
|
11253 </div> |
|
11254 |
|
11255 <div class="description"> |
|
11256 |
|
11257 </div> |
|
11258 |
|
11259 |
|
11260 |
|
11261 |
|
11262 <div class="returns"> |
|
11263 <h4>Returns:</h4> |
|
11264 |
|
11265 <div class="returns-description"> |
|
11266 |
|
11267 |
|
11268 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
11269 |
|
11270 The Node to apply HTML_PARSER to |
|
11271 |
|
11272 </div> |
|
11273 </div> |
|
11274 |
|
11275 |
|
11276 |
|
11277 </div> |
|
11278 |
|
11279 |
|
11280 <div id="method__getStateVal" class="method item private inherited"> |
|
11281 <h3 class="name"><code>_getStateVal</code></h3> |
|
11282 |
|
11283 |
|
11284 <div class="args"> |
|
11285 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11286 |
|
11287 <li class="arg"> |
|
11288 |
|
11289 <code>name</code> |
|
11290 |
|
11291 </li> |
|
11292 |
|
11293 <li class="arg"> |
|
11294 |
|
11295 <code class="optional">[cfg]</code> |
|
11296 |
|
11297 </li> |
|
11298 |
|
11299 </ul><span class="paren">)</span> |
|
11300 </div> |
|
11301 |
|
11302 |
|
11303 |
|
11304 <span class="returns-inline"> |
|
11305 <span class="type">Any</span> |
|
11306 </span> |
|
11307 |
|
11308 |
|
11309 |
|
11310 |
|
11311 |
|
11312 <span class="flag private">private</span> |
|
11313 |
|
11314 |
|
11315 |
|
11316 |
|
11317 |
|
11318 |
|
11319 |
|
11320 |
|
11321 |
|
11322 |
|
11323 <div class="meta"> |
|
11324 |
|
11325 |
|
11326 <p>Inherited from |
|
11327 <a href="../classes/AttributeCore.html#method__getStateVal">AttributeCore</a>: |
|
11328 |
|
11329 |
|
11330 |
|
11331 <a href="../files/attribute_js_AttributeCore.js.html#l600"><code>attribute/js/AttributeCore.js:600</code></a> |
|
11332 |
|
11333 </p> |
|
11334 |
|
11335 |
|
11336 |
|
11337 |
|
11338 |
|
11339 </div> |
|
11340 |
|
11341 <div class="description"> |
|
11342 <p>Gets the stored value for the attribute, from either the |
|
11343 internal state object, or the state proxy if it exits</p> |
|
11344 </div> |
|
11345 |
|
11346 |
|
11347 <div class="params"> |
|
11348 <h4>Parameters:</h4> |
|
11349 |
|
11350 <ul class="params-list"> |
|
11351 |
|
11352 <li class="param"> |
|
11353 |
|
11354 <code class="param-name">name</code> |
|
11355 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11356 |
|
11357 |
|
11358 |
|
11359 |
|
11360 <div class="param-description"> |
|
11361 <p>The name of the attribute</p> |
|
11362 </div> |
|
11363 |
|
11364 |
|
11365 </li> |
|
11366 |
|
11367 <li class="param"> |
|
11368 |
|
11369 <code class="param-name optional">[cfg]</code> |
|
11370 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11371 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11372 |
|
11373 |
|
11374 |
|
11375 |
|
11376 <div class="param-description"> |
|
11377 <p>Optional config hash for the attribute. This is added for performance along the critical path, |
|
11378 where the calling method has already obtained the config from state.</p> |
|
11379 </div> |
|
11380 |
|
11381 |
|
11382 </li> |
|
11383 |
|
11384 </ul> |
|
11385 </div> |
|
11386 |
|
11387 |
|
11388 |
|
11389 <div class="returns"> |
|
11390 <h4>Returns:</h4> |
|
11391 |
|
11392 <div class="returns-description"> |
|
11393 |
|
11394 |
|
11395 <span class="type">Any</span>: |
|
11396 |
|
11397 The stored value of the attribute |
|
11398 |
|
11399 </div> |
|
11400 </div> |
|
11401 |
|
11402 |
|
11403 |
|
11404 </div> |
|
11405 |
|
11406 |
|
11407 <div id="method__getStrings" class="method item protected inherited"> |
|
11408 <h3 class="name"><code>_getStrings</code></h3> |
|
11409 |
|
11410 |
|
11411 <div class="args"> |
|
11412 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11413 |
|
11414 <li class="arg"> |
|
11415 |
|
11416 <code>locale</code> |
|
11417 |
|
11418 </li> |
|
11419 |
|
11420 </ul><span class="paren">)</span> |
|
11421 </div> |
|
11422 |
|
11423 |
|
11424 |
|
11425 |
|
11426 |
|
11427 |
|
11428 |
|
11429 <span class="flag protected">protected</span> |
|
11430 |
|
11431 |
|
11432 |
|
11433 |
|
11434 |
|
11435 |
|
11436 |
|
11437 |
|
11438 |
|
11439 |
|
11440 <div class="meta"> |
|
11441 |
|
11442 |
|
11443 <p>Inherited from |
|
11444 <a href="../classes/Widget.html#method__getStrings">Widget</a>: |
|
11445 |
|
11446 |
|
11447 |
|
11448 <a href="../files/widget_js_WidgetLocale.js.html#l56"><code>widget/js/WidgetLocale.js:56</code></a> |
|
11449 |
|
11450 </p> |
|
11451 |
|
11452 |
|
11453 |
|
11454 |
|
11455 |
|
11456 </div> |
|
11457 |
|
11458 <div class="description"> |
|
11459 <p>Returns the strings key/value hash for a paricular locale, without locale lookup applied.</p> |
|
11460 </div> |
|
11461 |
|
11462 |
|
11463 <div class="params"> |
|
11464 <h4>Parameters:</h4> |
|
11465 |
|
11466 <ul class="params-list"> |
|
11467 |
|
11468 <li class="param"> |
|
11469 |
|
11470 <code class="param-name">locale</code> |
|
11471 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11472 |
|
11473 |
|
11474 |
|
11475 |
|
11476 <div class="param-description"> |
|
11477 |
|
11478 </div> |
|
11479 |
|
11480 |
|
11481 </li> |
|
11482 |
|
11483 </ul> |
|
11484 </div> |
|
11485 |
|
11486 |
|
11487 |
|
11488 |
|
11489 |
|
11490 </div> |
|
11491 |
|
11492 |
|
11493 <div id="method__getType" class="method item private inherited"> |
|
11494 <h3 class="name"><code>_getType</code></h3> |
|
11495 |
|
11496 |
|
11497 <span class="paren">()</span> |
|
11498 |
|
11499 |
|
11500 |
|
11501 |
|
11502 |
|
11503 |
|
11504 |
|
11505 <span class="flag private">private</span> |
|
11506 |
|
11507 |
|
11508 |
|
11509 |
|
11510 |
|
11511 |
|
11512 |
|
11513 |
|
11514 |
|
11515 |
|
11516 <div class="meta"> |
|
11517 |
|
11518 |
|
11519 <p>Inherited from |
|
11520 <a href="../classes/EventTarget.html#method__getType">EventTarget</a>: |
|
11521 |
|
11522 |
|
11523 |
|
11524 <a href="../files/event-custom_js_event-target.js.html#l36"><code>event-custom/js/event-target.js:36</code></a> |
|
11525 |
|
11526 </p> |
|
11527 |
|
11528 |
|
11529 |
|
11530 |
|
11531 |
|
11532 </div> |
|
11533 |
|
11534 <div class="description"> |
|
11535 <p>If the instance has a prefix attribute and the |
|
11536 event type is not prefixed, the instance prefix is |
|
11537 applied to the supplied type.</p> |
|
11538 </div> |
|
11539 |
|
11540 |
|
11541 |
|
11542 |
|
11543 |
|
11544 |
|
11545 </div> |
|
11546 |
|
11547 |
|
11548 <div id="method__getUIEventNode" class="method item protected inherited"> |
|
11549 <h3 class="name"><code>_getUIEventNode</code></h3> |
|
11550 |
|
11551 |
|
11552 <span class="paren">()</span> |
|
11553 |
|
11554 |
|
11555 |
|
11556 |
|
11557 |
|
11558 |
|
11559 |
|
11560 <span class="flag protected">protected</span> |
|
11561 |
|
11562 |
|
11563 |
|
11564 |
|
11565 |
|
11566 |
|
11567 |
|
11568 |
|
11569 |
|
11570 |
|
11571 <div class="meta"> |
|
11572 |
|
11573 <p>Inherited from |
|
11574 <a href="../classes/Widget.html#method__getUIEventNode"> |
|
11575 Widget |
|
11576 </a> |
|
11577 |
|
11578 but overwritten in |
|
11579 |
|
11580 |
|
11581 |
|
11582 <a href="../files/widget-child_js_Widget-Child.js.html#l167"><code>widget-child/js/Widget-Child.js:167</code></a> |
|
11583 |
|
11584 </p> |
|
11585 |
|
11586 |
|
11587 |
|
11588 |
|
11589 |
|
11590 </div> |
|
11591 |
|
11592 <div class="description"> |
|
11593 <p>Returns the node on which to bind delegate listeners.</p> |
|
11594 |
|
11595 <p>Override of Widget's implementation of _getUIEventNode() to ensure that |
|
11596 all event listeners are bound to the Widget's topmost DOM element. |
|
11597 This ensures that the firing of each type of Widget UI event (click, |
|
11598 mousedown, etc.) is facilitated by a single, top-level, delegated DOM |
|
11599 event listener.</p> |
|
11600 </div> |
|
11601 |
|
11602 |
|
11603 |
|
11604 |
|
11605 |
|
11606 |
|
11607 </div> |
|
11608 |
|
11609 |
|
11610 <div id="method__guid" class="method item protected inherited"> |
|
11611 <h3 class="name"><code>_guid</code></h3> |
|
11612 |
|
11613 |
|
11614 <span class="paren">()</span> |
|
11615 |
|
11616 |
|
11617 |
|
11618 |
|
11619 |
|
11620 |
|
11621 |
|
11622 <span class="flag protected">protected</span> |
|
11623 |
|
11624 |
|
11625 |
|
11626 |
|
11627 |
|
11628 |
|
11629 |
|
11630 |
|
11631 |
|
11632 |
|
11633 <div class="meta"> |
|
11634 |
|
11635 |
|
11636 <p>Inherited from |
|
11637 <a href="../classes/Widget.html#method__guid">Widget</a>: |
|
11638 |
|
11639 |
|
11640 |
|
11641 <a href="../files/widget_js_Widget.js.html#l1153"><code>widget/js/Widget.js:1153</code></a> |
|
11642 |
|
11643 </p> |
|
11644 |
|
11645 |
|
11646 |
|
11647 |
|
11648 |
|
11649 </div> |
|
11650 |
|
11651 <div class="description"> |
|
11652 |
|
11653 </div> |
|
11654 |
|
11655 |
|
11656 |
|
11657 |
|
11658 |
|
11659 |
|
11660 </div> |
|
11661 |
|
11662 |
|
11663 <div id="method__initAttrHost" class="method item private inherited"> |
|
11664 <h3 class="name"><code>_initAttrHost</code></h3> |
|
11665 |
|
11666 |
|
11667 <div class="args"> |
|
11668 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11669 |
|
11670 <li class="arg"> |
|
11671 |
|
11672 <code>attrs</code> |
|
11673 |
|
11674 </li> |
|
11675 |
|
11676 <li class="arg"> |
|
11677 |
|
11678 <code>values</code> |
|
11679 |
|
11680 </li> |
|
11681 |
|
11682 <li class="arg"> |
|
11683 |
|
11684 <code>lazy</code> |
|
11685 |
|
11686 </li> |
|
11687 |
|
11688 </ul><span class="paren">)</span> |
|
11689 </div> |
|
11690 |
|
11691 |
|
11692 |
|
11693 |
|
11694 |
|
11695 |
|
11696 |
|
11697 <span class="flag private">private</span> |
|
11698 |
|
11699 |
|
11700 |
|
11701 |
|
11702 |
|
11703 |
|
11704 |
|
11705 |
|
11706 |
|
11707 |
|
11708 <div class="meta"> |
|
11709 |
|
11710 |
|
11711 <p>Inherited from |
|
11712 <a href="../classes/AttributeCore.html#method__initAttrHost">AttributeCore</a>: |
|
11713 |
|
11714 |
|
11715 |
|
11716 <a href="../files/attribute_js_AttributeCore.js.html#l140"><code>attribute/js/AttributeCore.js:140</code></a> |
|
11717 |
|
11718 </p> |
|
11719 |
|
11720 |
|
11721 |
|
11722 |
|
11723 |
|
11724 </div> |
|
11725 |
|
11726 <div class="description"> |
|
11727 <p>Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the |
|
11728 constructor.</p> |
|
11729 </div> |
|
11730 |
|
11731 |
|
11732 <div class="params"> |
|
11733 <h4>Parameters:</h4> |
|
11734 |
|
11735 <ul class="params-list"> |
|
11736 |
|
11737 <li class="param"> |
|
11738 |
|
11739 <code class="param-name">attrs</code> |
|
11740 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11741 |
|
11742 |
|
11743 |
|
11744 |
|
11745 <div class="param-description"> |
|
11746 <p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
11747 These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p> |
|
11748 </div> |
|
11749 |
|
11750 |
|
11751 </li> |
|
11752 |
|
11753 <li class="param"> |
|
11754 |
|
11755 <code class="param-name">values</code> |
|
11756 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11757 |
|
11758 |
|
11759 |
|
11760 |
|
11761 <div class="param-description"> |
|
11762 <p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
11763 These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p> |
|
11764 </div> |
|
11765 |
|
11766 |
|
11767 </li> |
|
11768 |
|
11769 <li class="param"> |
|
11770 |
|
11771 <code class="param-name">lazy</code> |
|
11772 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
11773 |
|
11774 |
|
11775 |
|
11776 |
|
11777 <div class="param-description"> |
|
11778 <p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p> |
|
11779 </div> |
|
11780 |
|
11781 |
|
11782 </li> |
|
11783 |
|
11784 </ul> |
|
11785 </div> |
|
11786 |
|
11787 |
|
11788 |
|
11789 |
|
11790 |
|
11791 </div> |
|
11792 |
|
11793 |
|
11794 <div id="method__initAttribute" class="method item private inherited"> |
|
11795 <h3 class="name"><code>_initAttribute</code></h3> |
|
11796 |
|
11797 |
|
11798 <span class="paren">()</span> |
|
11799 |
|
11800 |
|
11801 |
|
11802 |
|
11803 |
|
11804 |
|
11805 |
|
11806 <span class="flag private">private</span> |
|
11807 |
|
11808 |
|
11809 |
|
11810 |
|
11811 |
|
11812 |
|
11813 |
|
11814 |
|
11815 |
|
11816 |
|
11817 <div class="meta"> |
|
11818 |
|
11819 <p>Inherited from |
|
11820 <a href="../classes/BaseObservable.html#method__initAttribute"> |
|
11821 BaseObservable |
|
11822 </a> |
|
11823 |
|
11824 but overwritten in |
|
11825 |
|
11826 |
|
11827 |
|
11828 <a href="../files/base_js_BaseCore.js.html#l254"><code>base/js/BaseCore.js:254</code></a> |
|
11829 |
|
11830 </p> |
|
11831 |
|
11832 |
|
11833 |
|
11834 |
|
11835 |
|
11836 </div> |
|
11837 |
|
11838 <div class="description"> |
|
11839 <p>Initializes AttributeCore</p> |
|
11840 </div> |
|
11841 |
|
11842 |
|
11843 |
|
11844 |
|
11845 |
|
11846 |
|
11847 </div> |
|
11848 |
|
11849 |
|
11850 <div id="method__initAttrs" class="method item protected inherited"> |
|
11851 <h3 class="name"><code>_initAttrs</code></h3> |
|
11852 |
|
11853 |
|
11854 <div class="args"> |
|
11855 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11856 |
|
11857 <li class="arg"> |
|
11858 |
|
11859 <code>attrs</code> |
|
11860 |
|
11861 </li> |
|
11862 |
|
11863 <li class="arg"> |
|
11864 |
|
11865 <code>values</code> |
|
11866 |
|
11867 </li> |
|
11868 |
|
11869 <li class="arg"> |
|
11870 |
|
11871 <code>lazy</code> |
|
11872 |
|
11873 </li> |
|
11874 |
|
11875 </ul><span class="paren">)</span> |
|
11876 </div> |
|
11877 |
|
11878 |
|
11879 |
|
11880 |
|
11881 |
|
11882 |
|
11883 |
|
11884 <span class="flag protected">protected</span> |
|
11885 |
|
11886 |
|
11887 |
|
11888 |
|
11889 |
|
11890 |
|
11891 |
|
11892 |
|
11893 |
|
11894 |
|
11895 <div class="meta"> |
|
11896 |
|
11897 |
|
11898 <p>Inherited from |
|
11899 <a href="../classes/AttributeCore.html#method__initAttrs">AttributeCore</a>: |
|
11900 |
|
11901 |
|
11902 |
|
11903 <a href="../files/attribute_js_AttributeCore.js.html#l1011"><code>attribute/js/AttributeCore.js:1011</code></a> |
|
11904 |
|
11905 </p> |
|
11906 |
|
11907 |
|
11908 |
|
11909 |
|
11910 |
|
11911 </div> |
|
11912 |
|
11913 <div class="description"> |
|
11914 <p>Utility method to set up initial attributes defined during construction, |
|
11915 either through the constructor.ATTRS property, or explicitly passed in.</p> |
|
11916 </div> |
|
11917 |
|
11918 |
|
11919 <div class="params"> |
|
11920 <h4>Parameters:</h4> |
|
11921 |
|
11922 <ul class="params-list"> |
|
11923 |
|
11924 <li class="param"> |
|
11925 |
|
11926 <code class="param-name">attrs</code> |
|
11927 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11928 |
|
11929 |
|
11930 |
|
11931 |
|
11932 <div class="param-description"> |
|
11933 <p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
11934 These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p> |
|
11935 </div> |
|
11936 |
|
11937 |
|
11938 </li> |
|
11939 |
|
11940 <li class="param"> |
|
11941 |
|
11942 <code class="param-name">values</code> |
|
11943 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11944 |
|
11945 |
|
11946 |
|
11947 |
|
11948 <div class="param-description"> |
|
11949 <p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
11950 These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p> |
|
11951 </div> |
|
11952 |
|
11953 |
|
11954 </li> |
|
11955 |
|
11956 <li class="param"> |
|
11957 |
|
11958 <code class="param-name">lazy</code> |
|
11959 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
11960 |
|
11961 |
|
11962 |
|
11963 |
|
11964 <div class="param-description"> |
|
11965 <p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p> |
|
11966 </div> |
|
11967 |
|
11968 |
|
11969 </li> |
|
11970 |
|
11971 </ul> |
|
11972 </div> |
|
11973 |
|
11974 |
|
11975 |
|
11976 |
|
11977 |
|
11978 </div> |
|
11979 |
|
11980 |
|
11981 <div id="method__initBase" class="method item private inherited"> |
|
11982 <h3 class="name"><code>_initBase</code></h3> |
|
11983 |
|
11984 |
|
11985 <div class="args"> |
|
11986 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11987 |
|
11988 <li class="arg"> |
|
11989 |
|
11990 <code>config</code> |
|
11991 |
|
11992 </li> |
|
11993 |
|
11994 </ul><span class="paren">)</span> |
|
11995 </div> |
|
11996 |
|
11997 |
|
11998 |
|
11999 |
|
12000 |
|
12001 |
|
12002 |
|
12003 <span class="flag private">private</span> |
|
12004 |
|
12005 |
|
12006 |
|
12007 |
|
12008 |
|
12009 |
|
12010 |
|
12011 |
|
12012 |
|
12013 |
|
12014 <div class="meta"> |
|
12015 |
|
12016 |
|
12017 <p>Inherited from |
|
12018 <a href="../classes/BaseCore.html#method__initBase">BaseCore</a>: |
|
12019 |
|
12020 |
|
12021 |
|
12022 <a href="../files/base_js_BaseCore.js.html#l219"><code>base/js/BaseCore.js:219</code></a> |
|
12023 |
|
12024 </p> |
|
12025 |
|
12026 |
|
12027 |
|
12028 |
|
12029 |
|
12030 </div> |
|
12031 |
|
12032 <div class="description"> |
|
12033 <p>Internal construction logic for BaseCore.</p> |
|
12034 </div> |
|
12035 |
|
12036 |
|
12037 <div class="params"> |
|
12038 <h4>Parameters:</h4> |
|
12039 |
|
12040 <ul class="params-list"> |
|
12041 |
|
12042 <li class="param"> |
|
12043 |
|
12044 <code class="param-name">config</code> |
|
12045 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12046 |
|
12047 |
|
12048 |
|
12049 |
|
12050 <div class="param-description"> |
|
12051 <p>The constructor configuration object</p> |
|
12052 </div> |
|
12053 |
|
12054 |
|
12055 </li> |
|
12056 |
|
12057 </ul> |
|
12058 </div> |
|
12059 |
|
12060 |
|
12061 |
|
12062 |
|
12063 |
|
12064 </div> |
|
12065 |
|
12066 |
|
12067 <div id="method__initColumns" class="method item protected"> |
|
12068 <h3 class="name"><code>_initColumns</code></h3> |
|
12069 |
|
12070 |
|
12071 <span class="paren">()</span> |
|
12072 |
|
12073 |
|
12074 |
|
12075 |
|
12076 |
|
12077 |
|
12078 |
|
12079 <span class="flag protected">protected</span> |
|
12080 |
|
12081 |
|
12082 |
|
12083 |
|
12084 |
|
12085 |
|
12086 |
|
12087 |
|
12088 |
|
12089 |
|
12090 <div class="meta"> |
|
12091 |
|
12092 |
|
12093 |
|
12094 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
12095 |
|
12096 <p> |
|
12097 |
|
12098 Defined in |
|
12099 |
|
12100 |
|
12101 |
|
12102 |
|
12103 <a href="../files/datatable_js_core.js.html#l488"><code>datatable/js/core.js:488</code></a> |
|
12104 |
|
12105 </p> |
|
12106 |
|
12107 |
|
12108 |
|
12109 |
|
12110 |
|
12111 <p>Available since 3.5.0</p> |
|
12112 |
|
12113 </div> |
|
12114 |
|
12115 <div class="description"> |
|
12116 <p>Initializes the <code>_columnMap</code> property from the configured <code>columns</code> |
|
12117 attribute. If <code>columns</code> is not set, but there are records in the <code>data</code> |
|
12118 ModelList, use |
|
12119 <code>ATTRS</code> of that class.</p> |
|
12120 </div> |
|
12121 |
|
12122 |
|
12123 |
|
12124 |
|
12125 |
|
12126 |
|
12127 </div> |
|
12128 |
|
12129 |
|
12130 <div id="method__initCoreEvents" class="method item protected"> |
|
12131 <h3 class="name"><code>_initCoreEvents</code></h3> |
|
12132 |
|
12133 |
|
12134 <span class="paren">()</span> |
|
12135 |
|
12136 |
|
12137 |
|
12138 |
|
12139 |
|
12140 |
|
12141 |
|
12142 <span class="flag protected">protected</span> |
|
12143 |
|
12144 |
|
12145 |
|
12146 |
|
12147 |
|
12148 |
|
12149 |
|
12150 |
|
12151 |
|
12152 |
|
12153 <div class="meta"> |
|
12154 |
|
12155 |
|
12156 |
|
12157 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
12158 |
|
12159 <p> |
|
12160 |
|
12161 Defined in |
|
12162 |
|
12163 |
|
12164 |
|
12165 |
|
12166 <a href="../files/datatable_js_core.js.html#l517"><code>datatable/js/core.js:517</code></a> |
|
12167 |
|
12168 </p> |
|
12169 |
|
12170 |
|
12171 |
|
12172 |
|
12173 |
|
12174 <p>Available since 3.6.0</p> |
|
12175 |
|
12176 </div> |
|
12177 |
|
12178 <div class="description"> |
|
12179 <p>Sets up the change event subscriptions to maintain internal state.</p> |
|
12180 </div> |
|
12181 |
|
12182 |
|
12183 |
|
12184 |
|
12185 |
|
12186 |
|
12187 </div> |
|
12188 |
|
12189 |
|
12190 <div id="method__initData" class="method item protected"> |
|
12191 <h3 class="name"><code>_initData</code></h3> |
|
12192 |
|
12193 |
|
12194 <span class="paren">()</span> |
|
12195 |
|
12196 |
|
12197 |
|
12198 <span class="returns-inline"> |
|
12199 <span class="type"><a href="../classes/ModelList.html" class="crosslink">ModelList</a></span> |
|
12200 </span> |
|
12201 |
|
12202 |
|
12203 |
|
12204 |
|
12205 |
|
12206 <span class="flag protected">protected</span> |
|
12207 |
|
12208 |
|
12209 |
|
12210 |
|
12211 |
|
12212 |
|
12213 |
|
12214 |
|
12215 |
|
12216 |
|
12217 <div class="meta"> |
|
12218 |
|
12219 |
|
12220 |
|
12221 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
12222 |
|
12223 <p> |
|
12224 |
|
12225 Defined in |
|
12226 |
|
12227 |
|
12228 |
|
12229 |
|
12230 <a href="../files/datatable_js_core.js.html#l532"><code>datatable/js/core.js:532</code></a> |
|
12231 |
|
12232 </p> |
|
12233 |
|
12234 |
|
12235 |
|
12236 |
|
12237 |
|
12238 <p>Available since 3.6.0</p> |
|
12239 |
|
12240 </div> |
|
12241 |
|
12242 <div class="description"> |
|
12243 <p>Defaults the <code>data</code> attribute to an empty ModelList if not set during |
|
12244 construction. Uses the configured <code>recordType</code> for the ModelList's <code>model</code> |
|
12245 proeprty if set.</p> |
|
12246 </div> |
|
12247 |
|
12248 |
|
12249 |
|
12250 |
|
12251 <div class="returns"> |
|
12252 <h4>Returns:</h4> |
|
12253 |
|
12254 <div class="returns-description"> |
|
12255 |
|
12256 |
|
12257 <span class="type"><a href="../classes/ModelList.html" class="crosslink">ModelList</a></span>: |
|
12258 |
|
12259 |
|
12260 </div> |
|
12261 </div> |
|
12262 |
|
12263 |
|
12264 |
|
12265 </div> |
|
12266 |
|
12267 |
|
12268 <div id="method__initDataProperty" class="method item protected"> |
|
12269 <h3 class="name"><code>_initDataProperty</code></h3> |
|
12270 |
|
12271 |
|
12272 <div class="args"> |
|
12273 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12274 |
|
12275 <li class="arg"> |
|
12276 |
|
12277 <code>data</code> |
|
12278 |
|
12279 </li> |
|
12280 |
|
12281 </ul><span class="paren">)</span> |
|
12282 </div> |
|
12283 |
|
12284 |
|
12285 |
|
12286 |
|
12287 |
|
12288 |
|
12289 |
|
12290 <span class="flag protected">protected</span> |
|
12291 |
|
12292 |
|
12293 |
|
12294 |
|
12295 |
|
12296 |
|
12297 |
|
12298 |
|
12299 |
|
12300 |
|
12301 <div class="meta"> |
|
12302 |
|
12303 |
|
12304 |
|
12305 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
12306 |
|
12307 <p> |
|
12308 |
|
12309 Defined in |
|
12310 |
|
12311 |
|
12312 |
|
12313 |
|
12314 <a href="../files/datatable_js_core.js.html#l554"><code>datatable/js/core.js:554</code></a> |
|
12315 |
|
12316 </p> |
|
12317 |
|
12318 |
|
12319 |
|
12320 |
|
12321 |
|
12322 <p>Available since 3.6.0</p> |
|
12323 |
|
12324 </div> |
|
12325 |
|
12326 <div class="description"> |
|
12327 <p>Initializes the instance's <code>data</code> property from the value of the <code>data</code> |
|
12328 attribute. If the attribute value is a ModelList, it is assigned directly |
|
12329 to <code>this.data</code>. If it is an array, a ModelList is created, its <code>model</code> |
|
12330 property is set to the configured <code>recordType</code> class, and it is seeded with |
|
12331 the array data. This ModelList is then assigned to <code>this.data</code>.</p> |
|
12332 </div> |
|
12333 |
|
12334 |
|
12335 <div class="params"> |
|
12336 <h4>Parameters:</h4> |
|
12337 |
|
12338 <ul class="params-list"> |
|
12339 |
|
12340 <li class="param"> |
|
12341 |
|
12342 <code class="param-name">data</code> |
|
12343 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | <a href="../classes/ModelList.html" class="crosslink">ModelList</a> | <a href="../classes/ArrayList.html" class="crosslink">ArrayList</a></span> |
|
12344 |
|
12345 |
|
12346 |
|
12347 |
|
12348 <div class="param-description"> |
|
12349 <p>Collection of data to populate the |
|
12350 DataTable</p> |
|
12351 </div> |
|
12352 |
|
12353 |
|
12354 </li> |
|
12355 |
|
12356 </ul> |
|
12357 </div> |
|
12358 |
|
12359 |
|
12360 |
|
12361 |
|
12362 |
|
12363 </div> |
|
12364 |
|
12365 |
|
12366 <div id="method__initHierarchy" class="method item private inherited"> |
|
12367 <h3 class="name"><code>_initHierarchy</code></h3> |
|
12368 |
|
12369 |
|
12370 <div class="args"> |
|
12371 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12372 |
|
12373 <li class="arg"> |
|
12374 |
|
12375 <code>userVals</code> |
|
12376 |
|
12377 </li> |
|
12378 |
|
12379 </ul><span class="paren">)</span> |
|
12380 </div> |
|
12381 |
|
12382 |
|
12383 |
|
12384 |
|
12385 |
|
12386 |
|
12387 |
|
12388 <span class="flag private">private</span> |
|
12389 |
|
12390 |
|
12391 |
|
12392 |
|
12393 |
|
12394 |
|
12395 |
|
12396 |
|
12397 |
|
12398 |
|
12399 <div class="meta"> |
|
12400 |
|
12401 |
|
12402 <p>Inherited from |
|
12403 <a href="../classes/BaseCore.html#method__initHierarchy">BaseCore</a>: |
|
12404 |
|
12405 |
|
12406 |
|
12407 <a href="../files/base_js_BaseCore.js.html#l659"><code>base/js/BaseCore.js:659</code></a> |
|
12408 |
|
12409 </p> |
|
12410 |
|
12411 |
|
12412 |
|
12413 |
|
12414 |
|
12415 </div> |
|
12416 |
|
12417 <div class="description"> |
|
12418 <p>Initializes the class hierarchy for the instance, which includes |
|
12419 initializing attributes for each class defined in the class's |
|
12420 static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and |
|
12421 invoking the initializer method on the prototype of each class in the hierarchy.</p> |
|
12422 </div> |
|
12423 |
|
12424 |
|
12425 <div class="params"> |
|
12426 <h4>Parameters:</h4> |
|
12427 |
|
12428 <ul class="params-list"> |
|
12429 |
|
12430 <li class="param"> |
|
12431 |
|
12432 <code class="param-name">userVals</code> |
|
12433 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12434 |
|
12435 |
|
12436 |
|
12437 |
|
12438 <div class="param-description"> |
|
12439 <p>Object with configuration property name/value pairs</p> |
|
12440 </div> |
|
12441 |
|
12442 |
|
12443 </li> |
|
12444 |
|
12445 </ul> |
|
12446 </div> |
|
12447 |
|
12448 |
|
12449 |
|
12450 |
|
12451 |
|
12452 </div> |
|
12453 |
|
12454 |
|
12455 <div id="method__initHierarchyData" class="method item private inherited"> |
|
12456 <h3 class="name"><code>_initHierarchyData</code></h3> |
|
12457 |
|
12458 |
|
12459 <span class="paren">()</span> |
|
12460 |
|
12461 |
|
12462 |
|
12463 |
|
12464 |
|
12465 |
|
12466 |
|
12467 <span class="flag private">private</span> |
|
12468 |
|
12469 |
|
12470 |
|
12471 |
|
12472 |
|
12473 |
|
12474 |
|
12475 |
|
12476 |
|
12477 |
|
12478 <div class="meta"> |
|
12479 |
|
12480 |
|
12481 <p>Inherited from |
|
12482 <a href="../classes/BaseCore.html#method__initHierarchyData">BaseCore</a>: |
|
12483 |
|
12484 |
|
12485 |
|
12486 <a href="../files/base_js_BaseCore.js.html#l457"><code>base/js/BaseCore.js:457</code></a> |
|
12487 |
|
12488 </p> |
|
12489 |
|
12490 |
|
12491 |
|
12492 |
|
12493 |
|
12494 </div> |
|
12495 |
|
12496 <div class="description"> |
|
12497 <p>A helper method used by _getClasses and _getAttrCfgs, which determines both |
|
12498 the array of classes and aggregate set of attribute configurations |
|
12499 across the class hierarchy for the instance.</p> |
|
12500 </div> |
|
12501 |
|
12502 |
|
12503 |
|
12504 |
|
12505 |
|
12506 |
|
12507 </div> |
|
12508 |
|
12509 |
|
12510 <div id="method__initMessageNode" class="method item protected"> |
|
12511 <h3 class="name"><code>_initMessageNode</code></h3> |
|
12512 |
|
12513 |
|
12514 <span class="paren">()</span> |
|
12515 |
|
12516 |
|
12517 |
|
12518 |
|
12519 |
|
12520 |
|
12521 |
|
12522 <span class="flag protected">protected</span> |
|
12523 |
|
12524 |
|
12525 |
|
12526 |
|
12527 |
|
12528 |
|
12529 |
|
12530 |
|
12531 |
|
12532 |
|
12533 <div class="meta"> |
|
12534 |
|
12535 |
|
12536 |
|
12537 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
12538 |
|
12539 <p> |
|
12540 |
|
12541 Defined in |
|
12542 |
|
12543 |
|
12544 |
|
12545 |
|
12546 <a href="../files/datatable_js_message.js.html#l203"><code>datatable/js/message.js:203</code></a> |
|
12547 |
|
12548 </p> |
|
12549 |
|
12550 |
|
12551 |
|
12552 |
|
12553 |
|
12554 <p>Available since 3.5.0</p> |
|
12555 |
|
12556 </div> |
|
12557 |
|
12558 <div class="description"> |
|
12559 <p>Creates the <code>_messageNode</code> property from the configured <code>MESSAGE_TEMPLATE</code> |
|
12560 and inserts it before the <code><table></code>'s <code><tbody></code> node.</p> |
|
12561 </div> |
|
12562 |
|
12563 |
|
12564 |
|
12565 |
|
12566 |
|
12567 |
|
12568 </div> |
|
12569 |
|
12570 |
|
12571 <div id="method__initMessageStrings" class="method item protected"> |
|
12572 <h3 class="name"><code>_initMessageStrings</code></h3> |
|
12573 |
|
12574 |
|
12575 <span class="paren">()</span> |
|
12576 |
|
12577 |
|
12578 |
|
12579 |
|
12580 |
|
12581 |
|
12582 |
|
12583 <span class="flag protected">protected</span> |
|
12584 |
|
12585 |
|
12586 |
|
12587 |
|
12588 |
|
12589 |
|
12590 |
|
12591 |
|
12592 |
|
12593 |
|
12594 <div class="meta"> |
|
12595 |
|
12596 |
|
12597 |
|
12598 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
12599 |
|
12600 <p> |
|
12601 |
|
12602 Defined in |
|
12603 |
|
12604 |
|
12605 |
|
12606 |
|
12607 <a href="../files/datatable_js_message.js.html#l224"><code>datatable/js/message.js:224</code></a> |
|
12608 |
|
12609 </p> |
|
12610 |
|
12611 |
|
12612 |
|
12613 |
|
12614 |
|
12615 <p>Available since 3.5.0</p> |
|
12616 |
|
12617 </div> |
|
12618 |
|
12619 <div class="description"> |
|
12620 <p>Add the messaging related strings to the <code>strings</code> map.</p> |
|
12621 </div> |
|
12622 |
|
12623 |
|
12624 |
|
12625 |
|
12626 |
|
12627 |
|
12628 </div> |
|
12629 |
|
12630 |
|
12631 <div id="method__initSortFn" class="method item protected"> |
|
12632 <h3 class="name"><code>_initSortFn</code></h3> |
|
12633 |
|
12634 |
|
12635 <span class="paren">()</span> |
|
12636 |
|
12637 |
|
12638 |
|
12639 |
|
12640 |
|
12641 |
|
12642 |
|
12643 <span class="flag protected">protected</span> |
|
12644 |
|
12645 |
|
12646 |
|
12647 |
|
12648 |
|
12649 |
|
12650 |
|
12651 |
|
12652 |
|
12653 |
|
12654 <div class="meta"> |
|
12655 |
|
12656 |
|
12657 |
|
12658 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
12659 |
|
12660 <p> |
|
12661 |
|
12662 Defined in |
|
12663 |
|
12664 |
|
12665 |
|
12666 |
|
12667 <a href="../files/datatable_js_sort.js.html#l477"><code>datatable/js/sort.js:477</code></a> |
|
12668 |
|
12669 </p> |
|
12670 |
|
12671 |
|
12672 |
|
12673 |
|
12674 |
|
12675 <p>Available since 3.5.0</p> |
|
12676 |
|
12677 </div> |
|
12678 |
|
12679 <div class="description"> |
|
12680 <p>Creates a <code>_compare</code> function for the <code>data</code> ModelList to allow custom |
|
12681 sorting by multiple fields.</p> |
|
12682 </div> |
|
12683 |
|
12684 |
|
12685 |
|
12686 |
|
12687 |
|
12688 |
|
12689 </div> |
|
12690 |
|
12691 |
|
12692 <div id="method__initSortStrings" class="method item protected"> |
|
12693 <h3 class="name"><code>_initSortStrings</code></h3> |
|
12694 |
|
12695 |
|
12696 <span class="paren">()</span> |
|
12697 |
|
12698 |
|
12699 |
|
12700 |
|
12701 |
|
12702 |
|
12703 |
|
12704 <span class="flag protected">protected</span> |
|
12705 |
|
12706 |
|
12707 |
|
12708 |
|
12709 |
|
12710 |
|
12711 |
|
12712 |
|
12713 |
|
12714 |
|
12715 <div class="meta"> |
|
12716 |
|
12717 |
|
12718 |
|
12719 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
12720 |
|
12721 <p> |
|
12722 |
|
12723 Defined in |
|
12724 |
|
12725 |
|
12726 |
|
12727 |
|
12728 <a href="../files/datatable_js_sort.js.html#l532"><code>datatable/js/sort.js:532</code></a> |
|
12729 |
|
12730 </p> |
|
12731 |
|
12732 |
|
12733 |
|
12734 |
|
12735 |
|
12736 <p>Available since 3.5.0</p> |
|
12737 |
|
12738 </div> |
|
12739 |
|
12740 <div class="description"> |
|
12741 <p>Add the sort related strings to the <code>strings</code> map.</p> |
|
12742 </div> |
|
12743 |
|
12744 |
|
12745 |
|
12746 |
|
12747 |
|
12748 |
|
12749 </div> |
|
12750 |
|
12751 |
|
12752 <div id="method__initUIEvent" class="method item private inherited"> |
|
12753 <h3 class="name"><code>_initUIEvent</code></h3> |
|
12754 |
|
12755 |
|
12756 <div class="args"> |
|
12757 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12758 |
|
12759 <li class="arg"> |
|
12760 |
|
12761 <code>type</code> |
|
12762 |
|
12763 </li> |
|
12764 |
|
12765 </ul><span class="paren">)</span> |
|
12766 </div> |
|
12767 |
|
12768 |
|
12769 |
|
12770 <span class="returns-inline"> |
|
12771 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12772 </span> |
|
12773 |
|
12774 |
|
12775 |
|
12776 |
|
12777 |
|
12778 <span class="flag private">private</span> |
|
12779 |
|
12780 |
|
12781 |
|
12782 |
|
12783 |
|
12784 |
|
12785 |
|
12786 |
|
12787 |
|
12788 |
|
12789 <div class="meta"> |
|
12790 |
|
12791 |
|
12792 <p>Inherited from |
|
12793 <a href="../classes/Widget.html#method__initUIEvent">Widget</a>: |
|
12794 |
|
12795 |
|
12796 |
|
12797 <a href="../files/widget_js_WidgetUIEvents.js.html#l176"><code>widget/js/WidgetUIEvents.js:176</code></a> |
|
12798 |
|
12799 </p> |
|
12800 |
|
12801 |
|
12802 |
|
12803 |
|
12804 |
|
12805 </div> |
|
12806 |
|
12807 <div class="description"> |
|
12808 <p>Sets up infrastructure required to fire a UI event.</p> |
|
12809 </div> |
|
12810 |
|
12811 |
|
12812 <div class="params"> |
|
12813 <h4>Parameters:</h4> |
|
12814 |
|
12815 <ul class="params-list"> |
|
12816 |
|
12817 <li class="param"> |
|
12818 |
|
12819 <code class="param-name">type</code> |
|
12820 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12821 |
|
12822 |
|
12823 |
|
12824 |
|
12825 <div class="param-description"> |
|
12826 <p>String representing the name of the event</p> |
|
12827 </div> |
|
12828 |
|
12829 |
|
12830 </li> |
|
12831 |
|
12832 </ul> |
|
12833 </div> |
|
12834 |
|
12835 |
|
12836 |
|
12837 <div class="returns"> |
|
12838 <h4>Returns:</h4> |
|
12839 |
|
12840 <div class="returns-description"> |
|
12841 |
|
12842 |
|
12843 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
12844 |
|
12845 |
|
12846 </div> |
|
12847 </div> |
|
12848 |
|
12849 |
|
12850 |
|
12851 </div> |
|
12852 |
|
12853 |
|
12854 <div id="method__isLazyAttr" class="method item private inherited"> |
|
12855 <h3 class="name"><code>_isLazyAttr</code></h3> |
|
12856 |
|
12857 |
|
12858 <div class="args"> |
|
12859 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12860 |
|
12861 <li class="arg"> |
|
12862 |
|
12863 <code>name</code> |
|
12864 |
|
12865 </li> |
|
12866 |
|
12867 </ul><span class="paren">)</span> |
|
12868 </div> |
|
12869 |
|
12870 |
|
12871 |
|
12872 <span class="returns-inline"> |
|
12873 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
12874 </span> |
|
12875 |
|
12876 |
|
12877 |
|
12878 |
|
12879 |
|
12880 <span class="flag private">private</span> |
|
12881 |
|
12882 |
|
12883 |
|
12884 |
|
12885 |
|
12886 |
|
12887 |
|
12888 |
|
12889 |
|
12890 |
|
12891 <div class="meta"> |
|
12892 |
|
12893 |
|
12894 <p>Inherited from |
|
12895 <a href="../classes/AttributeCore.html#method__isLazyAttr">AttributeCore</a>: |
|
12896 |
|
12897 |
|
12898 |
|
12899 <a href="../files/attribute_js_AttributeCore.js.html#l369"><code>attribute/js/AttributeCore.js:369</code></a> |
|
12900 |
|
12901 </p> |
|
12902 |
|
12903 |
|
12904 |
|
12905 |
|
12906 |
|
12907 </div> |
|
12908 |
|
12909 <div class="description"> |
|
12910 <p>Checks whether or not the attribute is one which has been |
|
12911 added lazily and still requires initialization.</p> |
|
12912 </div> |
|
12913 |
|
12914 |
|
12915 <div class="params"> |
|
12916 <h4>Parameters:</h4> |
|
12917 |
|
12918 <ul class="params-list"> |
|
12919 |
|
12920 <li class="param"> |
|
12921 |
|
12922 <code class="param-name">name</code> |
|
12923 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12924 |
|
12925 |
|
12926 |
|
12927 |
|
12928 <div class="param-description"> |
|
12929 <p>The name of the attribute</p> |
|
12930 </div> |
|
12931 |
|
12932 |
|
12933 </li> |
|
12934 |
|
12935 </ul> |
|
12936 </div> |
|
12937 |
|
12938 |
|
12939 |
|
12940 <div class="returns"> |
|
12941 <h4>Returns:</h4> |
|
12942 |
|
12943 <div class="returns-description"> |
|
12944 |
|
12945 |
|
12946 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
12947 |
|
12948 true if it's a lazily added attribute, false otherwise. |
|
12949 |
|
12950 </div> |
|
12951 </div> |
|
12952 |
|
12953 |
|
12954 |
|
12955 </div> |
|
12956 |
|
12957 |
|
12958 <div id="method__isUIEvent" class="method item private inherited"> |
|
12959 <h3 class="name"><code>_isUIEvent</code></h3> |
|
12960 |
|
12961 |
|
12962 <div class="args"> |
|
12963 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12964 |
|
12965 <li class="arg"> |
|
12966 |
|
12967 <code>type</code> |
|
12968 |
|
12969 </li> |
|
12970 |
|
12971 </ul><span class="paren">)</span> |
|
12972 </div> |
|
12973 |
|
12974 |
|
12975 |
|
12976 <span class="returns-inline"> |
|
12977 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12978 </span> |
|
12979 |
|
12980 |
|
12981 |
|
12982 |
|
12983 |
|
12984 <span class="flag private">private</span> |
|
12985 |
|
12986 |
|
12987 |
|
12988 |
|
12989 |
|
12990 |
|
12991 |
|
12992 |
|
12993 |
|
12994 |
|
12995 <div class="meta"> |
|
12996 |
|
12997 |
|
12998 <p>Inherited from |
|
12999 <a href="../classes/Widget.html#method__isUIEvent">Widget</a>: |
|
13000 |
|
13001 |
|
13002 |
|
13003 <a href="../files/widget_js_WidgetUIEvents.js.html#l143"><code>widget/js/WidgetUIEvents.js:143</code></a> |
|
13004 |
|
13005 </p> |
|
13006 |
|
13007 |
|
13008 |
|
13009 |
|
13010 |
|
13011 </div> |
|
13012 |
|
13013 <div class="description"> |
|
13014 <p>Determines if the specified event is a UI event.</p> |
|
13015 </div> |
|
13016 |
|
13017 |
|
13018 <div class="params"> |
|
13019 <h4>Parameters:</h4> |
|
13020 |
|
13021 <ul class="params-list"> |
|
13022 |
|
13023 <li class="param"> |
|
13024 |
|
13025 <code class="param-name">type</code> |
|
13026 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13027 |
|
13028 |
|
13029 |
|
13030 |
|
13031 <div class="param-description"> |
|
13032 <p>String representing the name of the event</p> |
|
13033 </div> |
|
13034 |
|
13035 |
|
13036 </li> |
|
13037 |
|
13038 </ul> |
|
13039 </div> |
|
13040 |
|
13041 |
|
13042 |
|
13043 <div class="returns"> |
|
13044 <h4>Returns:</h4> |
|
13045 |
|
13046 <div class="returns-description"> |
|
13047 |
|
13048 |
|
13049 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
13050 |
|
13051 Event Returns the name of the UI Event, otherwise |
|
13052 undefined. |
|
13053 |
|
13054 </div> |
|
13055 </div> |
|
13056 |
|
13057 |
|
13058 |
|
13059 </div> |
|
13060 |
|
13061 |
|
13062 <div id="method__mapInstance" class="method item protected inherited"> |
|
13063 <h3 class="name"><code>_mapInstance</code></h3> |
|
13064 |
|
13065 |
|
13066 <div class="args"> |
|
13067 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13068 |
|
13069 <li class="arg"> |
|
13070 |
|
13071 <code>The</code> |
|
13072 |
|
13073 </li> |
|
13074 |
|
13075 </ul><span class="paren">)</span> |
|
13076 </div> |
|
13077 |
|
13078 |
|
13079 |
|
13080 |
|
13081 |
|
13082 |
|
13083 |
|
13084 <span class="flag protected">protected</span> |
|
13085 |
|
13086 |
|
13087 |
|
13088 |
|
13089 |
|
13090 |
|
13091 |
|
13092 |
|
13093 |
|
13094 |
|
13095 <div class="meta"> |
|
13096 |
|
13097 |
|
13098 <p>Inherited from |
|
13099 <a href="../classes/Widget.html#method__mapInstance">Widget</a>: |
|
13100 |
|
13101 |
|
13102 |
|
13103 <a href="../files/widget_js_Widget.js.html#l414"><code>widget/js/Widget.js:414</code></a> |
|
13104 |
|
13105 </p> |
|
13106 |
|
13107 |
|
13108 |
|
13109 |
|
13110 |
|
13111 </div> |
|
13112 |
|
13113 <div class="description"> |
|
13114 <p>Utility method used to add an entry to the boundingBox id to instance map.</p> |
|
13115 |
|
13116 <p>This method can be used to populate the instance with lazily created boundingBox Node references.</p> |
|
13117 </div> |
|
13118 |
|
13119 |
|
13120 <div class="params"> |
|
13121 <h4>Parameters:</h4> |
|
13122 |
|
13123 <ul class="params-list"> |
|
13124 |
|
13125 <li class="param"> |
|
13126 |
|
13127 <code class="param-name">The</code> |
|
13128 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13129 |
|
13130 |
|
13131 |
|
13132 |
|
13133 <div class="param-description"> |
|
13134 <p>boundingBox id</p> |
|
13135 </div> |
|
13136 |
|
13137 |
|
13138 </li> |
|
13139 |
|
13140 </ul> |
|
13141 </div> |
|
13142 |
|
13143 |
|
13144 |
|
13145 |
|
13146 |
|
13147 </div> |
|
13148 |
|
13149 |
|
13150 <div id="method__monitor" class="method item private inherited"> |
|
13151 <h3 class="name"><code>_monitor</code></h3> |
|
13152 |
|
13153 |
|
13154 <div class="args"> |
|
13155 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13156 |
|
13157 <li class="arg"> |
|
13158 |
|
13159 <code>what</code> |
|
13160 |
|
13161 </li> |
|
13162 |
|
13163 <li class="arg"> |
|
13164 |
|
13165 <code>eventType</code> |
|
13166 |
|
13167 </li> |
|
13168 |
|
13169 <li class="arg"> |
|
13170 |
|
13171 <code>o</code> |
|
13172 |
|
13173 </li> |
|
13174 |
|
13175 </ul><span class="paren">)</span> |
|
13176 </div> |
|
13177 |
|
13178 |
|
13179 |
|
13180 |
|
13181 |
|
13182 |
|
13183 |
|
13184 <span class="flag private">private</span> |
|
13185 |
|
13186 |
|
13187 |
|
13188 |
|
13189 |
|
13190 |
|
13191 |
|
13192 |
|
13193 |
|
13194 |
|
13195 <div class="meta"> |
|
13196 |
|
13197 |
|
13198 <p>Inherited from |
|
13199 <a href="../classes/EventTarget.html#method__monitor">EventTarget</a>: |
|
13200 |
|
13201 |
|
13202 |
|
13203 <a href="../files/event-custom_js_event-target.js.html#l658"><code>event-custom/js/event-target.js:658</code></a> |
|
13204 |
|
13205 </p> |
|
13206 |
|
13207 |
|
13208 |
|
13209 |
|
13210 |
|
13211 </div> |
|
13212 |
|
13213 <div class="description"> |
|
13214 <p>This is the entry point for the event monitoring system. |
|
13215 You can monitor 'attach', 'detach', 'fire', and 'publish'. |
|
13216 When configured, these events generate an event. click -> |
|
13217 click<em>attach, click</em>detach, click_publish -- these can |
|
13218 be subscribed to like other events to monitor the event |
|
13219 system. Inividual published events can have monitoring |
|
13220 turned on or off (publish can't be turned off before it |
|
13221 it published) by setting the events 'monitor' config.</p> |
|
13222 </div> |
|
13223 |
|
13224 |
|
13225 <div class="params"> |
|
13226 <h4>Parameters:</h4> |
|
13227 |
|
13228 <ul class="params-list"> |
|
13229 |
|
13230 <li class="param"> |
|
13231 |
|
13232 <code class="param-name">what</code> |
|
13233 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13234 |
|
13235 |
|
13236 |
|
13237 |
|
13238 <div class="param-description"> |
|
13239 <p>'attach', 'detach', 'fire', or 'publish'</p> |
|
13240 </div> |
|
13241 |
|
13242 |
|
13243 </li> |
|
13244 |
|
13245 <li class="param"> |
|
13246 |
|
13247 <code class="param-name">eventType</code> |
|
13248 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
13249 |
|
13250 |
|
13251 |
|
13252 |
|
13253 <div class="param-description"> |
|
13254 <p>The prefixed name of the event being monitored, or the CustomEvent object.</p> |
|
13255 </div> |
|
13256 |
|
13257 |
|
13258 </li> |
|
13259 |
|
13260 <li class="param"> |
|
13261 |
|
13262 <code class="param-name">o</code> |
|
13263 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13264 |
|
13265 |
|
13266 |
|
13267 |
|
13268 <div class="param-description"> |
|
13269 <p>Information about the event interaction, such as |
|
13270 fire() args, subscription category, publish config</p> |
|
13271 </div> |
|
13272 |
|
13273 |
|
13274 </li> |
|
13275 |
|
13276 </ul> |
|
13277 </div> |
|
13278 |
|
13279 |
|
13280 |
|
13281 |
|
13282 |
|
13283 </div> |
|
13284 |
|
13285 |
|
13286 <div id="method__normAttrVals" class="method item private inherited"> |
|
13287 <h3 class="name"><code>_normAttrVals</code></h3> |
|
13288 |
|
13289 |
|
13290 <div class="args"> |
|
13291 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13292 |
|
13293 <li class="arg"> |
|
13294 |
|
13295 <code>valueHash</code> |
|
13296 |
|
13297 </li> |
|
13298 |
|
13299 </ul><span class="paren">)</span> |
|
13300 </div> |
|
13301 |
|
13302 |
|
13303 |
|
13304 <span class="returns-inline"> |
|
13305 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13306 </span> |
|
13307 |
|
13308 |
|
13309 |
|
13310 |
|
13311 |
|
13312 <span class="flag private">private</span> |
|
13313 |
|
13314 |
|
13315 |
|
13316 |
|
13317 |
|
13318 |
|
13319 |
|
13320 |
|
13321 |
|
13322 |
|
13323 <div class="meta"> |
|
13324 |
|
13325 |
|
13326 <p>Inherited from |
|
13327 <a href="../classes/AttributeCore.html#method__normAttrVals">AttributeCore</a>: |
|
13328 |
|
13329 |
|
13330 |
|
13331 <a href="../files/attribute_js_AttributeCore.js.html#l897"><code>attribute/js/AttributeCore.js:897</code></a> |
|
13332 |
|
13333 </p> |
|
13334 |
|
13335 |
|
13336 |
|
13337 |
|
13338 |
|
13339 </div> |
|
13340 |
|
13341 <div class="description"> |
|
13342 <p>Utility method to normalize attribute values. The base implementation |
|
13343 simply merges the hash to protect the original.</p> |
|
13344 </div> |
|
13345 |
|
13346 |
|
13347 <div class="params"> |
|
13348 <h4>Parameters:</h4> |
|
13349 |
|
13350 <ul class="params-list"> |
|
13351 |
|
13352 <li class="param"> |
|
13353 |
|
13354 <code class="param-name">valueHash</code> |
|
13355 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13356 |
|
13357 |
|
13358 |
|
13359 |
|
13360 <div class="param-description"> |
|
13361 <p>An object with attribute name/value pairs</p> |
|
13362 </div> |
|
13363 |
|
13364 |
|
13365 </li> |
|
13366 |
|
13367 </ul> |
|
13368 </div> |
|
13369 |
|
13370 |
|
13371 |
|
13372 <div class="returns"> |
|
13373 <h4>Returns:</h4> |
|
13374 |
|
13375 <div class="returns-description"> |
|
13376 |
|
13377 |
|
13378 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
13379 |
|
13380 An object literal with 2 properties - "simple" and "complex", |
|
13381 containing simple and complex attribute values respectively keyed |
|
13382 by the top level attribute name, or null, if valueHash is falsey. |
|
13383 |
|
13384 </div> |
|
13385 </div> |
|
13386 |
|
13387 |
|
13388 |
|
13389 </div> |
|
13390 |
|
13391 |
|
13392 <div id="method__onDocFocus" class="method item protected inherited"> |
|
13393 <h3 class="name"><code>_onDocFocus</code></h3> |
|
13394 |
|
13395 |
|
13396 <div class="args"> |
|
13397 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13398 |
|
13399 <li class="arg"> |
|
13400 |
|
13401 <code>evt</code> |
|
13402 |
|
13403 </li> |
|
13404 |
|
13405 </ul><span class="paren">)</span> |
|
13406 </div> |
|
13407 |
|
13408 |
|
13409 |
|
13410 |
|
13411 |
|
13412 |
|
13413 |
|
13414 <span class="flag protected">protected</span> |
|
13415 |
|
13416 |
|
13417 |
|
13418 |
|
13419 |
|
13420 |
|
13421 |
|
13422 |
|
13423 |
|
13424 |
|
13425 <div class="meta"> |
|
13426 |
|
13427 |
|
13428 <p>Inherited from |
|
13429 <a href="../classes/Widget.html#method__onDocFocus">Widget</a>: |
|
13430 |
|
13431 |
|
13432 |
|
13433 <a href="../files/widget_js_Widget.js.html#l1081"><code>widget/js/Widget.js:1081</code></a> |
|
13434 |
|
13435 </p> |
|
13436 |
|
13437 |
|
13438 |
|
13439 |
|
13440 |
|
13441 </div> |
|
13442 |
|
13443 <div class="description"> |
|
13444 <p>DOM focus event handler, used to sync the state of the Widget with the DOM</p> |
|
13445 </div> |
|
13446 |
|
13447 |
|
13448 <div class="params"> |
|
13449 <h4>Parameters:</h4> |
|
13450 |
|
13451 <ul class="params-list"> |
|
13452 |
|
13453 <li class="param"> |
|
13454 |
|
13455 <code class="param-name">evt</code> |
|
13456 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
13457 |
|
13458 |
|
13459 |
|
13460 |
|
13461 <div class="param-description"> |
|
13462 <p>The event facade for the DOM focus event</p> |
|
13463 </div> |
|
13464 |
|
13465 |
|
13466 </li> |
|
13467 |
|
13468 </ul> |
|
13469 </div> |
|
13470 |
|
13471 |
|
13472 |
|
13473 |
|
13474 |
|
13475 </div> |
|
13476 |
|
13477 |
|
13478 <div id="method__onDocMouseDown" class="method item protected inherited"> |
|
13479 <h3 class="name"><code>_onDocMouseDown</code></h3> |
|
13480 |
|
13481 |
|
13482 <div class="args"> |
|
13483 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13484 |
|
13485 <li class="arg"> |
|
13486 |
|
13487 <code>evt</code> |
|
13488 |
|
13489 </li> |
|
13490 |
|
13491 </ul><span class="paren">)</span> |
|
13492 </div> |
|
13493 |
|
13494 |
|
13495 |
|
13496 |
|
13497 |
|
13498 |
|
13499 |
|
13500 <span class="flag protected">protected</span> |
|
13501 |
|
13502 |
|
13503 |
|
13504 |
|
13505 |
|
13506 |
|
13507 |
|
13508 |
|
13509 |
|
13510 |
|
13511 <div class="meta"> |
|
13512 |
|
13513 |
|
13514 <p>Inherited from |
|
13515 <a href="../classes/Widget.html#method__onDocMouseDown">Widget</a>: |
|
13516 |
|
13517 |
|
13518 |
|
13519 <a href="../files/widget_js_Widget.js.html#l1068"><code>widget/js/Widget.js:1068</code></a> |
|
13520 |
|
13521 </p> |
|
13522 |
|
13523 |
|
13524 |
|
13525 |
|
13526 |
|
13527 </div> |
|
13528 |
|
13529 <div class="description"> |
|
13530 <p>"mousedown" event handler for the owner document of the |
|
13531 widget's bounding box.</p> |
|
13532 </div> |
|
13533 |
|
13534 |
|
13535 <div class="params"> |
|
13536 <h4>Parameters:</h4> |
|
13537 |
|
13538 <ul class="params-list"> |
|
13539 |
|
13540 <li class="param"> |
|
13541 |
|
13542 <code class="param-name">evt</code> |
|
13543 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
13544 |
|
13545 |
|
13546 |
|
13547 |
|
13548 <div class="param-description"> |
|
13549 <p>The event facade for the DOM focus event</p> |
|
13550 </div> |
|
13551 |
|
13552 |
|
13553 </li> |
|
13554 |
|
13555 </ul> |
|
13556 </div> |
|
13557 |
|
13558 |
|
13559 |
|
13560 |
|
13561 |
|
13562 </div> |
|
13563 |
|
13564 |
|
13565 <div id="method__onUITriggerSort" class="method item protected"> |
|
13566 <h3 class="name"><code>_onUITriggerSort</code></h3> |
|
13567 |
|
13568 |
|
13569 <div class="args"> |
|
13570 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13571 |
|
13572 <li class="arg"> |
|
13573 |
|
13574 <code>e</code> |
|
13575 |
|
13576 </li> |
|
13577 |
|
13578 </ul><span class="paren">)</span> |
|
13579 </div> |
|
13580 |
|
13581 |
|
13582 |
|
13583 |
|
13584 |
|
13585 |
|
13586 |
|
13587 <span class="flag protected">protected</span> |
|
13588 |
|
13589 |
|
13590 |
|
13591 |
|
13592 |
|
13593 |
|
13594 |
|
13595 |
|
13596 |
|
13597 |
|
13598 <div class="meta"> |
|
13599 |
|
13600 |
|
13601 |
|
13602 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
13603 |
|
13604 <p> |
|
13605 |
|
13606 Defined in |
|
13607 |
|
13608 |
|
13609 |
|
13610 |
|
13611 <a href="../files/datatable_js_sort.js.html#l545"><code>datatable/js/sort.js:545</code></a> |
|
13612 |
|
13613 </p> |
|
13614 |
|
13615 |
|
13616 |
|
13617 |
|
13618 |
|
13619 <p>Available since 3.5.0</p> |
|
13620 |
|
13621 </div> |
|
13622 |
|
13623 <div class="description"> |
|
13624 <p>Fires the <code>sort</code> event in response to user clicks on sortable column |
|
13625 headers.</p> |
|
13626 </div> |
|
13627 |
|
13628 |
|
13629 <div class="params"> |
|
13630 <h4>Parameters:</h4> |
|
13631 |
|
13632 <ul class="params-list"> |
|
13633 |
|
13634 <li class="param"> |
|
13635 |
|
13636 <code class="param-name">e</code> |
|
13637 <span class="type"><a href="../classes/DOMEventFacade.html" class="crosslink">DOMEventFacade</a></span> |
|
13638 |
|
13639 |
|
13640 |
|
13641 |
|
13642 <div class="param-description"> |
|
13643 <p>The <code>click</code> event</p> |
|
13644 </div> |
|
13645 |
|
13646 |
|
13647 </li> |
|
13648 |
|
13649 </ul> |
|
13650 </div> |
|
13651 |
|
13652 |
|
13653 |
|
13654 |
|
13655 |
|
13656 </div> |
|
13657 |
|
13658 |
|
13659 <div id="method__parseSortable" class="method item protected"> |
|
13660 <h3 class="name"><code>_parseSortable</code></h3> |
|
13661 |
|
13662 |
|
13663 <span class="paren">()</span> |
|
13664 |
|
13665 |
|
13666 |
|
13667 |
|
13668 |
|
13669 |
|
13670 |
|
13671 <span class="flag protected">protected</span> |
|
13672 |
|
13673 |
|
13674 |
|
13675 |
|
13676 |
|
13677 |
|
13678 |
|
13679 |
|
13680 |
|
13681 |
|
13682 <div class="meta"> |
|
13683 |
|
13684 |
|
13685 |
|
13686 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
13687 |
|
13688 <p> |
|
13689 |
|
13690 Defined in |
|
13691 |
|
13692 |
|
13693 |
|
13694 |
|
13695 <a href="../files/datatable_js_sort.js.html#l595"><code>datatable/js/sort.js:595</code></a> |
|
13696 |
|
13697 </p> |
|
13698 |
|
13699 |
|
13700 |
|
13701 |
|
13702 |
|
13703 <p>Available since 3.5.0</p> |
|
13704 |
|
13705 </div> |
|
13706 |
|
13707 <div class="description"> |
|
13708 <p>Normalizes the possible input values for the <code>sortable</code> attribute, storing |
|
13709 the results in the <code>_sortable</code> property.</p> |
|
13710 </div> |
|
13711 |
|
13712 |
|
13713 |
|
13714 |
|
13715 |
|
13716 |
|
13717 </div> |
|
13718 |
|
13719 |
|
13720 <div id="method__parseType" class="method item private inherited"> |
|
13721 <h3 class="name"><code>_parseType</code></h3> |
|
13722 |
|
13723 |
|
13724 <span class="paren">()</span> |
|
13725 |
|
13726 |
|
13727 |
|
13728 |
|
13729 |
|
13730 |
|
13731 |
|
13732 <span class="flag private">private</span> |
|
13733 |
|
13734 |
|
13735 |
|
13736 |
|
13737 |
|
13738 |
|
13739 |
|
13740 |
|
13741 |
|
13742 |
|
13743 <div class="meta"> |
|
13744 |
|
13745 |
|
13746 <p>Inherited from |
|
13747 <a href="../classes/EventTarget.html#method__parseType">EventTarget</a>: |
|
13748 |
|
13749 |
|
13750 |
|
13751 <a href="../files/event-custom_js_event-target.js.html#l52"><code>event-custom/js/event-target.js:52</code></a> |
|
13752 |
|
13753 </p> |
|
13754 |
|
13755 |
|
13756 |
|
13757 |
|
13758 |
|
13759 </div> |
|
13760 |
|
13761 <div class="description"> |
|
13762 <p>Returns an array with the detach key (if provided), |
|
13763 and the prefixed event name from _getType |
|
13764 Y.on('detachcategory| menu:click', fn)</p> |
|
13765 </div> |
|
13766 |
|
13767 |
|
13768 |
|
13769 |
|
13770 |
|
13771 |
|
13772 </div> |
|
13773 |
|
13774 |
|
13775 <div id="method__preInitEventCfg" class="method item private inherited"> |
|
13776 <h3 class="name"><code>_preInitEventCfg</code></h3> |
|
13777 |
|
13778 |
|
13779 <div class="args"> |
|
13780 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13781 |
|
13782 <li class="arg"> |
|
13783 |
|
13784 <code>config</code> |
|
13785 |
|
13786 </li> |
|
13787 |
|
13788 </ul><span class="paren">)</span> |
|
13789 </div> |
|
13790 |
|
13791 |
|
13792 |
|
13793 |
|
13794 |
|
13795 |
|
13796 |
|
13797 <span class="flag private">private</span> |
|
13798 |
|
13799 |
|
13800 |
|
13801 |
|
13802 |
|
13803 |
|
13804 |
|
13805 |
|
13806 |
|
13807 |
|
13808 <div class="meta"> |
|
13809 |
|
13810 |
|
13811 <p>Inherited from |
|
13812 <a href="../classes/BaseObservable.html#method__preInitEventCfg">BaseObservable</a>: |
|
13813 |
|
13814 |
|
13815 |
|
13816 <a href="../files/base_js_BaseObservable.js.html#l98"><code>base/js/BaseObservable.js:98</code></a> |
|
13817 |
|
13818 </p> |
|
13819 |
|
13820 |
|
13821 |
|
13822 |
|
13823 |
|
13824 </div> |
|
13825 |
|
13826 <div class="description"> |
|
13827 <p>Handles the special on, after and target properties which allow the user to |
|
13828 easily configure on and after listeners as well as bubble targets during |
|
13829 construction, prior to init.</p> |
|
13830 </div> |
|
13831 |
|
13832 |
|
13833 <div class="params"> |
|
13834 <h4>Parameters:</h4> |
|
13835 |
|
13836 <ul class="params-list"> |
|
13837 |
|
13838 <li class="param"> |
|
13839 |
|
13840 <code class="param-name">config</code> |
|
13841 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13842 |
|
13843 |
|
13844 |
|
13845 |
|
13846 <div class="param-description"> |
|
13847 <p>The user configuration object</p> |
|
13848 </div> |
|
13849 |
|
13850 |
|
13851 </li> |
|
13852 |
|
13853 </ul> |
|
13854 </div> |
|
13855 |
|
13856 |
|
13857 |
|
13858 |
|
13859 |
|
13860 </div> |
|
13861 |
|
13862 |
|
13863 <div id="method__protectAttrs" class="method item protected deprecated inherited"> |
|
13864 <h3 class="name"><code>_protectAttrs</code></h3> |
|
13865 |
|
13866 |
|
13867 <div class="args"> |
|
13868 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13869 |
|
13870 <li class="arg"> |
|
13871 |
|
13872 <code>attrs</code> |
|
13873 |
|
13874 </li> |
|
13875 |
|
13876 </ul><span class="paren">)</span> |
|
13877 </div> |
|
13878 |
|
13879 |
|
13880 |
|
13881 <span class="returns-inline"> |
|
13882 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13883 </span> |
|
13884 |
|
13885 |
|
13886 |
|
13887 <span class="flag deprecated" title="Use `AttributeCore.protectAttrs()` or |
|
13888 `Attribute.protectAttrs()` which are the same static utility method.">deprecated</span> |
|
13889 |
|
13890 |
|
13891 |
|
13892 <span class="flag protected">protected</span> |
|
13893 |
|
13894 |
|
13895 |
|
13896 |
|
13897 |
|
13898 |
|
13899 |
|
13900 |
|
13901 |
|
13902 |
|
13903 <div class="meta"> |
|
13904 |
|
13905 |
|
13906 <p>Inherited from |
|
13907 <a href="../classes/AttributeCore.html#method__protectAttrs">AttributeCore</a>: |
|
13908 |
|
13909 |
|
13910 |
|
13911 <a href="../files/attribute_js_AttributeCore.js.html#l883"><code>attribute/js/AttributeCore.js:883</code></a> |
|
13912 |
|
13913 </p> |
|
13914 |
|
13915 |
|
13916 |
|
13917 <p>Deprecated: Use `AttributeCore.protectAttrs()` or |
|
13918 `Attribute.protectAttrs()` which are the same static utility method.</p> |
|
13919 |
|
13920 |
|
13921 |
|
13922 </div> |
|
13923 |
|
13924 <div class="description"> |
|
13925 <p>Utility method to protect an attribute configuration |
|
13926 hash, by merging the entire object and the individual |
|
13927 attr config objects.</p> |
|
13928 </div> |
|
13929 |
|
13930 |
|
13931 <div class="params"> |
|
13932 <h4>Parameters:</h4> |
|
13933 |
|
13934 <ul class="params-list"> |
|
13935 |
|
13936 <li class="param"> |
|
13937 |
|
13938 <code class="param-name">attrs</code> |
|
13939 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13940 |
|
13941 |
|
13942 |
|
13943 |
|
13944 <div class="param-description"> |
|
13945 <p>A hash of attribute to configuration object pairs.</p> |
|
13946 </div> |
|
13947 |
|
13948 |
|
13949 </li> |
|
13950 |
|
13951 </ul> |
|
13952 </div> |
|
13953 |
|
13954 |
|
13955 |
|
13956 <div class="returns"> |
|
13957 <h4>Returns:</h4> |
|
13958 |
|
13959 <div class="returns-description"> |
|
13960 |
|
13961 |
|
13962 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
13963 |
|
13964 A protected version of the attrs argument. |
|
13965 |
|
13966 </div> |
|
13967 </div> |
|
13968 |
|
13969 |
|
13970 |
|
13971 </div> |
|
13972 |
|
13973 |
|
13974 <div id="method__publish" class="method item private inherited"> |
|
13975 <h3 class="name"><code>_publish</code></h3> |
|
13976 |
|
13977 |
|
13978 <div class="args"> |
|
13979 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13980 |
|
13981 <li class="arg"> |
|
13982 |
|
13983 <code>fullType</code> |
|
13984 |
|
13985 </li> |
|
13986 |
|
13987 <li class="arg"> |
|
13988 |
|
13989 <code>etOpts</code> |
|
13990 |
|
13991 </li> |
|
13992 |
|
13993 <li class="arg"> |
|
13994 |
|
13995 <code>ceOpts</code> |
|
13996 |
|
13997 </li> |
|
13998 |
|
13999 </ul><span class="paren">)</span> |
|
14000 </div> |
|
14001 |
|
14002 |
|
14003 |
|
14004 <span class="returns-inline"> |
|
14005 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
14006 </span> |
|
14007 |
|
14008 |
|
14009 |
|
14010 |
|
14011 |
|
14012 <span class="flag private">private</span> |
|
14013 |
|
14014 |
|
14015 |
|
14016 |
|
14017 |
|
14018 |
|
14019 |
|
14020 |
|
14021 |
|
14022 |
|
14023 <div class="meta"> |
|
14024 |
|
14025 |
|
14026 <p>Inherited from |
|
14027 <a href="../classes/EventTarget.html#method__publish">EventTarget</a>: |
|
14028 |
|
14029 |
|
14030 |
|
14031 <a href="../files/event-custom_js_event-target.js.html#l610"><code>event-custom/js/event-target.js:610</code></a> |
|
14032 |
|
14033 </p> |
|
14034 |
|
14035 |
|
14036 |
|
14037 |
|
14038 |
|
14039 </div> |
|
14040 |
|
14041 <div class="description"> |
|
14042 <p>The low level event publish implementation. It expects all the massaging to have been done |
|
14043 outside of this method. e.g. the <code>type</code> to <code>fullType</code> conversion. It's designed to be a fast |
|
14044 path publish, which can be used by critical code paths to improve performance.</p> |
|
14045 </div> |
|
14046 |
|
14047 |
|
14048 <div class="params"> |
|
14049 <h4>Parameters:</h4> |
|
14050 |
|
14051 <ul class="params-list"> |
|
14052 |
|
14053 <li class="param"> |
|
14054 |
|
14055 <code class="param-name">fullType</code> |
|
14056 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14057 |
|
14058 |
|
14059 |
|
14060 |
|
14061 <div class="param-description"> |
|
14062 <p>The prefixed type of the event to publish.</p> |
|
14063 </div> |
|
14064 |
|
14065 |
|
14066 </li> |
|
14067 |
|
14068 <li class="param"> |
|
14069 |
|
14070 <code class="param-name">etOpts</code> |
|
14071 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14072 |
|
14073 |
|
14074 |
|
14075 |
|
14076 <div class="param-description"> |
|
14077 <p>The EventTarget specific configuration to mix into the published event.</p> |
|
14078 </div> |
|
14079 |
|
14080 |
|
14081 </li> |
|
14082 |
|
14083 <li class="param"> |
|
14084 |
|
14085 <code class="param-name">ceOpts</code> |
|
14086 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14087 |
|
14088 |
|
14089 |
|
14090 |
|
14091 <div class="param-description"> |
|
14092 <p>The publish specific configuration to mix into the published event.</p> |
|
14093 </div> |
|
14094 |
|
14095 |
|
14096 </li> |
|
14097 |
|
14098 </ul> |
|
14099 </div> |
|
14100 |
|
14101 |
|
14102 |
|
14103 <div class="returns"> |
|
14104 <h4>Returns:</h4> |
|
14105 |
|
14106 <div class="returns-description"> |
|
14107 |
|
14108 |
|
14109 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>: |
|
14110 |
|
14111 The published event. If called without <code>etOpts</code> or <code>ceOpts</code>, this will |
|
14112 be the default <code>CustomEvent</code> instance, and can be configured independently. |
|
14113 |
|
14114 </div> |
|
14115 </div> |
|
14116 |
|
14117 |
|
14118 |
|
14119 </div> |
|
14120 |
|
14121 |
|
14122 <div id="method__relayCoreAttrChange" class="method item protected inherited"> |
|
14123 <h3 class="name"><code>_relayCoreAttrChange</code></h3> |
|
14124 |
|
14125 |
|
14126 <div class="args"> |
|
14127 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14128 |
|
14129 <li class="arg"> |
|
14130 |
|
14131 <code>e</code> |
|
14132 |
|
14133 </li> |
|
14134 |
|
14135 </ul><span class="paren">)</span> |
|
14136 </div> |
|
14137 |
|
14138 |
|
14139 |
|
14140 |
|
14141 |
|
14142 |
|
14143 |
|
14144 <span class="flag protected">protected</span> |
|
14145 |
|
14146 |
|
14147 |
|
14148 |
|
14149 |
|
14150 |
|
14151 |
|
14152 |
|
14153 |
|
14154 |
|
14155 <div class="meta"> |
|
14156 |
|
14157 |
|
14158 <p>Inherited from |
|
14159 <a href="../classes/DataTable.Base.html#method__relayCoreAttrChange">DataTable.Base</a>: |
|
14160 |
|
14161 |
|
14162 |
|
14163 <a href="../files/datatable_js_base.js.html#l411"><code>datatable/js/base.js:411</code></a> |
|
14164 |
|
14165 </p> |
|
14166 |
|
14167 |
|
14168 |
|
14169 |
|
14170 |
|
14171 <p>Available since 3.6.0</p> |
|
14172 |
|
14173 </div> |
|
14174 |
|
14175 <div class="description"> |
|
14176 <p>Relays attribute changes to the instance's <code>view</code>.</p> |
|
14177 </div> |
|
14178 |
|
14179 |
|
14180 <div class="params"> |
|
14181 <h4>Parameters:</h4> |
|
14182 |
|
14183 <ul class="params-list"> |
|
14184 |
|
14185 <li class="param"> |
|
14186 |
|
14187 <code class="param-name">e</code> |
|
14188 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
14189 |
|
14190 |
|
14191 |
|
14192 |
|
14193 <div class="param-description"> |
|
14194 <p>The change event</p> |
|
14195 </div> |
|
14196 |
|
14197 |
|
14198 </li> |
|
14199 |
|
14200 </ul> |
|
14201 </div> |
|
14202 |
|
14203 |
|
14204 |
|
14205 |
|
14206 |
|
14207 </div> |
|
14208 |
|
14209 |
|
14210 <div id="method__removeLoadingClassNames" class="method item protected inherited"> |
|
14211 <h3 class="name"><code>_removeLoadingClassNames</code></h3> |
|
14212 |
|
14213 |
|
14214 <span class="paren">()</span> |
|
14215 |
|
14216 |
|
14217 |
|
14218 |
|
14219 |
|
14220 |
|
14221 |
|
14222 <span class="flag protected">protected</span> |
|
14223 |
|
14224 |
|
14225 |
|
14226 |
|
14227 |
|
14228 |
|
14229 |
|
14230 |
|
14231 |
|
14232 |
|
14233 <div class="meta"> |
|
14234 |
|
14235 |
|
14236 <p>Inherited from |
|
14237 <a href="../classes/Widget.html#method__removeLoadingClassNames">Widget</a>: |
|
14238 |
|
14239 |
|
14240 |
|
14241 <a href="../files/widget_js_Widget.js.html#l862"><code>widget/js/Widget.js:862</code></a> |
|
14242 |
|
14243 </p> |
|
14244 |
|
14245 |
|
14246 |
|
14247 |
|
14248 |
|
14249 </div> |
|
14250 |
|
14251 <div class="description"> |
|
14252 <p>Removes class names representative of the widget's loading state from |
|
14253 the boundingBox.</p> |
|
14254 </div> |
|
14255 |
|
14256 |
|
14257 |
|
14258 |
|
14259 |
|
14260 |
|
14261 </div> |
|
14262 |
|
14263 |
|
14264 <div id="method__removeScrollbar" class="method item protected"> |
|
14265 <h3 class="name"><code>_removeScrollbar</code></h3> |
|
14266 |
|
14267 |
|
14268 <span class="paren">()</span> |
|
14269 |
|
14270 |
|
14271 |
|
14272 |
|
14273 |
|
14274 |
|
14275 |
|
14276 <span class="flag protected">protected</span> |
|
14277 |
|
14278 |
|
14279 |
|
14280 |
|
14281 |
|
14282 |
|
14283 |
|
14284 |
|
14285 |
|
14286 |
|
14287 <div class="meta"> |
|
14288 |
|
14289 |
|
14290 |
|
14291 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
14292 |
|
14293 <p> |
|
14294 |
|
14295 Defined in |
|
14296 |
|
14297 |
|
14298 |
|
14299 |
|
14300 <a href="../files/datatable_js_scroll.js.html#l713"><code>datatable/js/scroll.js:713</code></a> |
|
14301 |
|
14302 </p> |
|
14303 |
|
14304 |
|
14305 |
|
14306 |
|
14307 |
|
14308 <p>Available since 3.5.0</p> |
|
14309 |
|
14310 </div> |
|
14311 |
|
14312 <div class="description"> |
|
14313 <p>Removes the virtual scrollbar used by scrolling tables.</p> |
|
14314 </div> |
|
14315 |
|
14316 |
|
14317 |
|
14318 |
|
14319 |
|
14320 |
|
14321 </div> |
|
14322 |
|
14323 |
|
14324 <div id="method__removeScrollCaptionTable" class="method item protected"> |
|
14325 <h3 class="name"><code>_removeScrollCaptionTable</code></h3> |
|
14326 |
|
14327 |
|
14328 <span class="paren">()</span> |
|
14329 |
|
14330 |
|
14331 |
|
14332 |
|
14333 |
|
14334 |
|
14335 |
|
14336 <span class="flag protected">protected</span> |
|
14337 |
|
14338 |
|
14339 |
|
14340 |
|
14341 |
|
14342 |
|
14343 |
|
14344 |
|
14345 |
|
14346 |
|
14347 <div class="meta"> |
|
14348 |
|
14349 |
|
14350 |
|
14351 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
14352 |
|
14353 <p> |
|
14354 |
|
14355 Defined in |
|
14356 |
|
14357 |
|
14358 |
|
14359 |
|
14360 <a href="../files/datatable_js_scroll.js.html#l621"><code>datatable/js/scroll.js:621</code></a> |
|
14361 |
|
14362 </p> |
|
14363 |
|
14364 |
|
14365 |
|
14366 |
|
14367 |
|
14368 <p>Available since 3.5.0</p> |
|
14369 |
|
14370 </div> |
|
14371 |
|
14372 <div class="description"> |
|
14373 <p>Removes the table used to house the caption when the table is scrolling.</p> |
|
14374 </div> |
|
14375 |
|
14376 |
|
14377 |
|
14378 |
|
14379 |
|
14380 |
|
14381 </div> |
|
14382 |
|
14383 |
|
14384 <div id="method__removeXScrollNode" class="method item protected"> |
|
14385 <h3 class="name"><code>_removeXScrollNode</code></h3> |
|
14386 |
|
14387 |
|
14388 <span class="paren">()</span> |
|
14389 |
|
14390 |
|
14391 |
|
14392 |
|
14393 |
|
14394 |
|
14395 |
|
14396 <span class="flag protected">protected</span> |
|
14397 |
|
14398 |
|
14399 |
|
14400 |
|
14401 |
|
14402 |
|
14403 |
|
14404 |
|
14405 |
|
14406 |
|
14407 <div class="meta"> |
|
14408 |
|
14409 |
|
14410 |
|
14411 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
14412 |
|
14413 <p> |
|
14414 |
|
14415 Defined in |
|
14416 |
|
14417 |
|
14418 |
|
14419 |
|
14420 <a href="../files/datatable_js_scroll.js.html#l640"><code>datatable/js/scroll.js:640</code></a> |
|
14421 |
|
14422 </p> |
|
14423 |
|
14424 |
|
14425 |
|
14426 |
|
14427 |
|
14428 <p>Available since 3.5.0</p> |
|
14429 |
|
14430 </div> |
|
14431 |
|
14432 <div class="description"> |
|
14433 <p>Removes the <code><div></code> wrapper used to contain the data table when the table |
|
14434 is horizontally scrolling.</p> |
|
14435 </div> |
|
14436 |
|
14437 |
|
14438 |
|
14439 |
|
14440 |
|
14441 |
|
14442 </div> |
|
14443 |
|
14444 |
|
14445 <div id="method__removeYScrollContainer" class="method item protected"> |
|
14446 <h3 class="name"><code>_removeYScrollContainer</code></h3> |
|
14447 |
|
14448 |
|
14449 <span class="paren">()</span> |
|
14450 |
|
14451 |
|
14452 |
|
14453 |
|
14454 |
|
14455 |
|
14456 |
|
14457 <span class="flag protected">protected</span> |
|
14458 |
|
14459 |
|
14460 |
|
14461 |
|
14462 |
|
14463 |
|
14464 |
|
14465 |
|
14466 |
|
14467 |
|
14468 <div class="meta"> |
|
14469 |
|
14470 |
|
14471 |
|
14472 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
14473 |
|
14474 <p> |
|
14475 |
|
14476 Defined in |
|
14477 |
|
14478 |
|
14479 |
|
14480 |
|
14481 <a href="../files/datatable_js_scroll.js.html#l659"><code>datatable/js/scroll.js:659</code></a> |
|
14482 |
|
14483 </p> |
|
14484 |
|
14485 |
|
14486 |
|
14487 |
|
14488 |
|
14489 <p>Available since 3.5.0</p> |
|
14490 |
|
14491 </div> |
|
14492 |
|
14493 <div class="description"> |
|
14494 <p>Removes the <code><div></code> wrapper used to contain the data table and fixed header |
|
14495 when the table is vertically scrolling.</p> |
|
14496 </div> |
|
14497 |
|
14498 |
|
14499 |
|
14500 |
|
14501 |
|
14502 |
|
14503 </div> |
|
14504 |
|
14505 |
|
14506 <div id="method__removeYScrollHeader" class="method item protected"> |
|
14507 <h3 class="name"><code>_removeYScrollHeader</code></h3> |
|
14508 |
|
14509 |
|
14510 <span class="paren">()</span> |
|
14511 |
|
14512 |
|
14513 |
|
14514 |
|
14515 |
|
14516 |
|
14517 |
|
14518 <span class="flag protected">protected</span> |
|
14519 |
|
14520 |
|
14521 |
|
14522 |
|
14523 |
|
14524 |
|
14525 |
|
14526 |
|
14527 |
|
14528 |
|
14529 <div class="meta"> |
|
14530 |
|
14531 |
|
14532 |
|
14533 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
14534 |
|
14535 <p> |
|
14536 |
|
14537 Defined in |
|
14538 |
|
14539 |
|
14540 |
|
14541 |
|
14542 <a href="../files/datatable_js_scroll.js.html#l678"><code>datatable/js/scroll.js:678</code></a> |
|
14543 |
|
14544 </p> |
|
14545 |
|
14546 |
|
14547 |
|
14548 |
|
14549 |
|
14550 <p>Available since 3.5.0</p> |
|
14551 |
|
14552 </div> |
|
14553 |
|
14554 <div class="description"> |
|
14555 <p>Removes the <code><table></code> used to contain the fixed column headers when the |
|
14556 table is vertically scrolling.</p> |
|
14557 </div> |
|
14558 |
|
14559 |
|
14560 |
|
14561 |
|
14562 |
|
14563 |
|
14564 </div> |
|
14565 |
|
14566 |
|
14567 <div id="method__removeYScrollNode" class="method item protected"> |
|
14568 <h3 class="name"><code>_removeYScrollNode</code></h3> |
|
14569 |
|
14570 |
|
14571 <span class="paren">()</span> |
|
14572 |
|
14573 |
|
14574 |
|
14575 |
|
14576 |
|
14577 |
|
14578 |
|
14579 <span class="flag protected">protected</span> |
|
14580 |
|
14581 |
|
14582 |
|
14583 |
|
14584 |
|
14585 |
|
14586 |
|
14587 |
|
14588 |
|
14589 |
|
14590 <div class="meta"> |
|
14591 |
|
14592 |
|
14593 |
|
14594 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
14595 |
|
14596 <p> |
|
14597 |
|
14598 Defined in |
|
14599 |
|
14600 |
|
14601 |
|
14602 |
|
14603 <a href="../files/datatable_js_scroll.js.html#l694"><code>datatable/js/scroll.js:694</code></a> |
|
14604 |
|
14605 </p> |
|
14606 |
|
14607 |
|
14608 |
|
14609 |
|
14610 |
|
14611 <p>Available since 3.5.0</p> |
|
14612 |
|
14613 </div> |
|
14614 |
|
14615 <div class="description"> |
|
14616 <p>Removes the <code><div></code> wrapper used to contain the data table when the table |
|
14617 is vertically scrolling.</p> |
|
14618 </div> |
|
14619 |
|
14620 |
|
14621 |
|
14622 |
|
14623 |
|
14624 |
|
14625 </div> |
|
14626 |
|
14627 |
|
14628 <div id="method__renderBox" class="method item private inherited"> |
|
14629 <h3 class="name"><code>_renderBox</code></h3> |
|
14630 |
|
14631 |
|
14632 <div class="args"> |
|
14633 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14634 |
|
14635 <li class="arg"> |
|
14636 |
|
14637 <code>parentNode</code> |
|
14638 |
|
14639 </li> |
|
14640 |
|
14641 </ul><span class="paren">)</span> |
|
14642 </div> |
|
14643 |
|
14644 |
|
14645 |
|
14646 |
|
14647 |
|
14648 |
|
14649 |
|
14650 <span class="flag private">private</span> |
|
14651 |
|
14652 |
|
14653 |
|
14654 |
|
14655 |
|
14656 |
|
14657 |
|
14658 |
|
14659 |
|
14660 |
|
14661 <div class="meta"> |
|
14662 |
|
14663 |
|
14664 <p>Inherited from |
|
14665 <a href="../classes/Widget.html#method__renderBox">Widget</a>: |
|
14666 |
|
14667 |
|
14668 |
|
14669 <a href="../files/widget_js_Widget.js.html#l710"><code>widget/js/Widget.js:710</code></a> |
|
14670 |
|
14671 </p> |
|
14672 |
|
14673 |
|
14674 |
|
14675 |
|
14676 |
|
14677 </div> |
|
14678 |
|
14679 <div class="description"> |
|
14680 <p>Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not |
|
14681 already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used |
|
14682 as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and |
|
14683 the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered |
|
14684 to the current document's body.</p> |
|
14685 </div> |
|
14686 |
|
14687 |
|
14688 <div class="params"> |
|
14689 <h4>Parameters:</h4> |
|
14690 |
|
14691 <ul class="params-list"> |
|
14692 |
|
14693 <li class="param"> |
|
14694 |
|
14695 <code class="param-name">parentNode</code> |
|
14696 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
14697 |
|
14698 |
|
14699 |
|
14700 |
|
14701 <div class="param-description"> |
|
14702 <p>The parentNode to render the widget to. If not provided, and both the boundingBox and |
|
14703 the contentBox are not currently in the document, the widget will be rendered to the current document's body.</p> |
|
14704 </div> |
|
14705 |
|
14706 |
|
14707 </li> |
|
14708 |
|
14709 </ul> |
|
14710 </div> |
|
14711 |
|
14712 |
|
14713 |
|
14714 |
|
14715 |
|
14716 </div> |
|
14717 |
|
14718 |
|
14719 <div id="method__renderBoxClassNames" class="method item protected inherited"> |
|
14720 <h3 class="name"><code>_renderBoxClassNames</code></h3> |
|
14721 |
|
14722 |
|
14723 <span class="paren">()</span> |
|
14724 |
|
14725 |
|
14726 |
|
14727 |
|
14728 |
|
14729 |
|
14730 |
|
14731 <span class="flag protected">protected</span> |
|
14732 |
|
14733 |
|
14734 |
|
14735 |
|
14736 |
|
14737 |
|
14738 |
|
14739 |
|
14740 |
|
14741 |
|
14742 <div class="meta"> |
|
14743 |
|
14744 |
|
14745 <p>Inherited from |
|
14746 <a href="../classes/Widget.html#method__renderBoxClassNames">Widget</a>: |
|
14747 |
|
14748 |
|
14749 |
|
14750 <a href="../files/widget_js_Widget.js.html#l838"><code>widget/js/Widget.js:838</code></a> |
|
14751 |
|
14752 </p> |
|
14753 |
|
14754 |
|
14755 |
|
14756 |
|
14757 |
|
14758 </div> |
|
14759 |
|
14760 <div class="description"> |
|
14761 <p>Applies standard class names to the boundingBox and contentBox</p> |
|
14762 </div> |
|
14763 |
|
14764 |
|
14765 |
|
14766 |
|
14767 |
|
14768 |
|
14769 </div> |
|
14770 |
|
14771 |
|
14772 <div id="method__renderSortable" class="method item protected"> |
|
14773 <h3 class="name"><code>_renderSortable</code></h3> |
|
14774 |
|
14775 |
|
14776 <span class="paren">()</span> |
|
14777 |
|
14778 |
|
14779 |
|
14780 |
|
14781 |
|
14782 |
|
14783 |
|
14784 <span class="flag protected">protected</span> |
|
14785 |
|
14786 |
|
14787 |
|
14788 |
|
14789 |
|
14790 |
|
14791 |
|
14792 |
|
14793 |
|
14794 |
|
14795 <div class="meta"> |
|
14796 |
|
14797 |
|
14798 |
|
14799 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
14800 |
|
14801 <p> |
|
14802 |
|
14803 Defined in |
|
14804 |
|
14805 |
|
14806 |
|
14807 |
|
14808 <a href="../files/datatable_js_sort.js.html#l637"><code>datatable/js/sort.js:637</code></a> |
|
14809 |
|
14810 </p> |
|
14811 |
|
14812 |
|
14813 |
|
14814 |
|
14815 |
|
14816 <p>Available since 3.5.0</p> |
|
14817 |
|
14818 </div> |
|
14819 |
|
14820 <div class="description"> |
|
14821 <p>Initial application of the sortable UI.</p> |
|
14822 </div> |
|
14823 |
|
14824 |
|
14825 |
|
14826 |
|
14827 |
|
14828 |
|
14829 </div> |
|
14830 |
|
14831 |
|
14832 <div id="method__renderUI" class="method item protected inherited"> |
|
14833 <h3 class="name"><code>_renderUI</code></h3> |
|
14834 |
|
14835 |
|
14836 <span class="paren">()</span> |
|
14837 |
|
14838 |
|
14839 |
|
14840 |
|
14841 |
|
14842 |
|
14843 |
|
14844 <span class="flag protected">protected</span> |
|
14845 |
|
14846 |
|
14847 |
|
14848 |
|
14849 |
|
14850 |
|
14851 |
|
14852 |
|
14853 |
|
14854 |
|
14855 <div class="meta"> |
|
14856 |
|
14857 |
|
14858 <p>Inherited from |
|
14859 <a href="../classes/Widget.html#method__renderUI">Widget</a>: |
|
14860 |
|
14861 |
|
14862 |
|
14863 <a href="../files/widget_js_Widget.js.html#l827"><code>widget/js/Widget.js:827</code></a> |
|
14864 |
|
14865 </p> |
|
14866 |
|
14867 |
|
14868 |
|
14869 |
|
14870 |
|
14871 </div> |
|
14872 |
|
14873 <div class="description"> |
|
14874 <p>Initializes the UI state for the Widget's bounding/content boxes.</p> |
|
14875 </div> |
|
14876 |
|
14877 |
|
14878 |
|
14879 |
|
14880 |
|
14881 |
|
14882 </div> |
|
14883 |
|
14884 |
|
14885 <div id="method__set" class="method item protected inherited"> |
|
14886 <h3 class="name"><code>_set</code></h3> |
|
14887 |
|
14888 |
|
14889 <div class="args"> |
|
14890 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14891 |
|
14892 <li class="arg"> |
|
14893 |
|
14894 <code>name</code> |
|
14895 |
|
14896 </li> |
|
14897 |
|
14898 <li class="arg"> |
|
14899 |
|
14900 <code>val</code> |
|
14901 |
|
14902 </li> |
|
14903 |
|
14904 <li class="arg"> |
|
14905 |
|
14906 <code class="optional">[opts]</code> |
|
14907 |
|
14908 </li> |
|
14909 |
|
14910 </ul><span class="paren">)</span> |
|
14911 </div> |
|
14912 |
|
14913 |
|
14914 |
|
14915 <span class="returns-inline"> |
|
14916 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14917 </span> |
|
14918 |
|
14919 |
|
14920 |
|
14921 |
|
14922 |
|
14923 <span class="flag protected">protected</span> |
|
14924 |
|
14925 |
|
14926 |
|
14927 |
|
14928 |
|
14929 |
|
14930 |
|
14931 <span class="flag chainable">chainable</span> |
|
14932 |
|
14933 |
|
14934 |
|
14935 |
|
14936 <div class="meta"> |
|
14937 |
|
14938 <p>Inherited from |
|
14939 <a href="../classes/AttributeObservable.html#method__set"> |
|
14940 AttributeObservable |
|
14941 </a> |
|
14942 |
|
14943 but overwritten in |
|
14944 |
|
14945 |
|
14946 |
|
14947 <a href="../files/attribute_js_AttributeCore.js.html#l427"><code>attribute/js/AttributeCore.js:427</code></a> |
|
14948 |
|
14949 </p> |
|
14950 |
|
14951 |
|
14952 |
|
14953 |
|
14954 |
|
14955 </div> |
|
14956 |
|
14957 <div class="description"> |
|
14958 <p>Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.</p> |
|
14959 </div> |
|
14960 |
|
14961 |
|
14962 <div class="params"> |
|
14963 <h4>Parameters:</h4> |
|
14964 |
|
14965 <ul class="params-list"> |
|
14966 |
|
14967 <li class="param"> |
|
14968 |
|
14969 <code class="param-name">name</code> |
|
14970 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14971 |
|
14972 |
|
14973 |
|
14974 |
|
14975 <div class="param-description"> |
|
14976 <p>The name of the attribute.</p> |
|
14977 </div> |
|
14978 |
|
14979 |
|
14980 </li> |
|
14981 |
|
14982 <li class="param"> |
|
14983 |
|
14984 <code class="param-name">val</code> |
|
14985 <span class="type">Any</span> |
|
14986 |
|
14987 |
|
14988 |
|
14989 |
|
14990 <div class="param-description"> |
|
14991 <p>The value to set the attribute to.</p> |
|
14992 </div> |
|
14993 |
|
14994 |
|
14995 </li> |
|
14996 |
|
14997 <li class="param"> |
|
14998 |
|
14999 <code class="param-name optional">[opts]</code> |
|
15000 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15001 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
15002 |
|
15003 |
|
15004 |
|
15005 |
|
15006 <div class="param-description"> |
|
15007 <p>Optional data providing the circumstances for the change.</p> |
|
15008 </div> |
|
15009 |
|
15010 |
|
15011 </li> |
|
15012 |
|
15013 </ul> |
|
15014 </div> |
|
15015 |
|
15016 |
|
15017 |
|
15018 <div class="returns"> |
|
15019 <h4>Returns:</h4> |
|
15020 |
|
15021 <div class="returns-description"> |
|
15022 |
|
15023 |
|
15024 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
15025 |
|
15026 A reference to the host object. |
|
15027 |
|
15028 </div> |
|
15029 </div> |
|
15030 |
|
15031 |
|
15032 |
|
15033 </div> |
|
15034 |
|
15035 |
|
15036 <div id="method__setAttr" class="method item protected inherited"> |
|
15037 <h3 class="name"><code>_setAttr</code></h3> |
|
15038 |
|
15039 |
|
15040 <div class="args"> |
|
15041 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15042 |
|
15043 <li class="arg"> |
|
15044 |
|
15045 <code>name</code> |
|
15046 |
|
15047 </li> |
|
15048 |
|
15049 <li class="arg"> |
|
15050 |
|
15051 <code>value</code> |
|
15052 |
|
15053 </li> |
|
15054 |
|
15055 <li class="arg"> |
|
15056 |
|
15057 <code class="optional">[opts]</code> |
|
15058 |
|
15059 </li> |
|
15060 |
|
15061 <li class="arg"> |
|
15062 |
|
15063 <code>force</code> |
|
15064 |
|
15065 </li> |
|
15066 |
|
15067 </ul><span class="paren">)</span> |
|
15068 </div> |
|
15069 |
|
15070 |
|
15071 |
|
15072 <span class="returns-inline"> |
|
15073 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15074 </span> |
|
15075 |
|
15076 |
|
15077 |
|
15078 |
|
15079 |
|
15080 <span class="flag protected">protected</span> |
|
15081 |
|
15082 |
|
15083 |
|
15084 |
|
15085 |
|
15086 |
|
15087 |
|
15088 <span class="flag chainable">chainable</span> |
|
15089 |
|
15090 |
|
15091 |
|
15092 |
|
15093 <div class="meta"> |
|
15094 |
|
15095 |
|
15096 <p>Inherited from |
|
15097 <a href="../classes/AttributeCore.html#method__setAttr">AttributeCore</a>: |
|
15098 |
|
15099 |
|
15100 |
|
15101 <a href="../files/attribute_js_AttributeCore.js.html#l443"><code>attribute/js/AttributeCore.js:443</code></a> |
|
15102 |
|
15103 </p> |
|
15104 |
|
15105 |
|
15106 |
|
15107 |
|
15108 |
|
15109 </div> |
|
15110 |
|
15111 <div class="description"> |
|
15112 <p>Provides the common implementation for the public set and protected _set methods.</p> |
|
15113 |
|
15114 <p>See <a href="#method_set">set</a> for argument details.</p> |
|
15115 </div> |
|
15116 |
|
15117 |
|
15118 <div class="params"> |
|
15119 <h4>Parameters:</h4> |
|
15120 |
|
15121 <ul class="params-list"> |
|
15122 |
|
15123 <li class="param"> |
|
15124 |
|
15125 <code class="param-name">name</code> |
|
15126 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15127 |
|
15128 |
|
15129 |
|
15130 |
|
15131 <div class="param-description"> |
|
15132 <p>The name of the attribute.</p> |
|
15133 </div> |
|
15134 |
|
15135 |
|
15136 </li> |
|
15137 |
|
15138 <li class="param"> |
|
15139 |
|
15140 <code class="param-name">value</code> |
|
15141 <span class="type">Any</span> |
|
15142 |
|
15143 |
|
15144 |
|
15145 |
|
15146 <div class="param-description"> |
|
15147 <p>The value to set the attribute to.</p> |
|
15148 </div> |
|
15149 |
|
15150 |
|
15151 </li> |
|
15152 |
|
15153 <li class="param"> |
|
15154 |
|
15155 <code class="param-name optional">[opts]</code> |
|
15156 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15157 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
15158 |
|
15159 |
|
15160 |
|
15161 |
|
15162 <div class="param-description"> |
|
15163 <p>Optional data providing the circumstances for the change.</p> |
|
15164 </div> |
|
15165 |
|
15166 |
|
15167 </li> |
|
15168 |
|
15169 <li class="param"> |
|
15170 |
|
15171 <code class="param-name">force</code> |
|
15172 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
15173 |
|
15174 |
|
15175 |
|
15176 |
|
15177 <div class="param-description"> |
|
15178 <p>If true, allows the caller to set values for |
|
15179 readOnly or writeOnce attributes which have already been set.</p> |
|
15180 </div> |
|
15181 |
|
15182 |
|
15183 </li> |
|
15184 |
|
15185 </ul> |
|
15186 </div> |
|
15187 |
|
15188 |
|
15189 |
|
15190 <div class="returns"> |
|
15191 <h4>Returns:</h4> |
|
15192 |
|
15193 <div class="returns-description"> |
|
15194 |
|
15195 |
|
15196 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
15197 |
|
15198 A reference to the host object. |
|
15199 |
|
15200 </div> |
|
15201 </div> |
|
15202 |
|
15203 |
|
15204 |
|
15205 </div> |
|
15206 |
|
15207 |
|
15208 <div id="method__setAttrs" class="method item protected inherited"> |
|
15209 <h3 class="name"><code>_setAttrs</code></h3> |
|
15210 |
|
15211 |
|
15212 <div class="args"> |
|
15213 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15214 |
|
15215 <li class="arg"> |
|
15216 |
|
15217 <code>attrs</code> |
|
15218 |
|
15219 </li> |
|
15220 |
|
15221 <li class="arg"> |
|
15222 |
|
15223 <code class="optional">[opts]</code> |
|
15224 |
|
15225 </li> |
|
15226 |
|
15227 </ul><span class="paren">)</span> |
|
15228 </div> |
|
15229 |
|
15230 |
|
15231 |
|
15232 <span class="returns-inline"> |
|
15233 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15234 </span> |
|
15235 |
|
15236 |
|
15237 |
|
15238 |
|
15239 |
|
15240 <span class="flag protected">protected</span> |
|
15241 |
|
15242 |
|
15243 |
|
15244 |
|
15245 |
|
15246 |
|
15247 |
|
15248 <span class="flag chainable">chainable</span> |
|
15249 |
|
15250 |
|
15251 |
|
15252 |
|
15253 <div class="meta"> |
|
15254 |
|
15255 <p>Inherited from |
|
15256 <a href="../classes/AttributeObservable.html#method__setAttrs"> |
|
15257 AttributeObservable |
|
15258 </a> |
|
15259 |
|
15260 but overwritten in |
|
15261 |
|
15262 |
|
15263 |
|
15264 <a href="../files/attribute_js_AttributeCore.js.html#l742"><code>attribute/js/AttributeCore.js:742</code></a> |
|
15265 |
|
15266 </p> |
|
15267 |
|
15268 |
|
15269 |
|
15270 |
|
15271 |
|
15272 </div> |
|
15273 |
|
15274 <div class="description"> |
|
15275 <p>Implementation behind the public setAttrs method, to set multiple attribute values.</p> |
|
15276 </div> |
|
15277 |
|
15278 |
|
15279 <div class="params"> |
|
15280 <h4>Parameters:</h4> |
|
15281 |
|
15282 <ul class="params-list"> |
|
15283 |
|
15284 <li class="param"> |
|
15285 |
|
15286 <code class="param-name">attrs</code> |
|
15287 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15288 |
|
15289 |
|
15290 |
|
15291 |
|
15292 <div class="param-description"> |
|
15293 <p>An object with attributes name/value pairs.</p> |
|
15294 </div> |
|
15295 |
|
15296 |
|
15297 </li> |
|
15298 |
|
15299 <li class="param"> |
|
15300 |
|
15301 <code class="param-name optional">[opts]</code> |
|
15302 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15303 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
15304 |
|
15305 |
|
15306 |
|
15307 |
|
15308 <div class="param-description"> |
|
15309 <p>Optional data providing the circumstances for the change</p> |
|
15310 </div> |
|
15311 |
|
15312 |
|
15313 </li> |
|
15314 |
|
15315 </ul> |
|
15316 </div> |
|
15317 |
|
15318 |
|
15319 |
|
15320 <div class="returns"> |
|
15321 <h4>Returns:</h4> |
|
15322 |
|
15323 <div class="returns-description"> |
|
15324 |
|
15325 |
|
15326 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
15327 |
|
15328 A reference to the host object. |
|
15329 |
|
15330 </div> |
|
15331 </div> |
|
15332 |
|
15333 |
|
15334 |
|
15335 </div> |
|
15336 |
|
15337 |
|
15338 <div id="method__setAttrUI" class="method item private inherited"> |
|
15339 <h3 class="name"><code>_setAttrUI</code></h3> |
|
15340 |
|
15341 |
|
15342 <div class="args"> |
|
15343 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15344 |
|
15345 <li class="arg"> |
|
15346 |
|
15347 <code>e</code> |
|
15348 |
|
15349 </li> |
|
15350 |
|
15351 </ul><span class="paren">)</span> |
|
15352 </div> |
|
15353 |
|
15354 |
|
15355 |
|
15356 |
|
15357 |
|
15358 |
|
15359 |
|
15360 <span class="flag private">private</span> |
|
15361 |
|
15362 |
|
15363 |
|
15364 |
|
15365 |
|
15366 |
|
15367 |
|
15368 |
|
15369 |
|
15370 |
|
15371 <div class="meta"> |
|
15372 |
|
15373 |
|
15374 <p>Inherited from |
|
15375 <a href="../classes/Widget.html#method__setAttrUI">Widget</a>: |
|
15376 |
|
15377 |
|
15378 |
|
15379 <a href="../files/widget_js_Widget.js.html#l1201"><code>widget/js/Widget.js:1201</code></a> |
|
15380 |
|
15381 </p> |
|
15382 |
|
15383 |
|
15384 |
|
15385 |
|
15386 |
|
15387 </div> |
|
15388 |
|
15389 <div class="description"> |
|
15390 |
|
15391 </div> |
|
15392 |
|
15393 |
|
15394 <div class="params"> |
|
15395 <h4>Parameters:</h4> |
|
15396 |
|
15397 <ul class="params-list"> |
|
15398 |
|
15399 <li class="param"> |
|
15400 |
|
15401 <code class="param-name">e</code> |
|
15402 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
15403 |
|
15404 |
|
15405 |
|
15406 |
|
15407 <div class="param-description"> |
|
15408 |
|
15409 </div> |
|
15410 |
|
15411 |
|
15412 </li> |
|
15413 |
|
15414 </ul> |
|
15415 </div> |
|
15416 |
|
15417 |
|
15418 |
|
15419 |
|
15420 |
|
15421 </div> |
|
15422 |
|
15423 |
|
15424 <div id="method__setAttrVal" class="method item private inherited"> |
|
15425 <h3 class="name"><code>_setAttrVal</code></h3> |
|
15426 |
|
15427 |
|
15428 <div class="args"> |
|
15429 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15430 |
|
15431 <li class="arg"> |
|
15432 |
|
15433 <code>attrName</code> |
|
15434 |
|
15435 </li> |
|
15436 |
|
15437 <li class="arg"> |
|
15438 |
|
15439 <code>subAttrName</code> |
|
15440 |
|
15441 </li> |
|
15442 |
|
15443 <li class="arg"> |
|
15444 |
|
15445 <code>prevVal</code> |
|
15446 |
|
15447 </li> |
|
15448 |
|
15449 <li class="arg"> |
|
15450 |
|
15451 <code>newVal</code> |
|
15452 |
|
15453 </li> |
|
15454 |
|
15455 <li class="arg"> |
|
15456 |
|
15457 <code class="optional">[opts]</code> |
|
15458 |
|
15459 </li> |
|
15460 |
|
15461 <li class="arg"> |
|
15462 |
|
15463 <code class="optional">[attrCfg]</code> |
|
15464 |
|
15465 </li> |
|
15466 |
|
15467 </ul><span class="paren">)</span> |
|
15468 </div> |
|
15469 |
|
15470 |
|
15471 |
|
15472 <span class="returns-inline"> |
|
15473 <span class="type">Booolean</span> |
|
15474 </span> |
|
15475 |
|
15476 |
|
15477 |
|
15478 |
|
15479 |
|
15480 <span class="flag private">private</span> |
|
15481 |
|
15482 |
|
15483 |
|
15484 |
|
15485 |
|
15486 |
|
15487 |
|
15488 |
|
15489 |
|
15490 |
|
15491 <div class="meta"> |
|
15492 |
|
15493 |
|
15494 <p>Inherited from |
|
15495 <a href="../classes/AttributeCore.html#method__setAttrVal">AttributeCore</a>: |
|
15496 |
|
15497 |
|
15498 |
|
15499 <a href="../files/attribute_js_AttributeCore.js.html#l640"><code>attribute/js/AttributeCore.js:640</code></a> |
|
15500 |
|
15501 </p> |
|
15502 |
|
15503 |
|
15504 |
|
15505 |
|
15506 |
|
15507 </div> |
|
15508 |
|
15509 <div class="description"> |
|
15510 <p>Updates the stored value of the attribute in the privately held State object, |
|
15511 if validation and setter passes.</p> |
|
15512 </div> |
|
15513 |
|
15514 |
|
15515 <div class="params"> |
|
15516 <h4>Parameters:</h4> |
|
15517 |
|
15518 <ul class="params-list"> |
|
15519 |
|
15520 <li class="param"> |
|
15521 |
|
15522 <code class="param-name">attrName</code> |
|
15523 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15524 |
|
15525 |
|
15526 |
|
15527 |
|
15528 <div class="param-description"> |
|
15529 <p>The attribute name.</p> |
|
15530 </div> |
|
15531 |
|
15532 |
|
15533 </li> |
|
15534 |
|
15535 <li class="param"> |
|
15536 |
|
15537 <code class="param-name">subAttrName</code> |
|
15538 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15539 |
|
15540 |
|
15541 |
|
15542 |
|
15543 <div class="param-description"> |
|
15544 <p>The sub-attribute name, if setting a sub-attribute property ("x.y.z").</p> |
|
15545 </div> |
|
15546 |
|
15547 |
|
15548 </li> |
|
15549 |
|
15550 <li class="param"> |
|
15551 |
|
15552 <code class="param-name">prevVal</code> |
|
15553 <span class="type">Any</span> |
|
15554 |
|
15555 |
|
15556 |
|
15557 |
|
15558 <div class="param-description"> |
|
15559 <p>The currently stored value of the attribute.</p> |
|
15560 </div> |
|
15561 |
|
15562 |
|
15563 </li> |
|
15564 |
|
15565 <li class="param"> |
|
15566 |
|
15567 <code class="param-name">newVal</code> |
|
15568 <span class="type">Any</span> |
|
15569 |
|
15570 |
|
15571 |
|
15572 |
|
15573 <div class="param-description"> |
|
15574 <p>The value which is going to be stored.</p> |
|
15575 </div> |
|
15576 |
|
15577 |
|
15578 </li> |
|
15579 |
|
15580 <li class="param"> |
|
15581 |
|
15582 <code class="param-name optional">[opts]</code> |
|
15583 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15584 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
15585 |
|
15586 |
|
15587 |
|
15588 |
|
15589 <div class="param-description"> |
|
15590 <p>Optional data providing the circumstances for the change.</p> |
|
15591 </div> |
|
15592 |
|
15593 |
|
15594 </li> |
|
15595 |
|
15596 <li class="param"> |
|
15597 |
|
15598 <code class="param-name optional">[attrCfg]</code> |
|
15599 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15600 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
15601 |
|
15602 |
|
15603 |
|
15604 |
|
15605 <div class="param-description"> |
|
15606 <p>Optional config hash for the attribute. This is added for performance along the critical path, |
|
15607 where the calling method has already obtained the config from state.</p> |
|
15608 </div> |
|
15609 |
|
15610 |
|
15611 </li> |
|
15612 |
|
15613 </ul> |
|
15614 </div> |
|
15615 |
|
15616 |
|
15617 |
|
15618 <div class="returns"> |
|
15619 <h4>Returns:</h4> |
|
15620 |
|
15621 <div class="returns-description"> |
|
15622 |
|
15623 |
|
15624 <span class="type">Booolean</span>: |
|
15625 |
|
15626 true if the new attribute value was stored, false if not. |
|
15627 |
|
15628 </div> |
|
15629 </div> |
|
15630 |
|
15631 |
|
15632 |
|
15633 </div> |
|
15634 |
|
15635 |
|
15636 <div id="method__setBB" class="method item private inherited"> |
|
15637 <h3 class="name"><code>_setBB</code></h3> |
|
15638 |
|
15639 |
|
15640 <div class="args"> |
|
15641 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15642 |
|
15643 <li class="arg"> |
|
15644 |
|
15645 <code>Node/String</code> |
|
15646 |
|
15647 </li> |
|
15648 |
|
15649 </ul><span class="paren">)</span> |
|
15650 </div> |
|
15651 |
|
15652 |
|
15653 |
|
15654 <span class="returns-inline"> |
|
15655 <span class="type"></span> |
|
15656 </span> |
|
15657 |
|
15658 |
|
15659 |
|
15660 |
|
15661 |
|
15662 <span class="flag private">private</span> |
|
15663 |
|
15664 |
|
15665 |
|
15666 |
|
15667 |
|
15668 |
|
15669 |
|
15670 |
|
15671 |
|
15672 |
|
15673 <div class="meta"> |
|
15674 |
|
15675 |
|
15676 <p>Inherited from |
|
15677 <a href="../classes/Widget.html#method__setBB">Widget</a>: |
|
15678 |
|
15679 |
|
15680 |
|
15681 <a href="../files/widget_js_Widget.js.html#l756"><code>widget/js/Widget.js:756</code></a> |
|
15682 |
|
15683 </p> |
|
15684 |
|
15685 |
|
15686 |
|
15687 |
|
15688 |
|
15689 </div> |
|
15690 |
|
15691 <div class="description"> |
|
15692 <p>Setter for the boundingBox attribute</p> |
|
15693 </div> |
|
15694 |
|
15695 |
|
15696 <div class="params"> |
|
15697 <h4>Parameters:</h4> |
|
15698 |
|
15699 <ul class="params-list"> |
|
15700 |
|
15701 <li class="param"> |
|
15702 |
|
15703 <code class="param-name">Node/String</code> |
|
15704 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15705 |
|
15706 |
|
15707 |
|
15708 |
|
15709 <div class="param-description"> |
|
15710 |
|
15711 </div> |
|
15712 |
|
15713 |
|
15714 </li> |
|
15715 |
|
15716 </ul> |
|
15717 </div> |
|
15718 |
|
15719 |
|
15720 |
|
15721 <div class="returns"> |
|
15722 <h4>Returns:</h4> |
|
15723 |
|
15724 <div class="returns-description"> |
|
15725 |
|
15726 |
|
15727 Node |
|
15728 |
|
15729 </div> |
|
15730 </div> |
|
15731 |
|
15732 |
|
15733 |
|
15734 </div> |
|
15735 |
|
15736 |
|
15737 <div id="method__setBox" class="method item private inherited"> |
|
15738 <h3 class="name"><code>_setBox</code></h3> |
|
15739 |
|
15740 |
|
15741 <div class="args"> |
|
15742 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15743 |
|
15744 <li class="arg"> |
|
15745 |
|
15746 <code>id</code> |
|
15747 |
|
15748 </li> |
|
15749 |
|
15750 <li class="arg"> |
|
15751 |
|
15752 <code>node</code> |
|
15753 |
|
15754 </li> |
|
15755 |
|
15756 <li class="arg"> |
|
15757 |
|
15758 <code>template</code> |
|
15759 |
|
15760 </li> |
|
15761 |
|
15762 <li class="arg"> |
|
15763 |
|
15764 <code>true</code> |
|
15765 |
|
15766 </li> |
|
15767 |
|
15768 </ul><span class="paren">)</span> |
|
15769 </div> |
|
15770 |
|
15771 |
|
15772 |
|
15773 <span class="returns-inline"> |
|
15774 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
15775 </span> |
|
15776 |
|
15777 |
|
15778 |
|
15779 |
|
15780 |
|
15781 <span class="flag private">private</span> |
|
15782 |
|
15783 |
|
15784 |
|
15785 |
|
15786 |
|
15787 |
|
15788 |
|
15789 |
|
15790 |
|
15791 |
|
15792 <div class="meta"> |
|
15793 |
|
15794 |
|
15795 <p>Inherited from |
|
15796 <a href="../classes/Widget.html#method__setBox">Widget</a>: |
|
15797 |
|
15798 |
|
15799 |
|
15800 <a href="../files/widget_js_Widget.js.html#l793"><code>widget/js/Widget.js:793</code></a> |
|
15801 |
|
15802 </p> |
|
15803 |
|
15804 |
|
15805 |
|
15806 |
|
15807 |
|
15808 </div> |
|
15809 |
|
15810 <div class="description"> |
|
15811 <p>Helper method to set the bounding/content box, or create it from |
|
15812 the provided template if not found.</p> |
|
15813 </div> |
|
15814 |
|
15815 |
|
15816 <div class="params"> |
|
15817 <h4>Parameters:</h4> |
|
15818 |
|
15819 <ul class="params-list"> |
|
15820 |
|
15821 <li class="param"> |
|
15822 |
|
15823 <code class="param-name">id</code> |
|
15824 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15825 |
|
15826 |
|
15827 |
|
15828 |
|
15829 <div class="param-description"> |
|
15830 <p>The node's id attribute</p> |
|
15831 </div> |
|
15832 |
|
15833 |
|
15834 </li> |
|
15835 |
|
15836 <li class="param"> |
|
15837 |
|
15838 <code class="param-name">node</code> |
|
15839 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15840 |
|
15841 |
|
15842 |
|
15843 |
|
15844 <div class="param-description"> |
|
15845 <p>The node reference</p> |
|
15846 </div> |
|
15847 |
|
15848 |
|
15849 </li> |
|
15850 |
|
15851 <li class="param"> |
|
15852 |
|
15853 <code class="param-name">template</code> |
|
15854 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15855 |
|
15856 |
|
15857 |
|
15858 |
|
15859 <div class="param-description"> |
|
15860 <p>HTML string template for the node</p> |
|
15861 </div> |
|
15862 |
|
15863 |
|
15864 </li> |
|
15865 |
|
15866 <li class="param"> |
|
15867 |
|
15868 <code class="param-name">true</code> |
|
15869 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
15870 |
|
15871 |
|
15872 |
|
15873 |
|
15874 <div class="param-description"> |
|
15875 <p>if this is the boundingBox, false if it's the contentBox</p> |
|
15876 </div> |
|
15877 |
|
15878 |
|
15879 </li> |
|
15880 |
|
15881 </ul> |
|
15882 </div> |
|
15883 |
|
15884 |
|
15885 |
|
15886 <div class="returns"> |
|
15887 <h4>Returns:</h4> |
|
15888 |
|
15889 <div class="returns-description"> |
|
15890 |
|
15891 |
|
15892 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
15893 |
|
15894 The node |
|
15895 |
|
15896 </div> |
|
15897 </div> |
|
15898 |
|
15899 |
|
15900 |
|
15901 </div> |
|
15902 |
|
15903 |
|
15904 <div id="method__setCB" class="method item private inherited"> |
|
15905 <h3 class="name"><code>_setCB</code></h3> |
|
15906 |
|
15907 |
|
15908 <div class="args"> |
|
15909 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15910 |
|
15911 <li class="arg"> |
|
15912 |
|
15913 <code>node</code> |
|
15914 |
|
15915 </li> |
|
15916 |
|
15917 </ul><span class="paren">)</span> |
|
15918 </div> |
|
15919 |
|
15920 |
|
15921 |
|
15922 <span class="returns-inline"> |
|
15923 <span class="type"></span> |
|
15924 </span> |
|
15925 |
|
15926 |
|
15927 |
|
15928 |
|
15929 |
|
15930 <span class="flag private">private</span> |
|
15931 |
|
15932 |
|
15933 |
|
15934 |
|
15935 |
|
15936 |
|
15937 |
|
15938 |
|
15939 |
|
15940 |
|
15941 <div class="meta"> |
|
15942 |
|
15943 |
|
15944 <p>Inherited from |
|
15945 <a href="../classes/Widget.html#method__setCB">Widget</a>: |
|
15946 |
|
15947 |
|
15948 |
|
15949 <a href="../files/widget_js_Widget.js.html#l768"><code>widget/js/Widget.js:768</code></a> |
|
15950 |
|
15951 </p> |
|
15952 |
|
15953 |
|
15954 |
|
15955 |
|
15956 |
|
15957 </div> |
|
15958 |
|
15959 <div class="description"> |
|
15960 <p>Setter for the contentBox attribute</p> |
|
15961 </div> |
|
15962 |
|
15963 |
|
15964 <div class="params"> |
|
15965 <h4>Parameters:</h4> |
|
15966 |
|
15967 <ul class="params-list"> |
|
15968 |
|
15969 <li class="param"> |
|
15970 |
|
15971 <code class="param-name">node</code> |
|
15972 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15973 |
|
15974 |
|
15975 |
|
15976 |
|
15977 <div class="param-description"> |
|
15978 |
|
15979 </div> |
|
15980 |
|
15981 |
|
15982 </li> |
|
15983 |
|
15984 </ul> |
|
15985 </div> |
|
15986 |
|
15987 |
|
15988 |
|
15989 <div class="returns"> |
|
15990 <h4>Returns:</h4> |
|
15991 |
|
15992 <div class="returns-description"> |
|
15993 |
|
15994 |
|
15995 Node |
|
15996 |
|
15997 </div> |
|
15998 </div> |
|
15999 |
|
16000 |
|
16001 |
|
16002 </div> |
|
16003 |
|
16004 |
|
16005 <div id="method__setColumnMap" class="method item protected"> |
|
16006 <h3 class="name"><code>_setColumnMap</code></h3> |
|
16007 |
|
16008 |
|
16009 <div class="args"> |
|
16010 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16011 |
|
16012 <li class="arg"> |
|
16013 |
|
16014 <code>columns</code> |
|
16015 |
|
16016 </li> |
|
16017 |
|
16018 </ul><span class="paren">)</span> |
|
16019 </div> |
|
16020 |
|
16021 |
|
16022 |
|
16023 |
|
16024 |
|
16025 |
|
16026 |
|
16027 <span class="flag protected">protected</span> |
|
16028 |
|
16029 |
|
16030 |
|
16031 |
|
16032 |
|
16033 |
|
16034 |
|
16035 |
|
16036 |
|
16037 |
|
16038 <div class="meta"> |
|
16039 |
|
16040 |
|
16041 |
|
16042 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
16043 |
|
16044 <p> |
|
16045 |
|
16046 Defined in |
|
16047 |
|
16048 |
|
16049 |
|
16050 |
|
16051 <a href="../files/datatable_js_core.js.html#l640"><code>datatable/js/core.js:640</code></a> |
|
16052 |
|
16053 </p> |
|
16054 |
|
16055 |
|
16056 |
|
16057 |
|
16058 |
|
16059 <p>Available since 3.6.0</p> |
|
16060 |
|
16061 </div> |
|
16062 |
|
16063 <div class="description"> |
|
16064 <p>Iterates the array of column configurations to capture all columns with a |
|
16065 <code>key</code> property. An map is built with column keys as the property name and |
|
16066 the corresponding column object as the associated value. This map is then |
|
16067 assigned to the instance's <code>_columnMap</code> property.</p> |
|
16068 </div> |
|
16069 |
|
16070 |
|
16071 <div class="params"> |
|
16072 <h4>Parameters:</h4> |
|
16073 |
|
16074 <ul class="params-list"> |
|
16075 |
|
16076 <li class="param"> |
|
16077 |
|
16078 <code class="param-name">columns</code> |
|
16079 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span> |
|
16080 |
|
16081 |
|
16082 |
|
16083 |
|
16084 <div class="param-description"> |
|
16085 <p>The array of column config objects</p> |
|
16086 </div> |
|
16087 |
|
16088 |
|
16089 </li> |
|
16090 |
|
16091 </ul> |
|
16092 </div> |
|
16093 |
|
16094 |
|
16095 |
|
16096 |
|
16097 |
|
16098 </div> |
|
16099 |
|
16100 |
|
16101 <div id="method__setColumns" class="method item protected"> |
|
16102 <h3 class="name"><code>_setColumns</code></h3> |
|
16103 |
|
16104 |
|
16105 <div class="args"> |
|
16106 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16107 |
|
16108 <li class="arg"> |
|
16109 |
|
16110 <code>val</code> |
|
16111 |
|
16112 </li> |
|
16113 |
|
16114 </ul><span class="paren">)</span> |
|
16115 </div> |
|
16116 |
|
16117 |
|
16118 |
|
16119 <span class="returns-inline"> |
|
16120 <span class="type">Null | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
16121 </span> |
|
16122 |
|
16123 |
|
16124 |
|
16125 |
|
16126 |
|
16127 <span class="flag protected">protected</span> |
|
16128 |
|
16129 |
|
16130 |
|
16131 |
|
16132 |
|
16133 |
|
16134 |
|
16135 |
|
16136 |
|
16137 |
|
16138 <div class="meta"> |
|
16139 |
|
16140 |
|
16141 |
|
16142 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
16143 |
|
16144 <p> |
|
16145 |
|
16146 Defined in |
|
16147 |
|
16148 |
|
16149 |
|
16150 |
|
16151 <a href="../files/datatable_js_core.js.html#l684"><code>datatable/js/core.js:684</code></a> |
|
16152 |
|
16153 </p> |
|
16154 |
|
16155 |
|
16156 |
|
16157 |
|
16158 |
|
16159 </div> |
|
16160 |
|
16161 <div class="description"> |
|
16162 <p>Translates string columns into objects with that string as the value of its |
|
16163 <code>key</code> property.</p> |
|
16164 |
|
16165 <p>All columns are assigned a <code>_yuid</code> stamp and <code>_id</code> property corresponding |
|
16166 to the column's configured <code>name</code> or <code>key</code> property with any spaces |
|
16167 replaced with dashes. If the same <code>name</code> or <code>key</code> appears in multiple |
|
16168 columns, subsequent appearances will have their <code>_id</code> appended with an |
|
16169 incrementing number (e.g. if column "foo" is included in the <code>columns</code> |
|
16170 attribute twice, the first will get <code>_id</code> of "foo", and the second an <code>_id</code> |
|
16171 of "foo1"). Columns that are children of other columns will have the |
|
16172 <code>_parent</code> property added, assigned the column object to which they belong.</p> |
|
16173 </div> |
|
16174 |
|
16175 |
|
16176 <div class="params"> |
|
16177 <h4>Parameters:</h4> |
|
16178 |
|
16179 <ul class="params-list"> |
|
16180 |
|
16181 <li class="param"> |
|
16182 |
|
16183 <code class="param-name">val</code> |
|
16184 <span class="type">Null | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span> |
|
16185 |
|
16186 |
|
16187 |
|
16188 |
|
16189 <div class="param-description"> |
|
16190 <p>Array of config objects or strings</p> |
|
16191 </div> |
|
16192 |
|
16193 |
|
16194 </li> |
|
16195 |
|
16196 </ul> |
|
16197 </div> |
|
16198 |
|
16199 |
|
16200 |
|
16201 <div class="returns"> |
|
16202 <h4>Returns:</h4> |
|
16203 |
|
16204 <div class="returns-description"> |
|
16205 |
|
16206 |
|
16207 <span class="type">Null | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>: |
|
16208 |
|
16209 |
|
16210 </div> |
|
16211 </div> |
|
16212 |
|
16213 |
|
16214 |
|
16215 </div> |
|
16216 |
|
16217 |
|
16218 <div id="method__setColumnset" class="method item protected deprecated"> |
|
16219 <h3 class="name"><code>_setColumnset</code></h3> |
|
16220 |
|
16221 |
|
16222 <div class="args"> |
|
16223 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16224 |
|
16225 <li class="arg"> |
|
16226 |
|
16227 <code>val</code> |
|
16228 |
|
16229 </li> |
|
16230 |
|
16231 </ul><span class="paren">)</span> |
|
16232 </div> |
|
16233 |
|
16234 |
|
16235 |
|
16236 |
|
16237 |
|
16238 <span class="flag deprecated" title="This will be removed with the deprecated `columnset` attribute |
|
16239 in a later version.">deprecated</span> |
|
16240 |
|
16241 |
|
16242 |
|
16243 <span class="flag protected">protected</span> |
|
16244 |
|
16245 |
|
16246 |
|
16247 |
|
16248 |
|
16249 |
|
16250 |
|
16251 |
|
16252 |
|
16253 |
|
16254 <div class="meta"> |
|
16255 |
|
16256 |
|
16257 |
|
16258 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
16259 |
|
16260 <p> |
|
16261 |
|
16262 Defined in |
|
16263 |
|
16264 |
|
16265 |
|
16266 |
|
16267 <a href="../files/datatable_js_core.js.html#l792"><code>datatable/js/core.js:792</code></a> |
|
16268 |
|
16269 </p> |
|
16270 |
|
16271 |
|
16272 |
|
16273 <p>Deprecated: This will be removed with the deprecated `columnset` attribute |
|
16274 in a later version.</p> |
|
16275 |
|
16276 |
|
16277 |
|
16278 <p>Available since 3.5.0</p> |
|
16279 |
|
16280 </div> |
|
16281 |
|
16282 <div class="description"> |
|
16283 <p>Relays attribute assignments of the deprecated <code>columnset</code> attribute to the |
|
16284 <code>columns</code> attribute. If a Columnset is object is passed, its basic object |
|
16285 structure is mined.</p> |
|
16286 </div> |
|
16287 |
|
16288 |
|
16289 <div class="params"> |
|
16290 <h4>Parameters:</h4> |
|
16291 |
|
16292 <ul class="params-list"> |
|
16293 |
|
16294 <li class="param"> |
|
16295 |
|
16296 <code class="param-name">val</code> |
|
16297 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | Columnset</span> |
|
16298 |
|
16299 |
|
16300 |
|
16301 |
|
16302 <div class="param-description"> |
|
16303 <p>The columnset value to relay</p> |
|
16304 </div> |
|
16305 |
|
16306 |
|
16307 </li> |
|
16308 |
|
16309 </ul> |
|
16310 </div> |
|
16311 |
|
16312 |
|
16313 |
|
16314 |
|
16315 |
|
16316 </div> |
|
16317 |
|
16318 |
|
16319 <div id="method__setColumnWidth" class="method item protected"> |
|
16320 <h3 class="name"><code>_setColumnWidth</code></h3> |
|
16321 |
|
16322 |
|
16323 <div class="args"> |
|
16324 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16325 |
|
16326 <li class="arg"> |
|
16327 |
|
16328 <code>colIndex</code> |
|
16329 |
|
16330 </li> |
|
16331 |
|
16332 <li class="arg"> |
|
16333 |
|
16334 <code>width</code> |
|
16335 |
|
16336 </li> |
|
16337 |
|
16338 </ul><span class="paren">)</span> |
|
16339 </div> |
|
16340 |
|
16341 |
|
16342 |
|
16343 |
|
16344 |
|
16345 |
|
16346 |
|
16347 <span class="flag protected">protected</span> |
|
16348 |
|
16349 |
|
16350 |
|
16351 |
|
16352 |
|
16353 |
|
16354 |
|
16355 |
|
16356 |
|
16357 |
|
16358 <div class="meta"> |
|
16359 |
|
16360 |
|
16361 |
|
16362 <p>Provided by the <a href="../modules/datatable-column-widths.html">datatable-column-widths</a> module.</p> |
|
16363 |
|
16364 <p> |
|
16365 |
|
16366 Defined in |
|
16367 |
|
16368 |
|
16369 |
|
16370 |
|
16371 <a href="../files/datatable_js_colwidths.js.html#l198"><code>datatable/js/colwidths.js:198</code></a> |
|
16372 |
|
16373 </p> |
|
16374 |
|
16375 |
|
16376 |
|
16377 |
|
16378 |
|
16379 <p>Available since 3.5.0</p> |
|
16380 |
|
16381 </div> |
|
16382 |
|
16383 <div class="description"> |
|
16384 <p>Sets a columns's <code><col></code> element width style. This is needed to get around |
|
16385 browser rendering differences.</p> |
|
16386 |
|
16387 <p>The colIndex corresponds to the item index of the <code><col></code> in the table's |
|
16388 <code><colgroup></code>.</p> |
|
16389 |
|
16390 <p>To unset the width, pass a falsy value for the <code>width</code>.</p> |
|
16391 </div> |
|
16392 |
|
16393 |
|
16394 <div class="params"> |
|
16395 <h4>Parameters:</h4> |
|
16396 |
|
16397 <ul class="params-list"> |
|
16398 |
|
16399 <li class="param"> |
|
16400 |
|
16401 <code class="param-name">colIndex</code> |
|
16402 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
16403 |
|
16404 |
|
16405 |
|
16406 |
|
16407 <div class="param-description"> |
|
16408 <p>The display column index</p> |
|
16409 </div> |
|
16410 |
|
16411 |
|
16412 </li> |
|
16413 |
|
16414 <li class="param"> |
|
16415 |
|
16416 <code class="param-name">width</code> |
|
16417 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16418 |
|
16419 |
|
16420 |
|
16421 |
|
16422 <div class="param-description"> |
|
16423 <p>The desired width</p> |
|
16424 </div> |
|
16425 |
|
16426 |
|
16427 </li> |
|
16428 |
|
16429 </ul> |
|
16430 </div> |
|
16431 |
|
16432 |
|
16433 |
|
16434 |
|
16435 |
|
16436 </div> |
|
16437 |
|
16438 |
|
16439 <div id="method__setData" class="method item protected"> |
|
16440 <h3 class="name"><code>_setData</code></h3> |
|
16441 |
|
16442 |
|
16443 <span class="paren">()</span> |
|
16444 |
|
16445 |
|
16446 |
|
16447 |
|
16448 |
|
16449 |
|
16450 |
|
16451 <span class="flag protected">protected</span> |
|
16452 |
|
16453 |
|
16454 |
|
16455 |
|
16456 |
|
16457 |
|
16458 |
|
16459 |
|
16460 |
|
16461 |
|
16462 <div class="meta"> |
|
16463 |
|
16464 |
|
16465 |
|
16466 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
16467 |
|
16468 <p> |
|
16469 |
|
16470 Defined in |
|
16471 |
|
16472 |
|
16473 |
|
16474 |
|
16475 <a href="../files/datatable_js_core.js.html#l810"><code>datatable/js/core.js:810</code></a> |
|
16476 |
|
16477 </p> |
|
16478 |
|
16479 |
|
16480 |
|
16481 |
|
16482 |
|
16483 <p>Available since 3.5.0</p> |
|
16484 |
|
16485 </div> |
|
16486 |
|
16487 <div class="description"> |
|
16488 <p>Accepts an object with <code>each</code> and <code>getAttrs</code> (preferably a ModelList or |
|
16489 subclass) or an array of data objects. If an array is passes, it will |
|
16490 create a ModelList to wrap the data. In doing so, it will set the created |
|
16491 ModelList's <code>model</code> property to the class in the <code>recordType</code> attribute, |
|
16492 which will be defaulted if not yet set.</p> |
|
16493 |
|
16494 <p>If the <code>data</code> property is already set with a ModelList, passing an array as |
|
16495 the value will call the ModelList's <code>reset()</code> method with that array rather |
|
16496 than replacing the stored ModelList wholesale.</p> |
|
16497 |
|
16498 <p>Any non-ModelList-ish and non-array value is invalid.</p> |
|
16499 </div> |
|
16500 |
|
16501 |
|
16502 |
|
16503 |
|
16504 |
|
16505 |
|
16506 </div> |
|
16507 |
|
16508 |
|
16509 <div id="method__setRecordset" class="method item protected deprecated"> |
|
16510 <h3 class="name"><code>_setRecordset</code></h3> |
|
16511 |
|
16512 |
|
16513 <div class="args"> |
|
16514 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16515 |
|
16516 <li class="arg"> |
|
16517 |
|
16518 <code>val</code> |
|
16519 |
|
16520 </li> |
|
16521 |
|
16522 </ul><span class="paren">)</span> |
|
16523 </div> |
|
16524 |
|
16525 |
|
16526 |
|
16527 |
|
16528 |
|
16529 <span class="flag deprecated" title="This will be removed with the deprecated `recordset` attribute |
|
16530 in a later version.">deprecated</span> |
|
16531 |
|
16532 |
|
16533 |
|
16534 <span class="flag protected">protected</span> |
|
16535 |
|
16536 |
|
16537 |
|
16538 |
|
16539 |
|
16540 |
|
16541 |
|
16542 |
|
16543 |
|
16544 |
|
16545 <div class="meta"> |
|
16546 |
|
16547 |
|
16548 |
|
16549 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
16550 |
|
16551 <p> |
|
16552 |
|
16553 Defined in |
|
16554 |
|
16555 |
|
16556 |
|
16557 |
|
16558 <a href="../files/datatable_js_core.js.html#l853"><code>datatable/js/core.js:853</code></a> |
|
16559 |
|
16560 </p> |
|
16561 |
|
16562 |
|
16563 |
|
16564 <p>Deprecated: This will be removed with the deprecated `recordset` attribute |
|
16565 in a later version.</p> |
|
16566 |
|
16567 |
|
16568 |
|
16569 <p>Available since 3.5.0</p> |
|
16570 |
|
16571 </div> |
|
16572 |
|
16573 <div class="description"> |
|
16574 <p>Relays the value assigned to the deprecated <code>recordset</code> attribute to the |
|
16575 <code>data</code> attribute. If a Recordset instance is passed, the raw object data |
|
16576 will be culled from it.</p> |
|
16577 </div> |
|
16578 |
|
16579 |
|
16580 <div class="params"> |
|
16581 <h4>Parameters:</h4> |
|
16582 |
|
16583 <ul class="params-list"> |
|
16584 |
|
16585 <li class="param"> |
|
16586 |
|
16587 <code class="param-name">val</code> |
|
16588 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a> | <a href="../classes/Recordset.html" class="crosslink">Recordset</a></span> |
|
16589 |
|
16590 |
|
16591 |
|
16592 |
|
16593 <div class="param-description"> |
|
16594 <p>The recordset value to relay</p> |
|
16595 </div> |
|
16596 |
|
16597 |
|
16598 </li> |
|
16599 |
|
16600 </ul> |
|
16601 </div> |
|
16602 |
|
16603 |
|
16604 |
|
16605 |
|
16606 |
|
16607 </div> |
|
16608 |
|
16609 |
|
16610 <div id="method__setRecordType" class="method item protected"> |
|
16611 <h3 class="name"><code>_setRecordType</code></h3> |
|
16612 |
|
16613 |
|
16614 <div class="args"> |
|
16615 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16616 |
|
16617 <li class="arg"> |
|
16618 |
|
16619 <code>val</code> |
|
16620 |
|
16621 </li> |
|
16622 |
|
16623 </ul><span class="paren">)</span> |
|
16624 </div> |
|
16625 |
|
16626 |
|
16627 |
|
16628 <span class="returns-inline"> |
|
16629 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
16630 </span> |
|
16631 |
|
16632 |
|
16633 |
|
16634 |
|
16635 |
|
16636 <span class="flag protected">protected</span> |
|
16637 |
|
16638 |
|
16639 |
|
16640 |
|
16641 |
|
16642 |
|
16643 |
|
16644 |
|
16645 |
|
16646 |
|
16647 <div class="meta"> |
|
16648 |
|
16649 |
|
16650 |
|
16651 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
16652 |
|
16653 <p> |
|
16654 |
|
16655 Defined in |
|
16656 |
|
16657 |
|
16658 |
|
16659 |
|
16660 <a href="../files/datatable_js_core.js.html#l881"><code>datatable/js/core.js:881</code></a> |
|
16661 |
|
16662 </p> |
|
16663 |
|
16664 |
|
16665 |
|
16666 |
|
16667 |
|
16668 <p>Available since 3.5.0</p> |
|
16669 |
|
16670 </div> |
|
16671 |
|
16672 <div class="description"> |
|
16673 <p>Accepts a Base subclass (preferably a Model subclass). Alternately, it will |
|
16674 generate a custom Model subclass from an array of attribute names or an |
|
16675 object defining attributes and their respective configurations (it is |
|
16676 assigned as the <code>ATTRS</code> of the new class).</p> |
|
16677 |
|
16678 <p>Any other value is invalid.</p> |
|
16679 </div> |
|
16680 |
|
16681 |
|
16682 <div class="params"> |
|
16683 <h4>Parameters:</h4> |
|
16684 |
|
16685 <ul class="params-list"> |
|
16686 |
|
16687 <li class="param"> |
|
16688 |
|
16689 <code class="param-name">val</code> |
|
16690 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
16691 |
|
16692 |
|
16693 |
|
16694 |
|
16695 <div class="param-description"> |
|
16696 <p>The Model subclass, array of |
|
16697 attribute names, or the <code>ATTRS</code> definition for a custom model |
|
16698 subclass</p> |
|
16699 </div> |
|
16700 |
|
16701 |
|
16702 </li> |
|
16703 |
|
16704 </ul> |
|
16705 </div> |
|
16706 |
|
16707 |
|
16708 |
|
16709 <div class="returns"> |
|
16710 <h4>Returns:</h4> |
|
16711 |
|
16712 <div class="returns-description"> |
|
16713 |
|
16714 |
|
16715 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>: |
|
16716 |
|
16717 A Base/Model subclass |
|
16718 |
|
16719 </div> |
|
16720 </div> |
|
16721 |
|
16722 |
|
16723 |
|
16724 </div> |
|
16725 |
|
16726 |
|
16727 <div id="method__setScrollable" class="method item protected"> |
|
16728 <h3 class="name"><code>_setScrollable</code></h3> |
|
16729 |
|
16730 |
|
16731 <div class="args"> |
|
16732 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16733 |
|
16734 <li class="arg"> |
|
16735 |
|
16736 <code>val</code> |
|
16737 |
|
16738 </li> |
|
16739 |
|
16740 </ul><span class="paren">)</span> |
|
16741 </div> |
|
16742 |
|
16743 |
|
16744 |
|
16745 <span class="returns-inline"> |
|
16746 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16747 </span> |
|
16748 |
|
16749 |
|
16750 |
|
16751 |
|
16752 |
|
16753 <span class="flag protected">protected</span> |
|
16754 |
|
16755 |
|
16756 |
|
16757 |
|
16758 |
|
16759 |
|
16760 |
|
16761 |
|
16762 |
|
16763 |
|
16764 <div class="meta"> |
|
16765 |
|
16766 |
|
16767 |
|
16768 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
16769 |
|
16770 <p> |
|
16771 |
|
16772 Defined in |
|
16773 |
|
16774 |
|
16775 |
|
16776 |
|
16777 <a href="../files/datatable_js_scroll.js.html#l733"><code>datatable/js/scroll.js:733</code></a> |
|
16778 |
|
16779 </p> |
|
16780 |
|
16781 |
|
16782 |
|
16783 |
|
16784 |
|
16785 <p>Available since 3.5.0</p> |
|
16786 |
|
16787 </div> |
|
16788 |
|
16789 <div class="description"> |
|
16790 <p>Accepts (case insensitive) values "x", "y", "xy", <code>true</code>, and <code>false</code>. |
|
16791 <code>true</code> is translated to "xy" and upper case values are converted to lower |
|
16792 case. All other values are invalid.</p> |
|
16793 </div> |
|
16794 |
|
16795 |
|
16796 <div class="params"> |
|
16797 <h4>Parameters:</h4> |
|
16798 |
|
16799 <ul class="params-list"> |
|
16800 |
|
16801 <li class="param"> |
|
16802 |
|
16803 <code class="param-name">val</code> |
|
16804 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | Boolea</span> |
|
16805 |
|
16806 |
|
16807 |
|
16808 |
|
16809 <div class="param-description"> |
|
16810 <p>Incoming value for the <code>scrollable</code> attribute</p> |
|
16811 </div> |
|
16812 |
|
16813 |
|
16814 </li> |
|
16815 |
|
16816 </ul> |
|
16817 </div> |
|
16818 |
|
16819 |
|
16820 |
|
16821 <div class="returns"> |
|
16822 <h4>Returns:</h4> |
|
16823 |
|
16824 <div class="returns-description"> |
|
16825 |
|
16826 |
|
16827 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
16828 |
|
16829 |
|
16830 </div> |
|
16831 </div> |
|
16832 |
|
16833 |
|
16834 |
|
16835 </div> |
|
16836 |
|
16837 |
|
16838 <div id="method__setScrollProperties" class="method item protected"> |
|
16839 <h3 class="name"><code>_setScrollProperties</code></h3> |
|
16840 |
|
16841 |
|
16842 <span class="paren">()</span> |
|
16843 |
|
16844 |
|
16845 |
|
16846 |
|
16847 |
|
16848 |
|
16849 |
|
16850 <span class="flag protected">protected</span> |
|
16851 |
|
16852 |
|
16853 |
|
16854 |
|
16855 |
|
16856 |
|
16857 |
|
16858 |
|
16859 |
|
16860 |
|
16861 <div class="meta"> |
|
16862 |
|
16863 |
|
16864 |
|
16865 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
16866 |
|
16867 <p> |
|
16868 |
|
16869 Defined in |
|
16870 |
|
16871 |
|
16872 |
|
16873 |
|
16874 <a href="../files/datatable_js_scroll.js.html#l758"><code>datatable/js/scroll.js:758</code></a> |
|
16875 |
|
16876 </p> |
|
16877 |
|
16878 |
|
16879 |
|
16880 |
|
16881 |
|
16882 <p>Available since 3.5.0</p> |
|
16883 |
|
16884 </div> |
|
16885 |
|
16886 <div class="description"> |
|
16887 <p>Assigns the <code>_xScroll</code> and <code>_yScroll</code> properties to true if an |
|
16888 appropriate value is set in the <code>scrollable</code> attribute and the <code>height</code> |
|
16889 and/or <code>width</code> is set.</p> |
|
16890 </div> |
|
16891 |
|
16892 |
|
16893 |
|
16894 |
|
16895 |
|
16896 |
|
16897 </div> |
|
16898 |
|
16899 |
|
16900 <div id="method__setSortBy" class="method item protected"> |
|
16901 <h3 class="name"><code>_setSortBy</code></h3> |
|
16902 |
|
16903 |
|
16904 <span class="paren">()</span> |
|
16905 |
|
16906 |
|
16907 |
|
16908 |
|
16909 |
|
16910 |
|
16911 |
|
16912 <span class="flag protected">protected</span> |
|
16913 |
|
16914 |
|
16915 |
|
16916 |
|
16917 |
|
16918 |
|
16919 |
|
16920 |
|
16921 |
|
16922 |
|
16923 <div class="meta"> |
|
16924 |
|
16925 |
|
16926 |
|
16927 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
16928 |
|
16929 <p> |
|
16930 |
|
16931 Defined in |
|
16932 |
|
16933 |
|
16934 |
|
16935 |
|
16936 <a href="../files/datatable_js_sort.js.html#l650"><code>datatable/js/sort.js:650</code></a> |
|
16937 |
|
16938 </p> |
|
16939 |
|
16940 |
|
16941 |
|
16942 |
|
16943 |
|
16944 <p>Available since 3.5.0</p> |
|
16945 |
|
16946 </div> |
|
16947 |
|
16948 <div class="description"> |
|
16949 <p>Parses the current <code>sortBy</code> attribute into a normalized structure for the |
|
16950 <code>data</code> ModelList's <code>_compare</code> method. Also updates the column |
|
16951 configurations' <code>sortDir</code> properties.</p> |
|
16952 </div> |
|
16953 |
|
16954 |
|
16955 |
|
16956 |
|
16957 |
|
16958 |
|
16959 </div> |
|
16960 |
|
16961 |
|
16962 <div id="method__setStateVal" class="method item private inherited"> |
|
16963 <h3 class="name"><code>_setStateVal</code></h3> |
|
16964 |
|
16965 |
|
16966 <div class="args"> |
|
16967 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16968 |
|
16969 <li class="arg"> |
|
16970 |
|
16971 <code>name</code> |
|
16972 |
|
16973 </li> |
|
16974 |
|
16975 <li class="arg"> |
|
16976 |
|
16977 <code>value</code> |
|
16978 |
|
16979 </li> |
|
16980 |
|
16981 </ul><span class="paren">)</span> |
|
16982 </div> |
|
16983 |
|
16984 |
|
16985 |
|
16986 |
|
16987 |
|
16988 |
|
16989 |
|
16990 <span class="flag private">private</span> |
|
16991 |
|
16992 |
|
16993 |
|
16994 |
|
16995 |
|
16996 |
|
16997 |
|
16998 |
|
16999 |
|
17000 |
|
17001 <div class="meta"> |
|
17002 |
|
17003 |
|
17004 <p>Inherited from |
|
17005 <a href="../classes/AttributeCore.html#method__setStateVal">AttributeCore</a>: |
|
17006 |
|
17007 |
|
17008 |
|
17009 <a href="../files/attribute_js_AttributeCore.js.html#l622"><code>attribute/js/AttributeCore.js:622</code></a> |
|
17010 |
|
17011 </p> |
|
17012 |
|
17013 |
|
17014 |
|
17015 |
|
17016 |
|
17017 </div> |
|
17018 |
|
17019 <div class="description"> |
|
17020 <p>Sets the stored value for the attribute, in either the |
|
17021 internal state object, or the state proxy if it exits</p> |
|
17022 </div> |
|
17023 |
|
17024 |
|
17025 <div class="params"> |
|
17026 <h4>Parameters:</h4> |
|
17027 |
|
17028 <ul class="params-list"> |
|
17029 |
|
17030 <li class="param"> |
|
17031 |
|
17032 <code class="param-name">name</code> |
|
17033 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17034 |
|
17035 |
|
17036 |
|
17037 |
|
17038 <div class="param-description"> |
|
17039 <p>The name of the attribute</p> |
|
17040 </div> |
|
17041 |
|
17042 |
|
17043 </li> |
|
17044 |
|
17045 <li class="param"> |
|
17046 |
|
17047 <code class="param-name">value</code> |
|
17048 <span class="type">Any</span> |
|
17049 |
|
17050 |
|
17051 |
|
17052 |
|
17053 <div class="param-description"> |
|
17054 <p>The value of the attribute</p> |
|
17055 </div> |
|
17056 |
|
17057 |
|
17058 </li> |
|
17059 |
|
17060 </ul> |
|
17061 </div> |
|
17062 |
|
17063 |
|
17064 |
|
17065 |
|
17066 |
|
17067 </div> |
|
17068 |
|
17069 |
|
17070 <div id="method__setStrings" class="method item protected inherited"> |
|
17071 <h3 class="name"><code>_setStrings</code></h3> |
|
17072 |
|
17073 |
|
17074 <div class="args"> |
|
17075 <span class="paren">(</span><ul class="args-list inline commas"> |
|
17076 |
|
17077 <li class="arg"> |
|
17078 |
|
17079 <code>strings</code> |
|
17080 |
|
17081 </li> |
|
17082 |
|
17083 <li class="arg"> |
|
17084 |
|
17085 <code>locale</code> |
|
17086 |
|
17087 </li> |
|
17088 |
|
17089 </ul><span class="paren">)</span> |
|
17090 </div> |
|
17091 |
|
17092 |
|
17093 |
|
17094 |
|
17095 |
|
17096 |
|
17097 |
|
17098 <span class="flag protected">protected</span> |
|
17099 |
|
17100 |
|
17101 |
|
17102 |
|
17103 |
|
17104 |
|
17105 |
|
17106 |
|
17107 |
|
17108 |
|
17109 <div class="meta"> |
|
17110 |
|
17111 |
|
17112 <p>Inherited from |
|
17113 <a href="../classes/Widget.html#method__setStrings">Widget</a>: |
|
17114 |
|
17115 |
|
17116 |
|
17117 <a href="../files/widget_js_WidgetLocale.js.html#l35"><code>widget/js/WidgetLocale.js:35</code></a> |
|
17118 |
|
17119 </p> |
|
17120 |
|
17121 |
|
17122 |
|
17123 |
|
17124 |
|
17125 </div> |
|
17126 |
|
17127 <div class="description"> |
|
17128 <p>Sets strings for a particular locale, merging with any existing |
|
17129 strings which may already be defined for the locale.</p> |
|
17130 </div> |
|
17131 |
|
17132 |
|
17133 <div class="params"> |
|
17134 <h4>Parameters:</h4> |
|
17135 |
|
17136 <ul class="params-list"> |
|
17137 |
|
17138 <li class="param"> |
|
17139 |
|
17140 <code class="param-name">strings</code> |
|
17141 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
17142 |
|
17143 |
|
17144 |
|
17145 |
|
17146 <div class="param-description"> |
|
17147 <p>The hash of string key/values to set</p> |
|
17148 </div> |
|
17149 |
|
17150 |
|
17151 </li> |
|
17152 |
|
17153 <li class="param"> |
|
17154 |
|
17155 <code class="param-name">locale</code> |
|
17156 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
17157 |
|
17158 |
|
17159 |
|
17160 |
|
17161 <div class="param-description"> |
|
17162 <p>The locale for the string values being set</p> |
|
17163 </div> |
|
17164 |
|
17165 |
|
17166 </li> |
|
17167 |
|
17168 </ul> |
|
17169 </div> |
|
17170 |
|
17171 |
|
17172 |
|
17173 |
|
17174 |
|
17175 </div> |
|
17176 |
|
17177 |
|
17178 <div id="method__sortComparator" class="method item protected"> |
|
17179 <h3 class="name"><code>_sortComparator</code></h3> |
|
17180 |
|
17181 |
|
17182 <div class="args"> |
|
17183 <span class="paren">(</span><ul class="args-list inline commas"> |
|
17184 |
|
17185 <li class="arg"> |
|
17186 |
|
17187 <code>item</code> |
|
17188 |
|
17189 </li> |
|
17190 |
|
17191 </ul><span class="paren">)</span> |
|
17192 </div> |
|
17193 |
|
17194 |
|
17195 |
|
17196 <span class="returns-inline"> |
|
17197 <span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span> |
|
17198 </span> |
|
17199 |
|
17200 |
|
17201 |
|
17202 |
|
17203 |
|
17204 <span class="flag protected">protected</span> |
|
17205 |
|
17206 |
|
17207 |
|
17208 |
|
17209 |
|
17210 |
|
17211 |
|
17212 |
|
17213 |
|
17214 |
|
17215 <div class="meta"> |
|
17216 |
|
17217 |
|
17218 |
|
17219 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
17220 |
|
17221 <p> |
|
17222 |
|
17223 Defined in |
|
17224 |
|
17225 |
|
17226 |
|
17227 |
|
17228 <a href="../files/datatable_js_sort.js.html#l741"><code>datatable/js/sort.js:741</code></a> |
|
17229 |
|
17230 </p> |
|
17231 |
|
17232 |
|
17233 |
|
17234 |
|
17235 |
|
17236 <p>Available since 3.5.0</p> |
|
17237 |
|
17238 </div> |
|
17239 |
|
17240 <div class="description"> |
|
17241 <p>Replacement <code>comparator</code> for the <code>data</code> ModelList that defers sorting logic |
|
17242 to the <code>_compare</code> method. The deferral is accomplished by returning <code>this</code>.</p> |
|
17243 </div> |
|
17244 |
|
17245 |
|
17246 <div class="params"> |
|
17247 <h4>Parameters:</h4> |
|
17248 |
|
17249 <ul class="params-list"> |
|
17250 |
|
17251 <li class="param"> |
|
17252 |
|
17253 <code class="param-name">item</code> |
|
17254 <span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span> |
|
17255 |
|
17256 |
|
17257 |
|
17258 |
|
17259 <div class="param-description"> |
|
17260 <p>The record being evaluated for sort position</p> |
|
17261 </div> |
|
17262 |
|
17263 |
|
17264 </li> |
|
17265 |
|
17266 </ul> |
|
17267 </div> |
|
17268 |
|
17269 |
|
17270 |
|
17271 <div class="returns"> |
|
17272 <h4>Returns:</h4> |
|
17273 |
|
17274 <div class="returns-description"> |
|
17275 |
|
17276 |
|
17277 <span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>: |
|
17278 |
|
17279 The record |
|
17280 |
|
17281 </div> |
|
17282 </div> |
|
17283 |
|
17284 |
|
17285 |
|
17286 </div> |
|
17287 |
|
17288 |
|
17289 <div id="method__strSetter" class="method item protected inherited"> |
|
17290 <h3 class="name"><code>_strSetter</code></h3> |
|
17291 |
|
17292 |
|
17293 <div class="args"> |
|
17294 <span class="paren">(</span><ul class="args-list inline commas"> |
|
17295 |
|
17296 <li class="arg"> |
|
17297 |
|
17298 <code>strings</code> |
|
17299 |
|
17300 </li> |
|
17301 |
|
17302 </ul><span class="paren">)</span> |
|
17303 </div> |
|
17304 |
|
17305 |
|
17306 |
|
17307 <span class="returns-inline"> |
|
17308 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17309 </span> |
|
17310 |
|
17311 |
|
17312 |
|
17313 |
|
17314 |
|
17315 <span class="flag protected">protected</span> |
|
17316 |
|
17317 |
|
17318 |
|
17319 |
|
17320 |
|
17321 |
|
17322 |
|
17323 |
|
17324 |
|
17325 |
|
17326 <div class="meta"> |
|
17327 |
|
17328 |
|
17329 <p>Inherited from |
|
17330 <a href="../classes/Widget.html#method__strSetter">Widget</a>: |
|
17331 |
|
17332 |
|
17333 |
|
17334 <a href="../files/widget_js_Widget.js.html#l1212"><code>widget/js/Widget.js:1212</code></a> |
|
17335 |
|
17336 </p> |
|
17337 |
|
17338 |
|
17339 |
|
17340 |
|
17341 |
|
17342 </div> |
|
17343 |
|
17344 <div class="description"> |
|
17345 <p>The default setter for the strings attribute. Merges partial sets |
|
17346 into the full string set, to allow users to partial sets of strings</p> |
|
17347 </div> |
|
17348 |
|
17349 |
|
17350 <div class="params"> |
|
17351 <h4>Parameters:</h4> |
|
17352 |
|
17353 <ul class="params-list"> |
|
17354 |
|
17355 <li class="param"> |
|
17356 |
|
17357 <code class="param-name">strings</code> |
|
17358 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
17359 |
|
17360 |
|
17361 |
|
17362 |
|
17363 <div class="param-description"> |
|
17364 |
|
17365 </div> |
|
17366 |
|
17367 |
|
17368 </li> |
|
17369 |
|
17370 </ul> |
|
17371 </div> |
|
17372 |
|
17373 |
|
17374 |
|
17375 <div class="returns"> |
|
17376 <h4>Returns:</h4> |
|
17377 |
|
17378 <div class="returns-description"> |
|
17379 |
|
17380 |
|
17381 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
17382 |
|
17383 The full set of strings to set |
|
17384 |
|
17385 </div> |
|
17386 </div> |
|
17387 |
|
17388 |
|
17389 |
|
17390 </div> |
|
17391 |
|
17392 |
|
17393 <div id="method__syncAttrUI" class="method item private inherited"> |
|
17394 <h3 class="name"><code>_syncAttrUI</code></h3> |
|
17395 |
|
17396 |
|
17397 <div class="args"> |
|
17398 <span class="paren">(</span><ul class="args-list inline commas"> |
|
17399 |
|
17400 <li class="arg"> |
|
17401 |
|
17402 <code>attrs</code> |
|
17403 |
|
17404 </li> |
|
17405 |
|
17406 </ul><span class="paren">)</span> |
|
17407 </div> |
|
17408 |
|
17409 |
|
17410 |
|
17411 |
|
17412 |
|
17413 |
|
17414 |
|
17415 <span class="flag private">private</span> |
|
17416 |
|
17417 |
|
17418 |
|
17419 |
|
17420 |
|
17421 |
|
17422 |
|
17423 |
|
17424 |
|
17425 |
|
17426 <div class="meta"> |
|
17427 |
|
17428 |
|
17429 <p>Inherited from |
|
17430 <a href="../classes/Widget.html#method__syncAttrUI">Widget</a>: |
|
17431 |
|
17432 |
|
17433 |
|
17434 <a href="../files/widget_js_Widget.js.html#l1186"><code>widget/js/Widget.js:1186</code></a> |
|
17435 |
|
17436 </p> |
|
17437 |
|
17438 |
|
17439 |
|
17440 |
|
17441 |
|
17442 </div> |
|
17443 |
|
17444 <div class="description"> |
|
17445 <p>Invokes the _uiSet=ATTR NAME> method for the list of attributes provided</p> |
|
17446 </div> |
|
17447 |
|
17448 |
|
17449 <div class="params"> |
|
17450 <h4>Parameters:</h4> |
|
17451 |
|
17452 <ul class="params-list"> |
|
17453 |
|
17454 <li class="param"> |
|
17455 |
|
17456 <code class="param-name">attrs</code> |
|
17457 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
17458 |
|
17459 |
|
17460 |
|
17461 |
|
17462 <div class="param-description"> |
|
17463 |
|
17464 </div> |
|
17465 |
|
17466 |
|
17467 </li> |
|
17468 |
|
17469 </ul> |
|
17470 </div> |
|
17471 |
|
17472 |
|
17473 |
|
17474 |
|
17475 |
|
17476 </div> |
|
17477 |
|
17478 |
|
17479 <div id="method__syncMessageUI" class="method item protected"> |
|
17480 <h3 class="name"><code>_syncMessageUI</code></h3> |
|
17481 |
|
17482 |
|
17483 <span class="paren">()</span> |
|
17484 |
|
17485 |
|
17486 |
|
17487 |
|
17488 |
|
17489 |
|
17490 |
|
17491 <span class="flag protected">protected</span> |
|
17492 |
|
17493 |
|
17494 |
|
17495 |
|
17496 |
|
17497 |
|
17498 |
|
17499 |
|
17500 |
|
17501 |
|
17502 <div class="meta"> |
|
17503 |
|
17504 |
|
17505 |
|
17506 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
17507 |
|
17508 <p> |
|
17509 |
|
17510 Defined in |
|
17511 |
|
17512 |
|
17513 |
|
17514 |
|
17515 <a href="../files/datatable_js_message.js.html#l247"><code>datatable/js/message.js:247</code></a> |
|
17516 |
|
17517 </p> |
|
17518 |
|
17519 |
|
17520 |
|
17521 |
|
17522 |
|
17523 <p>Available since 3.5.0</p> |
|
17524 |
|
17525 </div> |
|
17526 |
|
17527 <div class="description"> |
|
17528 <p>Synchronizes the message UI with the table state.</p> |
|
17529 </div> |
|
17530 |
|
17531 |
|
17532 |
|
17533 |
|
17534 |
|
17535 |
|
17536 </div> |
|
17537 |
|
17538 |
|
17539 <div id="method__syncScrollCaptionUI" class="method item protected"> |
|
17540 <h3 class="name"><code>_syncScrollCaptionUI</code></h3> |
|
17541 |
|
17542 |
|
17543 <span class="paren">()</span> |
|
17544 |
|
17545 |
|
17546 |
|
17547 |
|
17548 |
|
17549 |
|
17550 |
|
17551 <span class="flag protected">protected</span> |
|
17552 |
|
17553 |
|
17554 |
|
17555 |
|
17556 |
|
17557 |
|
17558 |
|
17559 |
|
17560 |
|
17561 |
|
17562 <div class="meta"> |
|
17563 |
|
17564 |
|
17565 |
|
17566 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
17567 |
|
17568 <p> |
|
17569 |
|
17570 Defined in |
|
17571 |
|
17572 |
|
17573 |
|
17574 |
|
17575 <a href="../files/datatable_js_scroll.js.html#l805"><code>datatable/js/scroll.js:805</code></a> |
|
17576 |
|
17577 </p> |
|
17578 |
|
17579 |
|
17580 |
|
17581 |
|
17582 |
|
17583 <p>Available since 3.5.0</p> |
|
17584 |
|
17585 </div> |
|
17586 |
|
17587 <div class="description"> |
|
17588 <p>Splits the caption from the data <code><table></code> if the table is configured to |
|
17589 scroll. If not, rejoins the caption to the data <code><table></code> if it needs to |
|
17590 be.</p> |
|
17591 </div> |
|
17592 |
|
17593 |
|
17594 |
|
17595 |
|
17596 |
|
17597 |
|
17598 </div> |
|
17599 |
|
17600 |
|
17601 <div id="method__syncScrollColumnWidths" class="method item protected"> |
|
17602 <h3 class="name"><code>_syncScrollColumnWidths</code></h3> |
|
17603 |
|
17604 |
|
17605 <span class="paren">()</span> |
|
17606 |
|
17607 |
|
17608 |
|
17609 |
|
17610 |
|
17611 |
|
17612 |
|
17613 <span class="flag protected">protected</span> |
|
17614 |
|
17615 |
|
17616 |
|
17617 |
|
17618 |
|
17619 |
|
17620 |
|
17621 |
|
17622 |
|
17623 |
|
17624 <div class="meta"> |
|
17625 |
|
17626 |
|
17627 |
|
17628 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
17629 |
|
17630 <p> |
|
17631 |
|
17632 Defined in |
|
17633 |
|
17634 |
|
17635 |
|
17636 |
|
17637 <a href="../files/datatable_js_scroll.js.html#l844"><code>datatable/js/scroll.js:844</code></a> |
|
17638 |
|
17639 </p> |
|
17640 |
|
17641 |
|
17642 |
|
17643 |
|
17644 |
|
17645 <p>Available since 3.5.0</p> |
|
17646 |
|
17647 </div> |
|
17648 |
|
17649 <div class="description"> |
|
17650 <p>Assigns widths to the fixed header columns to match the columns in the data |
|
17651 table.</p> |
|
17652 </div> |
|
17653 |
|
17654 |
|
17655 |
|
17656 |
|
17657 |
|
17658 |
|
17659 </div> |
|
17660 |
|
17661 |
|
17662 <div id="method__syncScrollHeaders" class="method item protected"> |
|
17663 <h3 class="name"><code>_syncScrollHeaders</code></h3> |
|
17664 |
|
17665 |
|
17666 <span class="paren">()</span> |
|
17667 |
|
17668 |
|
17669 |
|
17670 |
|
17671 |
|
17672 |
|
17673 |
|
17674 <span class="flag protected">protected</span> |
|
17675 |
|
17676 |
|
17677 |
|
17678 |
|
17679 |
|
17680 |
|
17681 |
|
17682 |
|
17683 |
|
17684 |
|
17685 <div class="meta"> |
|
17686 |
|
17687 |
|
17688 |
|
17689 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
17690 |
|
17691 <p> |
|
17692 |
|
17693 Defined in |
|
17694 |
|
17695 |
|
17696 |
|
17697 |
|
17698 <a href="../files/datatable_js_scroll.js.html#l886"><code>datatable/js/scroll.js:886</code></a> |
|
17699 |
|
17700 </p> |
|
17701 |
|
17702 |
|
17703 |
|
17704 |
|
17705 |
|
17706 <p>Available since 3.5.0</p> |
|
17707 |
|
17708 </div> |
|
17709 |
|
17710 <div class="description"> |
|
17711 <p>Creates matching headers in the fixed header table for vertically scrolling |
|
17712 tables and synchronizes the column widths.</p> |
|
17713 </div> |
|
17714 |
|
17715 |
|
17716 |
|
17717 |
|
17718 |
|
17719 |
|
17720 </div> |
|
17721 |
|
17722 |
|
17723 <div id="method__syncScrollPosition" class="method item protected"> |
|
17724 <h3 class="name"><code>_syncScrollPosition</code></h3> |
|
17725 |
|
17726 |
|
17727 <div class="args"> |
|
17728 <span class="paren">(</span><ul class="args-list inline commas"> |
|
17729 |
|
17730 <li class="arg"> |
|
17731 |
|
17732 <code>e</code> |
|
17733 |
|
17734 </li> |
|
17735 |
|
17736 </ul><span class="paren">)</span> |
|
17737 </div> |
|
17738 |
|
17739 |
|
17740 |
|
17741 |
|
17742 |
|
17743 |
|
17744 |
|
17745 <span class="flag protected">protected</span> |
|
17746 |
|
17747 |
|
17748 |
|
17749 |
|
17750 |
|
17751 |
|
17752 |
|
17753 |
|
17754 |
|
17755 |
|
17756 <div class="meta"> |
|
17757 |
|
17758 |
|
17759 |
|
17760 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
17761 |
|
17762 <p> |
|
17763 |
|
17764 Defined in |
|
17765 |
|
17766 |
|
17767 |
|
17768 |
|
17769 <a href="../files/datatable_js_scroll.js.html#l776"><code>datatable/js/scroll.js:776</code></a> |
|
17770 |
|
17771 </p> |
|
17772 |
|
17773 |
|
17774 |
|
17775 |
|
17776 |
|
17777 <p>Available since 3.5.0</p> |
|
17778 |
|
17779 </div> |
|
17780 |
|
17781 <div class="description"> |
|
17782 <p>Keeps the virtual scrollbar and the scrolling <code><div></code> wrapper around the |
|
17783 data table in vertically scrolling tables in sync.</p> |
|
17784 </div> |
|
17785 |
|
17786 |
|
17787 <div class="params"> |
|
17788 <h4>Parameters:</h4> |
|
17789 |
|
17790 <ul class="params-list"> |
|
17791 |
|
17792 <li class="param"> |
|
17793 |
|
17794 <code class="param-name">e</code> |
|
17795 <span class="type"><a href="../classes/DOMEventFacade.html" class="crosslink">DOMEventFacade</a></span> |
|
17796 |
|
17797 |
|
17798 |
|
17799 |
|
17800 <div class="param-description"> |
|
17801 <p>The scroll event</p> |
|
17802 </div> |
|
17803 |
|
17804 |
|
17805 </li> |
|
17806 |
|
17807 </ul> |
|
17808 </div> |
|
17809 |
|
17810 |
|
17811 |
|
17812 |
|
17813 |
|
17814 </div> |
|
17815 |
|
17816 |
|
17817 <div id="method__syncScrollUI" class="method item protected"> |
|
17818 <h3 class="name"><code>_syncScrollUI</code></h3> |
|
17819 |
|
17820 |
|
17821 <span class="paren">()</span> |
|
17822 |
|
17823 |
|
17824 |
|
17825 |
|
17826 |
|
17827 |
|
17828 |
|
17829 <span class="flag protected">protected</span> |
|
17830 |
|
17831 |
|
17832 |
|
17833 |
|
17834 |
|
17835 |
|
17836 |
|
17837 |
|
17838 |
|
17839 |
|
17840 <div class="meta"> |
|
17841 |
|
17842 |
|
17843 |
|
17844 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
17845 |
|
17846 <p> |
|
17847 |
|
17848 Defined in |
|
17849 |
|
17850 |
|
17851 |
|
17852 |
|
17853 <a href="../files/datatable_js_scroll.js.html#l934"><code>datatable/js/scroll.js:934</code></a> |
|
17854 |
|
17855 </p> |
|
17856 |
|
17857 |
|
17858 |
|
17859 |
|
17860 |
|
17861 <p>Available since 3.5.0</p> |
|
17862 |
|
17863 </div> |
|
17864 |
|
17865 <div class="description"> |
|
17866 <p>Wraps the table for X and Y scrolling, if necessary, if the <code>scrollable</code> |
|
17867 attribute is set. Synchronizes dimensions and DOM placement of all |
|
17868 scrolling related nodes.</p> |
|
17869 </div> |
|
17870 |
|
17871 |
|
17872 |
|
17873 |
|
17874 |
|
17875 |
|
17876 </div> |
|
17877 |
|
17878 |
|
17879 <div id="method__syncUI" class="method item protected inherited"> |
|
17880 <h3 class="name"><code>_syncUI</code></h3> |
|
17881 |
|
17882 |
|
17883 <span class="paren">()</span> |
|
17884 |
|
17885 |
|
17886 |
|
17887 |
|
17888 |
|
17889 |
|
17890 |
|
17891 <span class="flag protected">protected</span> |
|
17892 |
|
17893 |
|
17894 |
|
17895 |
|
17896 |
|
17897 |
|
17898 |
|
17899 |
|
17900 |
|
17901 |
|
17902 <div class="meta"> |
|
17903 |
|
17904 |
|
17905 <p>Inherited from |
|
17906 <a href="../classes/Widget.html#method__syncUI">Widget</a>: |
|
17907 |
|
17908 |
|
17909 |
|
17910 <a href="../files/widget_js_Widget.js.html#l964"><code>widget/js/Widget.js:964</code></a> |
|
17911 |
|
17912 </p> |
|
17913 |
|
17914 |
|
17915 |
|
17916 |
|
17917 |
|
17918 </div> |
|
17919 |
|
17920 <div class="description"> |
|
17921 <p>Updates the widget UI to reflect the attribute state.</p> |
|
17922 </div> |
|
17923 |
|
17924 |
|
17925 |
|
17926 |
|
17927 |
|
17928 |
|
17929 </div> |
|
17930 |
|
17931 |
|
17932 <div id="method__syncUIChild" class="method item protected inherited"> |
|
17933 <h3 class="name"><code>_syncUIChild</code></h3> |
|
17934 |
|
17935 |
|
17936 <span class="paren">()</span> |
|
17937 |
|
17938 |
|
17939 |
|
17940 |
|
17941 |
|
17942 |
|
17943 |
|
17944 <span class="flag protected">protected</span> |
|
17945 |
|
17946 |
|
17947 |
|
17948 |
|
17949 |
|
17950 |
|
17951 |
|
17952 |
|
17953 |
|
17954 |
|
17955 <div class="meta"> |
|
17956 |
|
17957 |
|
17958 <p>Inherited from |
|
17959 <a href="../classes/Widget.html#method__syncUIChild">Widget</a>: |
|
17960 |
|
17961 |
|
17962 |
|
17963 <a href="../files/widget-child_js_Widget-Child.js.html#l341"><code>widget-child/js/Widget-Child.js:341</code></a> |
|
17964 |
|
17965 </p> |
|
17966 |
|
17967 |
|
17968 |
|
17969 |
|
17970 |
|
17971 </div> |
|
17972 |
|
17973 <div class="description"> |
|
17974 <p>Synchronizes the UI to match the WidgetChild state.</p> |
|
17975 |
|
17976 <p> |
|
17977 This method is invoked after bindUI is invoked for the Widget class |
|
17978 using YUI's aop infrastructure. |
|
17979 </p> |
|
17980 </div> |
|
17981 |
|
17982 |
|
17983 |
|
17984 |
|
17985 |
|
17986 |
|
17987 </div> |
|
17988 |
|
17989 |
|
17990 <div id="method__syncXScrollUI" class="method item protected"> |
|
17991 <h3 class="name"><code>_syncXScrollUI</code></h3> |
|
17992 |
|
17993 |
|
17994 <div class="args"> |
|
17995 <span class="paren">(</span><ul class="args-list inline commas"> |
|
17996 |
|
17997 <li class="arg"> |
|
17998 |
|
17999 <code>xy</code> |
|
18000 |
|
18001 </li> |
|
18002 |
|
18003 </ul><span class="paren">)</span> |
|
18004 </div> |
|
18005 |
|
18006 |
|
18007 |
|
18008 |
|
18009 |
|
18010 |
|
18011 |
|
18012 <span class="flag protected">protected</span> |
|
18013 |
|
18014 |
|
18015 |
|
18016 |
|
18017 |
|
18018 |
|
18019 |
|
18020 |
|
18021 |
|
18022 |
|
18023 <div class="meta"> |
|
18024 |
|
18025 |
|
18026 |
|
18027 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
18028 |
|
18029 <p> |
|
18030 |
|
18031 Defined in |
|
18032 |
|
18033 |
|
18034 |
|
18035 |
|
18036 <a href="../files/datatable_js_scroll.js.html#l995"><code>datatable/js/scroll.js:995</code></a> |
|
18037 |
|
18038 </p> |
|
18039 |
|
18040 |
|
18041 |
|
18042 |
|
18043 |
|
18044 <p>Available since 3.5.0</p> |
|
18045 |
|
18046 </div> |
|
18047 |
|
18048 <div class="description"> |
|
18049 <p>Wraps the table in a scrolling <code><div></code> of the configured width for "x" |
|
18050 scrolling.</p> |
|
18051 </div> |
|
18052 |
|
18053 |
|
18054 <div class="params"> |
|
18055 <h4>Parameters:</h4> |
|
18056 |
|
18057 <ul class="params-list"> |
|
18058 |
|
18059 <li class="param"> |
|
18060 |
|
18061 <code class="param-name">xy</code> |
|
18062 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
18063 |
|
18064 |
|
18065 |
|
18066 |
|
18067 <div class="param-description"> |
|
18068 <p>True if the table is configured with scrollable ="xy"</p> |
|
18069 </div> |
|
18070 |
|
18071 |
|
18072 </li> |
|
18073 |
|
18074 </ul> |
|
18075 </div> |
|
18076 |
|
18077 |
|
18078 |
|
18079 |
|
18080 |
|
18081 </div> |
|
18082 |
|
18083 |
|
18084 <div id="method__syncYScrollUI" class="method item protected"> |
|
18085 <h3 class="name"><code>_syncYScrollUI</code></h3> |
|
18086 |
|
18087 |
|
18088 <div class="args"> |
|
18089 <span class="paren">(</span><ul class="args-list inline commas"> |
|
18090 |
|
18091 <li class="arg"> |
|
18092 |
|
18093 <code>xy</code> |
|
18094 |
|
18095 </li> |
|
18096 |
|
18097 </ul><span class="paren">)</span> |
|
18098 </div> |
|
18099 |
|
18100 |
|
18101 |
|
18102 |
|
18103 |
|
18104 |
|
18105 |
|
18106 <span class="flag protected">protected</span> |
|
18107 |
|
18108 |
|
18109 |
|
18110 |
|
18111 |
|
18112 |
|
18113 |
|
18114 |
|
18115 |
|
18116 |
|
18117 <div class="meta"> |
|
18118 |
|
18119 |
|
18120 |
|
18121 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
18122 |
|
18123 <p> |
|
18124 |
|
18125 Defined in |
|
18126 |
|
18127 |
|
18128 |
|
18129 |
|
18130 <a href="../files/datatable_js_scroll.js.html#l1064"><code>datatable/js/scroll.js:1064</code></a> |
|
18131 |
|
18132 </p> |
|
18133 |
|
18134 |
|
18135 |
|
18136 |
|
18137 |
|
18138 <p>Available since 3.5.0</p> |
|
18139 |
|
18140 </div> |
|
18141 |
|
18142 <div class="description"> |
|
18143 <p>Wraps the table in a scrolling <code><div></code> of the configured height (accounting |
|
18144 for the caption if there is one) if "y" scrolling is enabled. Otherwise, |
|
18145 unwraps the table if necessary.</p> |
|
18146 </div> |
|
18147 |
|
18148 |
|
18149 <div class="params"> |
|
18150 <h4>Parameters:</h4> |
|
18151 |
|
18152 <ul class="params-list"> |
|
18153 |
|
18154 <li class="param"> |
|
18155 |
|
18156 <code class="param-name">xy</code> |
|
18157 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
18158 |
|
18159 |
|
18160 |
|
18161 |
|
18162 <div class="param-description"> |
|
18163 <p>True if the table is configured with scrollable = "xy"</p> |
|
18164 </div> |
|
18165 |
|
18166 |
|
18167 </li> |
|
18168 |
|
18169 </ul> |
|
18170 </div> |
|
18171 |
|
18172 |
|
18173 |
|
18174 |
|
18175 |
|
18176 </div> |
|
18177 |
|
18178 |
|
18179 <div id="method__uiSetChildSelected" class="method item protected inherited"> |
|
18180 <h3 class="name"><code>_uiSetChildSelected</code></h3> |
|
18181 |
|
18182 |
|
18183 <div class="args"> |
|
18184 <span class="paren">(</span><ul class="args-list inline commas"> |
|
18185 |
|
18186 <li class="arg"> |
|
18187 |
|
18188 <code>selected</code> |
|
18189 |
|
18190 </li> |
|
18191 |
|
18192 </ul><span class="paren">)</span> |
|
18193 </div> |
|
18194 |
|
18195 |
|
18196 |
|
18197 |
|
18198 |
|
18199 |
|
18200 |
|
18201 <span class="flag protected">protected</span> |
|
18202 |
|
18203 |
|
18204 |
|
18205 |
|
18206 |
|
18207 |
|
18208 |
|
18209 |
|
18210 |
|
18211 |
|
18212 <div class="meta"> |
|
18213 |
|
18214 |
|
18215 <p>Inherited from |
|
18216 <a href="../classes/Widget.html#method__uiSetChildSelected">Widget</a>: |
|
18217 |
|
18218 |
|
18219 |
|
18220 <a href="../files/widget-child_js_Widget-Child.js.html#l305"><code>widget-child/js/Widget-Child.js:305</code></a> |
|
18221 |
|
18222 </p> |
|
18223 |
|
18224 |
|
18225 |
|
18226 |
|
18227 |
|
18228 </div> |
|
18229 |
|
18230 <div class="description"> |
|
18231 <p>Updates the UI to reflect the <code>selected</code> attribute value.</p> |
|
18232 </div> |
|
18233 |
|
18234 |
|
18235 <div class="params"> |
|
18236 <h4>Parameters:</h4> |
|
18237 |
|
18238 <ul class="params-list"> |
|
18239 |
|
18240 <li class="param"> |
|
18241 |
|
18242 <code class="param-name">selected</code> |
|
18243 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
18244 |
|
18245 |
|
18246 |
|
18247 |
|
18248 <div class="param-description"> |
|
18249 <p>The selected value to be reflected in the UI.</p> |
|
18250 </div> |
|
18251 |
|
18252 |
|
18253 </li> |
|
18254 |
|
18255 </ul> |
|
18256 </div> |
|
18257 |
|
18258 |
|
18259 |
|
18260 |
|
18261 |
|
18262 </div> |
|
18263 |
|
18264 |
|
18265 <div id="method__uiSetColumnWidths" class="method item protected"> |
|
18266 <h3 class="name"><code>_uiSetColumnWidths</code></h3> |
|
18267 |
|
18268 |
|
18269 <span class="paren">()</span> |
|
18270 |
|
18271 |
|
18272 |
|
18273 |
|
18274 |
|
18275 |
|
18276 |
|
18277 <span class="flag protected">protected</span> |
|
18278 |
|
18279 |
|
18280 |
|
18281 |
|
18282 |
|
18283 |
|
18284 |
|
18285 |
|
18286 |
|
18287 |
|
18288 <div class="meta"> |
|
18289 |
|
18290 |
|
18291 |
|
18292 <p>Provided by the <a href="../modules/datatable-column-widths.html">datatable-column-widths</a> module.</p> |
|
18293 |
|
18294 <p> |
|
18295 |
|
18296 Defined in |
|
18297 |
|
18298 |
|
18299 |
|
18300 |
|
18301 <a href="../files/datatable_js_colwidths.js.html#l254"><code>datatable/js/colwidths.js:254</code></a> |
|
18302 |
|
18303 </p> |
|
18304 |
|
18305 |
|
18306 |
|
18307 |
|
18308 |
|
18309 <p>Available since 3.5.0</p> |
|
18310 |
|
18311 </div> |
|
18312 |
|
18313 <div class="description"> |
|
18314 <p>Populates the table's <code><colgroup></code> with a <code><col></code> per item in the <code>columns</code> |
|
18315 attribute without children. It is assumed that these are the columns that |
|
18316 have data cells renderered for them.</p> |
|
18317 </div> |
|
18318 |
|
18319 |
|
18320 |
|
18321 |
|
18322 |
|
18323 |
|
18324 </div> |
|
18325 |
|
18326 |
|
18327 <div id="method__uiSetDim" class="method item private inherited"> |
|
18328 <h3 class="name"><code>_uiSetDim</code></h3> |
|
18329 |
|
18330 |
|
18331 <div class="args"> |
|
18332 <span class="paren">(</span><ul class="args-list inline commas"> |
|
18333 |
|
18334 <li class="arg"> |
|
18335 |
|
18336 <code>dim</code> |
|
18337 |
|
18338 </li> |
|
18339 |
|
18340 <li class="arg"> |
|
18341 |
|
18342 <code>val</code> |
|
18343 |
|
18344 </li> |
|
18345 |
|
18346 </ul><span class="paren">)</span> |
|
18347 </div> |
|
18348 |
|
18349 |
|
18350 |
|
18351 |
|
18352 |
|
18353 |
|
18354 |
|
18355 <span class="flag private">private</span> |
|
18356 |
|
18357 |
|
18358 |
|
18359 |
|
18360 |
|
18361 |
|
18362 |
|
18363 |
|
18364 |
|
18365 |
|
18366 <div class="meta"> |
|
18367 |
|
18368 |
|
18369 <p>Inherited from |
|
18370 <a href="../classes/Widget.html#method__uiSetDim">Widget</a>: |
|
18371 |
|
18372 |
|
18373 |
|
18374 <a href="../files/widget_js_Widget.js.html#l997"><code>widget/js/Widget.js:997</code></a> |
|
18375 |
|
18376 </p> |
|
18377 |
|
18378 |
|
18379 |
|
18380 |
|
18381 |
|
18382 </div> |
|
18383 |
|
18384 <div class="description"> |
|
18385 |
|
18386 </div> |
|
18387 |
|
18388 |
|
18389 <div class="params"> |
|
18390 <h4>Parameters:</h4> |
|
18391 |
|
18392 <ul class="params-list"> |
|
18393 |
|
18394 <li class="param"> |
|
18395 |
|
18396 <code class="param-name">dim</code> |
|
18397 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18398 |
|
18399 |
|
18400 |
|
18401 |
|
18402 <div class="param-description"> |
|
18403 <p>The dimension - "width" or "height"</p> |
|
18404 </div> |
|
18405 |
|
18406 |
|
18407 </li> |
|
18408 |
|
18409 <li class="param"> |
|
18410 |
|
18411 <code class="param-name">val</code> |
|
18412 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18413 |
|
18414 |
|
18415 |
|
18416 |
|
18417 <div class="param-description"> |
|
18418 <p>The value to set</p> |
|
18419 </div> |
|
18420 |
|
18421 |
|
18422 </li> |
|
18423 |
|
18424 </ul> |
|
18425 </div> |
|
18426 |
|
18427 |
|
18428 |
|
18429 |
|
18430 |
|
18431 </div> |
|
18432 |
|
18433 |
|
18434 <div id="method__uiSetDisabled" class="method item protected inherited"> |
|
18435 <h3 class="name"><code>_uiSetDisabled</code></h3> |
|
18436 |
|
18437 |
|
18438 <div class="args"> |
|
18439 <span class="paren">(</span><ul class="args-list inline commas"> |
|
18440 |
|
18441 <li class="arg"> |
|
18442 |
|
18443 <code>val</code> |
|
18444 |
|
18445 </li> |
|
18446 |
|
18447 </ul><span class="paren">)</span> |
|
18448 </div> |
|
18449 |
|
18450 |
|
18451 |
|
18452 |
|
18453 |
|
18454 |
|
18455 |
|
18456 <span class="flag protected">protected</span> |
|
18457 |
|
18458 |
|
18459 |
|
18460 |
|
18461 |
|
18462 |
|
18463 |
|
18464 |
|
18465 |
|
18466 |
|
18467 <div class="meta"> |
|
18468 |
|
18469 |
|
18470 <p>Inherited from |
|
18471 <a href="../classes/Widget.html#method__uiSetDisabled">Widget</a>: |
|
18472 |
|
18473 |
|
18474 |
|
18475 <a href="../files/widget_js_Widget.js.html#l1018"><code>widget/js/Widget.js:1018</code></a> |
|
18476 |
|
18477 </p> |
|
18478 |
|
18479 |
|
18480 |
|
18481 |
|
18482 |
|
18483 </div> |
|
18484 |
|
18485 <div class="description"> |
|
18486 <p>Sets the disabled state for the UI</p> |
|
18487 </div> |
|
18488 |
|
18489 |
|
18490 <div class="params"> |
|
18491 <h4>Parameters:</h4> |
|
18492 |
|
18493 <ul class="params-list"> |
|
18494 |
|
18495 <li class="param"> |
|
18496 |
|
18497 <code class="param-name">val</code> |
|
18498 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
18499 |
|
18500 |
|
18501 |
|
18502 |
|
18503 <div class="param-description"> |
|
18504 |
|
18505 </div> |
|
18506 |
|
18507 |
|
18508 </li> |
|
18509 |
|
18510 </ul> |
|
18511 </div> |
|
18512 |
|
18513 |
|
18514 |
|
18515 |
|
18516 |
|
18517 </div> |
|
18518 |
|
18519 |
|
18520 <div id="method__uiSetFocused" class="method item protected inherited"> |
|
18521 <h3 class="name"><code>_uiSetFocused</code></h3> |
|
18522 |
|
18523 |
|
18524 <div class="args"> |
|
18525 <span class="paren">(</span><ul class="args-list inline commas"> |
|
18526 |
|
18527 <li class="arg"> |
|
18528 |
|
18529 <code>val</code> |
|
18530 |
|
18531 </li> |
|
18532 |
|
18533 <li class="arg"> |
|
18534 |
|
18535 <code>src</code> |
|
18536 |
|
18537 </li> |
|
18538 |
|
18539 </ul><span class="paren">)</span> |
|
18540 </div> |
|
18541 |
|
18542 |
|
18543 |
|
18544 |
|
18545 |
|
18546 |
|
18547 |
|
18548 <span class="flag protected">protected</span> |
|
18549 |
|
18550 |
|
18551 |
|
18552 |
|
18553 |
|
18554 |
|
18555 |
|
18556 |
|
18557 |
|
18558 |
|
18559 <div class="meta"> |
|
18560 |
|
18561 |
|
18562 <p>Inherited from |
|
18563 <a href="../classes/Widget.html#method__uiSetFocused">Widget</a>: |
|
18564 |
|
18565 |
|
18566 |
|
18567 <a href="../files/widget_js_Widget.js.html#l1029"><code>widget/js/Widget.js:1029</code></a> |
|
18568 |
|
18569 </p> |
|
18570 |
|
18571 |
|
18572 |
|
18573 |
|
18574 |
|
18575 </div> |
|
18576 |
|
18577 <div class="description"> |
|
18578 <p>Sets the focused state for the UI</p> |
|
18579 </div> |
|
18580 |
|
18581 |
|
18582 <div class="params"> |
|
18583 <h4>Parameters:</h4> |
|
18584 |
|
18585 <ul class="params-list"> |
|
18586 |
|
18587 <li class="param"> |
|
18588 |
|
18589 <code class="param-name">val</code> |
|
18590 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
18591 |
|
18592 |
|
18593 |
|
18594 |
|
18595 <div class="param-description"> |
|
18596 |
|
18597 </div> |
|
18598 |
|
18599 |
|
18600 </li> |
|
18601 |
|
18602 <li class="param"> |
|
18603 |
|
18604 <code class="param-name">src</code> |
|
18605 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18606 |
|
18607 |
|
18608 |
|
18609 |
|
18610 <div class="param-description"> |
|
18611 <p>String representing the source that triggered an update to |
|
18612 the UI.</p> |
|
18613 </div> |
|
18614 |
|
18615 |
|
18616 </li> |
|
18617 |
|
18618 </ul> |
|
18619 </div> |
|
18620 |
|
18621 |
|
18622 |
|
18623 |
|
18624 |
|
18625 </div> |
|
18626 |
|
18627 |
|
18628 <div id="method__uiSetHeight" class="method item protected inherited"> |
|
18629 <h3 class="name"><code>_uiSetHeight</code></h3> |
|
18630 |
|
18631 |
|
18632 <div class="args"> |
|
18633 <span class="paren">(</span><ul class="args-list inline commas"> |
|
18634 |
|
18635 <li class="arg"> |
|
18636 |
|
18637 <code>val</code> |
|
18638 |
|
18639 </li> |
|
18640 |
|
18641 </ul><span class="paren">)</span> |
|
18642 </div> |
|
18643 |
|
18644 |
|
18645 |
|
18646 |
|
18647 |
|
18648 |
|
18649 |
|
18650 <span class="flag protected">protected</span> |
|
18651 |
|
18652 |
|
18653 |
|
18654 |
|
18655 |
|
18656 |
|
18657 |
|
18658 |
|
18659 |
|
18660 |
|
18661 <div class="meta"> |
|
18662 |
|
18663 |
|
18664 <p>Inherited from |
|
18665 <a href="../classes/Widget.html#method__uiSetHeight">Widget</a>: |
|
18666 |
|
18667 |
|
18668 |
|
18669 <a href="../files/widget_js_Widget.js.html#l974"><code>widget/js/Widget.js:974</code></a> |
|
18670 |
|
18671 </p> |
|
18672 |
|
18673 |
|
18674 |
|
18675 |
|
18676 |
|
18677 </div> |
|
18678 |
|
18679 <div class="description"> |
|
18680 <p>Sets the height on the widget's bounding box element</p> |
|
18681 </div> |
|
18682 |
|
18683 |
|
18684 <div class="params"> |
|
18685 <h4>Parameters:</h4> |
|
18686 |
|
18687 <ul class="params-list"> |
|
18688 |
|
18689 <li class="param"> |
|
18690 |
|
18691 <code class="param-name">val</code> |
|
18692 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
18693 |
|
18694 |
|
18695 |
|
18696 |
|
18697 <div class="param-description"> |
|
18698 |
|
18699 </div> |
|
18700 |
|
18701 |
|
18702 </li> |
|
18703 |
|
18704 </ul> |
|
18705 </div> |
|
18706 |
|
18707 |
|
18708 |
|
18709 |
|
18710 |
|
18711 </div> |
|
18712 |
|
18713 |
|
18714 <div id="method__uiSetMessage" class="method item protected"> |
|
18715 <h3 class="name"><code>_uiSetMessage</code></h3> |
|
18716 |
|
18717 |
|
18718 <div class="args"> |
|
18719 <span class="paren">(</span><ul class="args-list inline commas"> |
|
18720 |
|
18721 <li class="arg"> |
|
18722 |
|
18723 <code>e</code> |
|
18724 |
|
18725 </li> |
|
18726 |
|
18727 </ul><span class="paren">)</span> |
|
18728 </div> |
|
18729 |
|
18730 |
|
18731 |
|
18732 |
|
18733 |
|
18734 |
|
18735 |
|
18736 <span class="flag protected">protected</span> |
|
18737 |
|
18738 |
|
18739 |
|
18740 |
|
18741 |
|
18742 |
|
18743 |
|
18744 |
|
18745 |
|
18746 |
|
18747 <div class="meta"> |
|
18748 |
|
18749 |
|
18750 |
|
18751 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
18752 |
|
18753 <p> |
|
18754 |
|
18755 Defined in |
|
18756 |
|
18757 |
|
18758 |
|
18759 |
|
18760 <a href="../files/datatable_js_message.js.html#l258"><code>datatable/js/message.js:258</code></a> |
|
18761 |
|
18762 </p> |
|
18763 |
|
18764 |
|
18765 |
|
18766 |
|
18767 |
|
18768 <p>Available since 3.5.0</p> |
|
18769 |
|
18770 </div> |
|
18771 |
|
18772 <div class="description"> |
|
18773 <p>Calls <code>hideMessage</code> or <code>showMessage</code> as appropriate based on the presence of |
|
18774 records in the <code>data</code> ModelList.</p> |
|
18775 |
|
18776 <p>This is called when <code>data</code> is reset or records are added or removed. Also, |
|
18777 if the <code>showMessages</code> attribute is updated. In either case, if the |
|
18778 triggering event has a <code>message</code> property on the EventFacade, it will be |
|
18779 passed to <code>showMessage</code> (if appropriate). If no such property is on the |
|
18780 facade, the <code>emptyMessage</code> will be used (see the strings).</p> |
|
18781 </div> |
|
18782 |
|
18783 |
|
18784 <div class="params"> |
|
18785 <h4>Parameters:</h4> |
|
18786 |
|
18787 <ul class="params-list"> |
|
18788 |
|
18789 <li class="param"> |
|
18790 |
|
18791 <code class="param-name">e</code> |
|
18792 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
18793 |
|
18794 |
|
18795 |
|
18796 |
|
18797 <div class="param-description"> |
|
18798 <p>The columnsChange event</p> |
|
18799 </div> |
|
18800 |
|
18801 |
|
18802 </li> |
|
18803 |
|
18804 </ul> |
|
18805 </div> |
|
18806 |
|
18807 |
|
18808 |
|
18809 |
|
18810 |
|
18811 </div> |
|
18812 |
|
18813 |
|
18814 <div id="method__uiSetScrollable" class="method item protected"> |
|
18815 <h3 class="name"><code>_uiSetScrollable</code></h3> |
|
18816 |
|
18817 |
|
18818 <span class="paren">()</span> |
|
18819 |
|
18820 |
|
18821 |
|
18822 |
|
18823 |
|
18824 |
|
18825 |
|
18826 <span class="flag protected">protected</span> |
|
18827 |
|
18828 |
|
18829 |
|
18830 |
|
18831 |
|
18832 |
|
18833 |
|
18834 |
|
18835 |
|
18836 |
|
18837 <div class="meta"> |
|
18838 |
|
18839 |
|
18840 |
|
18841 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
18842 |
|
18843 <p> |
|
18844 |
|
18845 Defined in |
|
18846 |
|
18847 |
|
18848 |
|
18849 |
|
18850 <a href="../files/datatable_js_scroll.js.html#l1164"><code>datatable/js/scroll.js:1164</code></a> |
|
18851 |
|
18852 </p> |
|
18853 |
|
18854 |
|
18855 |
|
18856 |
|
18857 |
|
18858 <p>Available since 3.5.0</p> |
|
18859 |
|
18860 </div> |
|
18861 |
|
18862 <div class="description"> |
|
18863 <p>Assigns the appropriate class to the <code>boundingBox</code> to identify the DataTable |
|
18864 as horizontally scrolling, vertically scrolling, or both (adds both classes).</p> |
|
18865 |
|
18866 <p>Classes added are "yui3-datatable-scrollable-x" or "...-y"</p> |
|
18867 </div> |
|
18868 |
|
18869 |
|
18870 |
|
18871 |
|
18872 |
|
18873 |
|
18874 </div> |
|
18875 |
|
18876 |
|
18877 <div id="method__uiSetScrollbarHeight" class="method item protected"> |
|
18878 <h3 class="name"><code>_uiSetScrollbarHeight</code></h3> |
|
18879 |
|
18880 |
|
18881 <span class="paren">()</span> |
|
18882 |
|
18883 |
|
18884 |
|
18885 |
|
18886 |
|
18887 |
|
18888 |
|
18889 <span class="flag protected">protected</span> |
|
18890 |
|
18891 |
|
18892 |
|
18893 |
|
18894 |
|
18895 |
|
18896 |
|
18897 |
|
18898 |
|
18899 |
|
18900 <div class="meta"> |
|
18901 |
|
18902 |
|
18903 |
|
18904 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
18905 |
|
18906 <p> |
|
18907 |
|
18908 Defined in |
|
18909 |
|
18910 |
|
18911 |
|
18912 |
|
18913 <a href="../files/datatable_js_scroll.js.html#l1180"><code>datatable/js/scroll.js:1180</code></a> |
|
18914 |
|
18915 </p> |
|
18916 |
|
18917 |
|
18918 |
|
18919 |
|
18920 |
|
18921 <p>Available since 3.5.0</p> |
|
18922 |
|
18923 </div> |
|
18924 |
|
18925 <div class="description"> |
|
18926 <p>Updates the virtual scrollbar's height to avoid overlapping with the fixed |
|
18927 headers.</p> |
|
18928 </div> |
|
18929 |
|
18930 |
|
18931 |
|
18932 |
|
18933 |
|
18934 |
|
18935 </div> |
|
18936 |
|
18937 |
|
18938 <div id="method__uiSetScrollbarPosition" class="method item protected"> |
|
18939 <h3 class="name"><code>_uiSetScrollbarPosition</code></h3> |
|
18940 |
|
18941 |
|
18942 <div class="args"> |
|
18943 <span class="paren">(</span><ul class="args-list inline commas"> |
|
18944 |
|
18945 <li class="arg"> |
|
18946 |
|
18947 <code>scroller</code> |
|
18948 |
|
18949 </li> |
|
18950 |
|
18951 </ul><span class="paren">)</span> |
|
18952 </div> |
|
18953 |
|
18954 |
|
18955 |
|
18956 |
|
18957 |
|
18958 |
|
18959 |
|
18960 <span class="flag protected">protected</span> |
|
18961 |
|
18962 |
|
18963 |
|
18964 |
|
18965 |
|
18966 |
|
18967 |
|
18968 |
|
18969 |
|
18970 |
|
18971 <div class="meta"> |
|
18972 |
|
18973 |
|
18974 |
|
18975 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
18976 |
|
18977 <p> |
|
18978 |
|
18979 Defined in |
|
18980 |
|
18981 |
|
18982 |
|
18983 |
|
18984 <a href="../files/datatable_js_scroll.js.html#l1203"><code>datatable/js/scroll.js:1203</code></a> |
|
18985 |
|
18986 </p> |
|
18987 |
|
18988 |
|
18989 |
|
18990 |
|
18991 |
|
18992 <p>Available since 3.5.0</p> |
|
18993 |
|
18994 </div> |
|
18995 |
|
18996 <div class="description"> |
|
18997 <p>Updates the virtual scrollbar's placement to avoid overlapping the fixed |
|
18998 headers or the data table.</p> |
|
18999 </div> |
|
19000 |
|
19001 |
|
19002 <div class="params"> |
|
19003 <h4>Parameters:</h4> |
|
19004 |
|
19005 <ul class="params-list"> |
|
19006 |
|
19007 <li class="param"> |
|
19008 |
|
19009 <code class="param-name">scroller</code> |
|
19010 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
19011 |
|
19012 |
|
19013 |
|
19014 |
|
19015 <div class="param-description"> |
|
19016 <p>Reference node to position the scrollbar over</p> |
|
19017 </div> |
|
19018 |
|
19019 |
|
19020 </li> |
|
19021 |
|
19022 </ul> |
|
19023 </div> |
|
19024 |
|
19025 |
|
19026 |
|
19027 |
|
19028 |
|
19029 </div> |
|
19030 |
|
19031 |
|
19032 <div id="method__uiSetSortable" class="method item protected"> |
|
19033 <h3 class="name"><code>_uiSetSortable</code></h3> |
|
19034 |
|
19035 |
|
19036 <span class="paren">()</span> |
|
19037 |
|
19038 |
|
19039 |
|
19040 |
|
19041 |
|
19042 |
|
19043 |
|
19044 <span class="flag protected">protected</span> |
|
19045 |
|
19046 |
|
19047 |
|
19048 |
|
19049 |
|
19050 |
|
19051 |
|
19052 |
|
19053 |
|
19054 |
|
19055 <div class="meta"> |
|
19056 |
|
19057 |
|
19058 |
|
19059 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
19060 |
|
19061 <p> |
|
19062 |
|
19063 Defined in |
|
19064 |
|
19065 |
|
19066 |
|
19067 |
|
19068 <a href="../files/datatable_js_sort.js.html#l756"><code>datatable/js/sort.js:756</code></a> |
|
19069 |
|
19070 </p> |
|
19071 |
|
19072 |
|
19073 |
|
19074 |
|
19075 |
|
19076 <p>Available since 3.5.0</p> |
|
19077 |
|
19078 </div> |
|
19079 |
|
19080 <div class="description"> |
|
19081 <p>Applies the appropriate classes to the <code>boundingBox</code> and column headers to |
|
19082 indicate sort state and sortability.</p> |
|
19083 |
|
19084 <p>Also currently wraps the header content of sortable columns in a <code><div></code> |
|
19085 liner to give a CSS anchor for sort indicators.</p> |
|
19086 </div> |
|
19087 |
|
19088 |
|
19089 |
|
19090 |
|
19091 |
|
19092 |
|
19093 </div> |
|
19094 |
|
19095 |
|
19096 <div id="method__uiSetTabIndex" class="method item protected inherited"> |
|
19097 <h3 class="name"><code>_uiSetTabIndex</code></h3> |
|
19098 |
|
19099 |
|
19100 <div class="args"> |
|
19101 <span class="paren">(</span><ul class="args-list inline commas"> |
|
19102 |
|
19103 <li class="arg"> |
|
19104 |
|
19105 <code>Number</code> |
|
19106 |
|
19107 </li> |
|
19108 |
|
19109 </ul><span class="paren">)</span> |
|
19110 </div> |
|
19111 |
|
19112 |
|
19113 |
|
19114 |
|
19115 |
|
19116 |
|
19117 |
|
19118 <span class="flag protected">protected</span> |
|
19119 |
|
19120 |
|
19121 |
|
19122 |
|
19123 |
|
19124 |
|
19125 |
|
19126 |
|
19127 |
|
19128 |
|
19129 <div class="meta"> |
|
19130 |
|
19131 |
|
19132 <p>Inherited from |
|
19133 <a href="../classes/Widget.html#method__uiSetTabIndex">Widget</a>: |
|
19134 |
|
19135 |
|
19136 |
|
19137 <a href="../files/widget_js_Widget.js.html#l1051"><code>widget/js/Widget.js:1051</code></a> |
|
19138 |
|
19139 </p> |
|
19140 |
|
19141 |
|
19142 |
|
19143 |
|
19144 |
|
19145 </div> |
|
19146 |
|
19147 <div class="description"> |
|
19148 <p>Set the tabIndex on the widget's rendered UI</p> |
|
19149 </div> |
|
19150 |
|
19151 |
|
19152 <div class="params"> |
|
19153 <h4>Parameters:</h4> |
|
19154 |
|
19155 <ul class="params-list"> |
|
19156 |
|
19157 <li class="param"> |
|
19158 |
|
19159 <code class="param-name">Number</code> |
|
19160 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
19161 |
|
19162 |
|
19163 |
|
19164 |
|
19165 <div class="param-description"> |
|
19166 |
|
19167 </div> |
|
19168 |
|
19169 |
|
19170 </li> |
|
19171 |
|
19172 </ul> |
|
19173 </div> |
|
19174 |
|
19175 |
|
19176 |
|
19177 |
|
19178 |
|
19179 </div> |
|
19180 |
|
19181 |
|
19182 <div id="method__uiSetVisible" class="method item protected inherited"> |
|
19183 <h3 class="name"><code>_uiSetVisible</code></h3> |
|
19184 |
|
19185 |
|
19186 <div class="args"> |
|
19187 <span class="paren">(</span><ul class="args-list inline commas"> |
|
19188 |
|
19189 <li class="arg"> |
|
19190 |
|
19191 <code>val</code> |
|
19192 |
|
19193 </li> |
|
19194 |
|
19195 </ul><span class="paren">)</span> |
|
19196 </div> |
|
19197 |
|
19198 |
|
19199 |
|
19200 |
|
19201 |
|
19202 |
|
19203 |
|
19204 <span class="flag protected">protected</span> |
|
19205 |
|
19206 |
|
19207 |
|
19208 |
|
19209 |
|
19210 |
|
19211 |
|
19212 |
|
19213 |
|
19214 |
|
19215 <div class="meta"> |
|
19216 |
|
19217 |
|
19218 <p>Inherited from |
|
19219 <a href="../classes/Widget.html#method__uiSetVisible">Widget</a>: |
|
19220 |
|
19221 |
|
19222 |
|
19223 <a href="../files/widget_js_Widget.js.html#l1007"><code>widget/js/Widget.js:1007</code></a> |
|
19224 |
|
19225 </p> |
|
19226 |
|
19227 |
|
19228 |
|
19229 |
|
19230 |
|
19231 </div> |
|
19232 |
|
19233 <div class="description"> |
|
19234 <p>Sets the visible state for the UI</p> |
|
19235 </div> |
|
19236 |
|
19237 |
|
19238 <div class="params"> |
|
19239 <h4>Parameters:</h4> |
|
19240 |
|
19241 <ul class="params-list"> |
|
19242 |
|
19243 <li class="param"> |
|
19244 |
|
19245 <code class="param-name">val</code> |
|
19246 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
19247 |
|
19248 |
|
19249 |
|
19250 |
|
19251 <div class="param-description"> |
|
19252 |
|
19253 </div> |
|
19254 |
|
19255 |
|
19256 </li> |
|
19257 |
|
19258 </ul> |
|
19259 </div> |
|
19260 |
|
19261 |
|
19262 |
|
19263 |
|
19264 |
|
19265 </div> |
|
19266 |
|
19267 |
|
19268 <div id="method__uiSetWidth" class="method item protected inherited"> |
|
19269 <h3 class="name"><code>_uiSetWidth</code></h3> |
|
19270 |
|
19271 |
|
19272 <div class="args"> |
|
19273 <span class="paren">(</span><ul class="args-list inline commas"> |
|
19274 |
|
19275 <li class="arg"> |
|
19276 |
|
19277 <code>val</code> |
|
19278 |
|
19279 </li> |
|
19280 |
|
19281 </ul><span class="paren">)</span> |
|
19282 </div> |
|
19283 |
|
19284 |
|
19285 |
|
19286 |
|
19287 |
|
19288 |
|
19289 |
|
19290 <span class="flag protected">protected</span> |
|
19291 |
|
19292 |
|
19293 |
|
19294 |
|
19295 |
|
19296 |
|
19297 |
|
19298 |
|
19299 |
|
19300 |
|
19301 <div class="meta"> |
|
19302 |
|
19303 |
|
19304 <p>Inherited from |
|
19305 <a href="../classes/Widget.html#method__uiSetWidth">Widget</a>: |
|
19306 |
|
19307 |
|
19308 |
|
19309 <a href="../files/widget_js_Widget.js.html#l986"><code>widget/js/Widget.js:986</code></a> |
|
19310 |
|
19311 </p> |
|
19312 |
|
19313 |
|
19314 |
|
19315 |
|
19316 |
|
19317 </div> |
|
19318 |
|
19319 <div class="description"> |
|
19320 <p>Sets the width on the widget's bounding box element</p> |
|
19321 </div> |
|
19322 |
|
19323 |
|
19324 <div class="params"> |
|
19325 <h4>Parameters:</h4> |
|
19326 |
|
19327 <ul class="params-list"> |
|
19328 |
|
19329 <li class="param"> |
|
19330 |
|
19331 <code class="param-name">val</code> |
|
19332 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
19333 |
|
19334 |
|
19335 |
|
19336 |
|
19337 <div class="param-description"> |
|
19338 |
|
19339 </div> |
|
19340 |
|
19341 |
|
19342 </li> |
|
19343 |
|
19344 </ul> |
|
19345 </div> |
|
19346 |
|
19347 |
|
19348 |
|
19349 |
|
19350 |
|
19351 </div> |
|
19352 |
|
19353 |
|
19354 <div id="method__uiSetYScrollWidth" class="method item protected"> |
|
19355 <h3 class="name"><code>_uiSetYScrollWidth</code></h3> |
|
19356 |
|
19357 |
|
19358 <div class="args"> |
|
19359 <span class="paren">(</span><ul class="args-list inline commas"> |
|
19360 |
|
19361 <li class="arg"> |
|
19362 |
|
19363 <code>width</code> |
|
19364 |
|
19365 </li> |
|
19366 |
|
19367 </ul><span class="paren">)</span> |
|
19368 </div> |
|
19369 |
|
19370 |
|
19371 |
|
19372 |
|
19373 |
|
19374 |
|
19375 |
|
19376 <span class="flag protected">protected</span> |
|
19377 |
|
19378 |
|
19379 |
|
19380 |
|
19381 |
|
19382 |
|
19383 |
|
19384 |
|
19385 |
|
19386 |
|
19387 <div class="meta"> |
|
19388 |
|
19389 |
|
19390 |
|
19391 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
19392 |
|
19393 <p> |
|
19394 |
|
19395 Defined in |
|
19396 |
|
19397 |
|
19398 |
|
19399 |
|
19400 <a href="../files/datatable_js_scroll.js.html#l1238"><code>datatable/js/scroll.js:1238</code></a> |
|
19401 |
|
19402 </p> |
|
19403 |
|
19404 |
|
19405 |
|
19406 |
|
19407 |
|
19408 <p>Available since 3.5.0</p> |
|
19409 |
|
19410 </div> |
|
19411 |
|
19412 <div class="description"> |
|
19413 <p>Assigns the width of the <code><div></code> wrapping the data table in vertically |
|
19414 scrolling tables.</p> |
|
19415 |
|
19416 <p>If the table can't compress to the specified width, the container is |
|
19417 expanded accordingly.</p> |
|
19418 </div> |
|
19419 |
|
19420 |
|
19421 <div class="params"> |
|
19422 <h4>Parameters:</h4> |
|
19423 |
|
19424 <ul class="params-list"> |
|
19425 |
|
19426 <li class="param"> |
|
19427 |
|
19428 <code class="param-name">width</code> |
|
19429 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19430 |
|
19431 |
|
19432 |
|
19433 |
|
19434 <div class="param-description"> |
|
19435 <p>The CSS width to attempt to set</p> |
|
19436 </div> |
|
19437 |
|
19438 |
|
19439 </li> |
|
19440 |
|
19441 </ul> |
|
19442 </div> |
|
19443 |
|
19444 |
|
19445 |
|
19446 |
|
19447 |
|
19448 </div> |
|
19449 |
|
19450 |
|
19451 <div id="method__uiSizeCB" class="method item protected inherited"> |
|
19452 <h3 class="name"><code>_uiSizeCB</code></h3> |
|
19453 |
|
19454 |
|
19455 <div class="args"> |
|
19456 <span class="paren">(</span><ul class="args-list inline commas"> |
|
19457 |
|
19458 <li class="arg"> |
|
19459 |
|
19460 <code>expand</code> |
|
19461 |
|
19462 </li> |
|
19463 |
|
19464 </ul><span class="paren">)</span> |
|
19465 </div> |
|
19466 |
|
19467 |
|
19468 |
|
19469 |
|
19470 |
|
19471 |
|
19472 |
|
19473 <span class="flag protected">protected</span> |
|
19474 |
|
19475 |
|
19476 |
|
19477 |
|
19478 |
|
19479 |
|
19480 |
|
19481 |
|
19482 |
|
19483 |
|
19484 <div class="meta"> |
|
19485 |
|
19486 |
|
19487 <p>Inherited from |
|
19488 <a href="../classes/Widget.html#method__uiSizeCB">Widget</a>: |
|
19489 |
|
19490 |
|
19491 |
|
19492 <a href="../files/widget_js_Widget.js.html#l701"><code>widget/js/Widget.js:701</code></a> |
|
19493 |
|
19494 </p> |
|
19495 |
|
19496 |
|
19497 |
|
19498 |
|
19499 |
|
19500 </div> |
|
19501 |
|
19502 <div class="description"> |
|
19503 |
|
19504 </div> |
|
19505 |
|
19506 |
|
19507 <div class="params"> |
|
19508 <h4>Parameters:</h4> |
|
19509 |
|
19510 <ul class="params-list"> |
|
19511 |
|
19512 <li class="param"> |
|
19513 |
|
19514 <code class="param-name">expand</code> |
|
19515 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
19516 |
|
19517 |
|
19518 |
|
19519 |
|
19520 <div class="param-description"> |
|
19521 |
|
19522 </div> |
|
19523 |
|
19524 |
|
19525 </li> |
|
19526 |
|
19527 </ul> |
|
19528 </div> |
|
19529 |
|
19530 |
|
19531 |
|
19532 |
|
19533 |
|
19534 </div> |
|
19535 |
|
19536 |
|
19537 <div id="method__unbindDOM" class="method item protected inherited"> |
|
19538 <h3 class="name"><code>_unbindDOM</code></h3> |
|
19539 |
|
19540 |
|
19541 <span class="paren">()</span> |
|
19542 |
|
19543 |
|
19544 |
|
19545 |
|
19546 |
|
19547 |
|
19548 |
|
19549 <span class="flag protected">protected</span> |
|
19550 |
|
19551 |
|
19552 |
|
19553 |
|
19554 |
|
19555 |
|
19556 |
|
19557 |
|
19558 |
|
19559 |
|
19560 <div class="meta"> |
|
19561 |
|
19562 |
|
19563 <p>Inherited from |
|
19564 <a href="../classes/Widget.html#method__unbindDOM">Widget</a>: |
|
19565 |
|
19566 |
|
19567 |
|
19568 <a href="../files/widget_js_Widget.js.html#l933"><code>widget/js/Widget.js:933</code></a> |
|
19569 |
|
19570 </p> |
|
19571 |
|
19572 |
|
19573 |
|
19574 |
|
19575 |
|
19576 </div> |
|
19577 |
|
19578 <div class="description"> |
|
19579 |
|
19580 </div> |
|
19581 |
|
19582 |
|
19583 |
|
19584 |
|
19585 |
|
19586 |
|
19587 </div> |
|
19588 |
|
19589 |
|
19590 <div id="method__unbindScrollbar" class="method item protected"> |
|
19591 <h3 class="name"><code>_unbindScrollbar</code></h3> |
|
19592 |
|
19593 |
|
19594 <span class="paren">()</span> |
|
19595 |
|
19596 |
|
19597 |
|
19598 |
|
19599 |
|
19600 |
|
19601 |
|
19602 <span class="flag protected">protected</span> |
|
19603 |
|
19604 |
|
19605 |
|
19606 |
|
19607 |
|
19608 |
|
19609 |
|
19610 |
|
19611 |
|
19612 |
|
19613 <div class="meta"> |
|
19614 |
|
19615 |
|
19616 |
|
19617 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
19618 |
|
19619 <p> |
|
19620 |
|
19621 Defined in |
|
19622 |
|
19623 |
|
19624 |
|
19625 |
|
19626 <a href="../files/datatable_js_scroll.js.html#l1294"><code>datatable/js/scroll.js:1294</code></a> |
|
19627 |
|
19628 </p> |
|
19629 |
|
19630 |
|
19631 |
|
19632 |
|
19633 |
|
19634 <p>Available since 3.5.0</p> |
|
19635 |
|
19636 </div> |
|
19637 |
|
19638 <div class="description"> |
|
19639 <p>Detaches the scroll event subscriptions used to maintain scroll position |
|
19640 parity between the scrollable <code><div></code> wrapper around the data table and the |
|
19641 virtual scrollbar for vertically scrolling tables.</p> |
|
19642 </div> |
|
19643 |
|
19644 |
|
19645 |
|
19646 |
|
19647 |
|
19648 |
|
19649 </div> |
|
19650 |
|
19651 |
|
19652 <div id="method__unbindScrollResize" class="method item protected"> |
|
19653 <h3 class="name"><code>_unbindScrollResize</code></h3> |
|
19654 |
|
19655 |
|
19656 <span class="paren">()</span> |
|
19657 |
|
19658 |
|
19659 |
|
19660 |
|
19661 |
|
19662 |
|
19663 |
|
19664 <span class="flag protected">protected</span> |
|
19665 |
|
19666 |
|
19667 |
|
19668 |
|
19669 |
|
19670 |
|
19671 |
|
19672 |
|
19673 |
|
19674 |
|
19675 <div class="meta"> |
|
19676 |
|
19677 |
|
19678 |
|
19679 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
19680 |
|
19681 <p> |
|
19682 |
|
19683 Defined in |
|
19684 |
|
19685 |
|
19686 |
|
19687 |
|
19688 <a href="../files/datatable_js_scroll.js.html#l1309"><code>datatable/js/scroll.js:1309</code></a> |
|
19689 |
|
19690 </p> |
|
19691 |
|
19692 |
|
19693 |
|
19694 |
|
19695 |
|
19696 <p>Available since 3.5.0</p> |
|
19697 |
|
19698 </div> |
|
19699 |
|
19700 <div class="description"> |
|
19701 <p>Detaches the resize event subscription used to maintain column parity for |
|
19702 vertically scrolling tables with percentage widths.</p> |
|
19703 </div> |
|
19704 |
|
19705 |
|
19706 |
|
19707 |
|
19708 |
|
19709 |
|
19710 </div> |
|
19711 |
|
19712 |
|
19713 <div id="method__unbindUI" class="method item protected inherited"> |
|
19714 <h3 class="name"><code>_unbindUI</code></h3> |
|
19715 |
|
19716 |
|
19717 <span class="paren">()</span> |
|
19718 |
|
19719 |
|
19720 |
|
19721 |
|
19722 |
|
19723 |
|
19724 |
|
19725 <span class="flag protected">protected</span> |
|
19726 |
|
19727 |
|
19728 |
|
19729 |
|
19730 |
|
19731 |
|
19732 |
|
19733 |
|
19734 |
|
19735 |
|
19736 <div class="meta"> |
|
19737 |
|
19738 |
|
19739 <p>Inherited from |
|
19740 <a href="../classes/Widget.html#method__unbindUI">Widget</a>: |
|
19741 |
|
19742 |
|
19743 |
|
19744 <a href="../files/widget_js_Widget.js.html#l894"><code>widget/js/Widget.js:894</code></a> |
|
19745 |
|
19746 </p> |
|
19747 |
|
19748 |
|
19749 |
|
19750 |
|
19751 |
|
19752 </div> |
|
19753 |
|
19754 <div class="description"> |
|
19755 |
|
19756 </div> |
|
19757 |
|
19758 |
|
19759 |
|
19760 |
|
19761 |
|
19762 |
|
19763 </div> |
|
19764 |
|
19765 |
|
19766 <div id="method__validateSortable" class="method item protected"> |
|
19767 <h3 class="name"><code>_validateSortable</code></h3> |
|
19768 |
|
19769 |
|
19770 <div class="args"> |
|
19771 <span class="paren">(</span><ul class="args-list inline commas"> |
|
19772 |
|
19773 <li class="arg"> |
|
19774 |
|
19775 <code>val</code> |
|
19776 |
|
19777 </li> |
|
19778 |
|
19779 </ul><span class="paren">)</span> |
|
19780 </div> |
|
19781 |
|
19782 |
|
19783 |
|
19784 <span class="returns-inline"> |
|
19785 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
19786 </span> |
|
19787 |
|
19788 |
|
19789 |
|
19790 |
|
19791 |
|
19792 <span class="flag protected">protected</span> |
|
19793 |
|
19794 |
|
19795 |
|
19796 |
|
19797 |
|
19798 |
|
19799 |
|
19800 |
|
19801 |
|
19802 |
|
19803 <div class="meta"> |
|
19804 |
|
19805 |
|
19806 |
|
19807 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
19808 |
|
19809 <p> |
|
19810 |
|
19811 Defined in |
|
19812 |
|
19813 |
|
19814 |
|
19815 |
|
19816 <a href="../files/datatable_js_sort.js.html#l858"><code>datatable/js/sort.js:858</code></a> |
|
19817 |
|
19818 </p> |
|
19819 |
|
19820 |
|
19821 |
|
19822 |
|
19823 |
|
19824 <p>Available since 3.5.0</p> |
|
19825 |
|
19826 </div> |
|
19827 |
|
19828 <div class="description"> |
|
19829 <p>Allows values <code>true</code>, <code>false</code>, "auto", or arrays of column names through.</p> |
|
19830 </div> |
|
19831 |
|
19832 |
|
19833 <div class="params"> |
|
19834 <h4>Parameters:</h4> |
|
19835 |
|
19836 <ul class="params-list"> |
|
19837 |
|
19838 <li class="param"> |
|
19839 |
|
19840 <code class="param-name">val</code> |
|
19841 <span class="type">Any</span> |
|
19842 |
|
19843 |
|
19844 |
|
19845 |
|
19846 <div class="param-description"> |
|
19847 <p>The input value to <code>set("sortable", VAL)</code></p> |
|
19848 </div> |
|
19849 |
|
19850 |
|
19851 </li> |
|
19852 |
|
19853 </ul> |
|
19854 </div> |
|
19855 |
|
19856 |
|
19857 |
|
19858 <div class="returns"> |
|
19859 <h4>Returns:</h4> |
|
19860 |
|
19861 <div class="returns-description"> |
|
19862 |
|
19863 |
|
19864 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
19865 |
|
19866 |
|
19867 </div> |
|
19868 </div> |
|
19869 |
|
19870 |
|
19871 |
|
19872 </div> |
|
19873 |
|
19874 |
|
19875 <div id="method__validateSortBy" class="method item protected"> |
|
19876 <h3 class="name"><code>_validateSortBy</code></h3> |
|
19877 |
|
19878 |
|
19879 <div class="args"> |
|
19880 <span class="paren">(</span><ul class="args-list inline commas"> |
|
19881 |
|
19882 <li class="arg"> |
|
19883 |
|
19884 <code>val</code> |
|
19885 |
|
19886 </li> |
|
19887 |
|
19888 </ul><span class="paren">)</span> |
|
19889 </div> |
|
19890 |
|
19891 |
|
19892 |
|
19893 <span class="returns-inline"> |
|
19894 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
19895 </span> |
|
19896 |
|
19897 |
|
19898 |
|
19899 |
|
19900 |
|
19901 <span class="flag protected">protected</span> |
|
19902 |
|
19903 |
|
19904 |
|
19905 |
|
19906 |
|
19907 |
|
19908 |
|
19909 |
|
19910 |
|
19911 |
|
19912 <div class="meta"> |
|
19913 |
|
19914 |
|
19915 |
|
19916 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
19917 |
|
19918 <p> |
|
19919 |
|
19920 Defined in |
|
19921 |
|
19922 |
|
19923 |
|
19924 |
|
19925 <a href="../files/datatable_js_sort.js.html#l871"><code>datatable/js/sort.js:871</code></a> |
|
19926 |
|
19927 </p> |
|
19928 |
|
19929 |
|
19930 |
|
19931 |
|
19932 |
|
19933 <p>Available since 3.5.0</p> |
|
19934 |
|
19935 </div> |
|
19936 |
|
19937 <div class="description"> |
|
19938 <p>Allows strings, arrays of strings, objects, or arrays of objects.</p> |
|
19939 </div> |
|
19940 |
|
19941 |
|
19942 <div class="params"> |
|
19943 <h4>Parameters:</h4> |
|
19944 |
|
19945 <ul class="params-list"> |
|
19946 |
|
19947 <li class="param"> |
|
19948 |
|
19949 <code class="param-name">val</code> |
|
19950 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
19951 |
|
19952 |
|
19953 |
|
19954 |
|
19955 <div class="param-description"> |
|
19956 <p>The new <code>sortBy</code> value</p> |
|
19957 </div> |
|
19958 |
|
19959 |
|
19960 </li> |
|
19961 |
|
19962 </ul> |
|
19963 </div> |
|
19964 |
|
19965 |
|
19966 |
|
19967 <div class="returns"> |
|
19968 <h4>Returns:</h4> |
|
19969 |
|
19970 <div class="returns-description"> |
|
19971 |
|
19972 |
|
19973 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
19974 |
|
19975 |
|
19976 </div> |
|
19977 </div> |
|
19978 |
|
19979 |
|
19980 |
|
19981 </div> |
|
19982 |
|
19983 |
|
19984 <div id="method__validateView" class="method item protected inherited"> |
|
19985 <h3 class="name"><code>_validateView</code></h3> |
|
19986 |
|
19987 |
|
19988 <span class="paren">()</span> |
|
19989 |
|
19990 |
|
19991 |
|
19992 |
|
19993 |
|
19994 |
|
19995 |
|
19996 <span class="flag protected">protected</span> |
|
19997 |
|
19998 |
|
19999 |
|
20000 |
|
20001 |
|
20002 |
|
20003 |
|
20004 |
|
20005 |
|
20006 |
|
20007 <div class="meta"> |
|
20008 |
|
20009 |
|
20010 <p>Inherited from |
|
20011 <a href="../classes/DataTable.Base.html#method__validateView">DataTable.Base</a>: |
|
20012 |
|
20013 |
|
20014 |
|
20015 <a href="../files/datatable_js_base.js.html#l524"><code>datatable/js/base.js:524</code></a> |
|
20016 |
|
20017 </p> |
|
20018 |
|
20019 |
|
20020 |
|
20021 |
|
20022 |
|
20023 <p>Available since 3.5.0</p> |
|
20024 |
|
20025 </div> |
|
20026 |
|
20027 <div class="description"> |
|
20028 <p>Verifies the input value is a function with a <code>render</code> method on its |
|
20029 prototype. <code>null</code> is also accepted to remove the default View.</p> |
|
20030 </div> |
|
20031 |
|
20032 |
|
20033 |
|
20034 |
|
20035 |
|
20036 |
|
20037 </div> |
|
20038 |
|
20039 |
|
20040 <div id="method__validTabIndex" class="method item protected inherited"> |
|
20041 <h3 class="name"><code>_validTabIndex</code></h3> |
|
20042 |
|
20043 |
|
20044 <div class="args"> |
|
20045 <span class="paren">(</span><ul class="args-list inline commas"> |
|
20046 |
|
20047 <li class="arg"> |
|
20048 |
|
20049 <code>tabIndex</code> |
|
20050 |
|
20051 </li> |
|
20052 |
|
20053 </ul><span class="paren">)</span> |
|
20054 </div> |
|
20055 |
|
20056 |
|
20057 |
|
20058 |
|
20059 |
|
20060 |
|
20061 |
|
20062 <span class="flag protected">protected</span> |
|
20063 |
|
20064 |
|
20065 |
|
20066 |
|
20067 |
|
20068 |
|
20069 |
|
20070 |
|
20071 |
|
20072 |
|
20073 <div class="meta"> |
|
20074 |
|
20075 |
|
20076 <p>Inherited from |
|
20077 <a href="../classes/Widget.html#method__validTabIndex">Widget</a>: |
|
20078 |
|
20079 |
|
20080 |
|
20081 <a href="../files/widget_js_Widget.js.html#l1161"><code>widget/js/Widget.js:1161</code></a> |
|
20082 |
|
20083 </p> |
|
20084 |
|
20085 |
|
20086 |
|
20087 |
|
20088 |
|
20089 </div> |
|
20090 |
|
20091 <div class="description"> |
|
20092 |
|
20093 </div> |
|
20094 |
|
20095 |
|
20096 <div class="params"> |
|
20097 <h4>Parameters:</h4> |
|
20098 |
|
20099 <ul class="params-list"> |
|
20100 |
|
20101 <li class="param"> |
|
20102 |
|
20103 <code class="param-name">tabIndex</code> |
|
20104 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
20105 |
|
20106 |
|
20107 |
|
20108 |
|
20109 <div class="param-description"> |
|
20110 |
|
20111 </div> |
|
20112 |
|
20113 |
|
20114 </li> |
|
20115 |
|
20116 </ul> |
|
20117 </div> |
|
20118 |
|
20119 |
|
20120 |
|
20121 |
|
20122 |
|
20123 </div> |
|
20124 |
|
20125 |
|
20126 <div id="method_addAttr" class="method item inherited"> |
|
20127 <h3 class="name"><code>addAttr</code></h3> |
|
20128 |
|
20129 |
|
20130 <div class="args"> |
|
20131 <span class="paren">(</span><ul class="args-list inline commas"> |
|
20132 |
|
20133 <li class="arg"> |
|
20134 |
|
20135 <code>name</code> |
|
20136 |
|
20137 </li> |
|
20138 |
|
20139 <li class="arg"> |
|
20140 |
|
20141 <code>config</code> |
|
20142 |
|
20143 </li> |
|
20144 |
|
20145 <li class="arg"> |
|
20146 |
|
20147 <code>lazy</code> |
|
20148 |
|
20149 </li> |
|
20150 |
|
20151 </ul><span class="paren">)</span> |
|
20152 </div> |
|
20153 |
|
20154 |
|
20155 |
|
20156 <span class="returns-inline"> |
|
20157 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
20158 </span> |
|
20159 |
|
20160 |
|
20161 |
|
20162 |
|
20163 |
|
20164 |
|
20165 |
|
20166 |
|
20167 |
|
20168 |
|
20169 |
|
20170 <span class="flag chainable">chainable</span> |
|
20171 |
|
20172 |
|
20173 |
|
20174 |
|
20175 <div class="meta"> |
|
20176 |
|
20177 |
|
20178 <p>Inherited from |
|
20179 <a href="../classes/AttributeCore.html#method_addAttr">AttributeCore</a>: |
|
20180 |
|
20181 |
|
20182 |
|
20183 <a href="../files/attribute_js_AttributeCore.js.html#l157"><code>attribute/js/AttributeCore.js:157</code></a> |
|
20184 |
|
20185 </p> |
|
20186 |
|
20187 |
|
20188 |
|
20189 |
|
20190 |
|
20191 </div> |
|
20192 |
|
20193 <div class="description"> |
|
20194 <p> |
|
20195 Adds an attribute with the provided configuration to the host object. |
|
20196 </p> |
|
20197 |
|
20198 <p> |
|
20199 The config argument object supports the following properties: |
|
20200 </p> |
|
20201 |
|
20202 <dl> |
|
20203 <dt>value <Any></dt> |
|
20204 <dd>The initial value to set on the attribute</dd> |
|
20205 |
|
20206 <dt>valueFn <Function | String></dt> |
|
20207 <dd> |
|
20208 <p>A function, which will return the initial value to set on the attribute. This is useful |
|
20209 for cases where the attribute configuration is defined statically, but needs to |
|
20210 reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, |
|
20211 the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which |
|
20212 case the value property is used.</p> |
|
20213 |
|
20214 <p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p> |
|
20215 </dd> |
|
20216 |
|
20217 <dt>readOnly <boolean></dt> |
|
20218 <dd>Whether or not the attribute is read only. Attributes having readOnly set to true |
|
20219 cannot be modified by invoking the set method.</dd> |
|
20220 |
|
20221 <dt>writeOnce <boolean> or <string></dt> |
|
20222 <dd> |
|
20223 Whether or not the attribute is "write once". Attributes having writeOnce set to true, |
|
20224 can only have their values set once, be it through the default configuration, |
|
20225 constructor configuration arguments, or by invoking set. |
|
20226 <p>The writeOnce attribute can also be set to the string "initOnly", |
|
20227 in which case the attribute can only be set during initialization |
|
20228 (when used with Base, this means it can only be set during construction)</p> |
|
20229 </dd> |
|
20230 |
|
20231 <dt>setter <Function | String></dt> |
|
20232 <dd> |
|
20233 <p>The setter function used to massage or normalize the value passed to the set method for the attribute. |
|
20234 The value returned by the setter will be the final stored value. Returning |
|
20235 <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent |
|
20236 the value from being stored. |
|
20237 </p> |
|
20238 |
|
20239 <p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p> |
|
20240 </dd> |
|
20241 |
|
20242 <dt>getter <Function | String></dt> |
|
20243 <dd> |
|
20244 <p> |
|
20245 The getter function used to massage or normalize the value returned by the get method for the attribute. |
|
20246 The value returned by the getter function is the value which will be returned to the user when they |
|
20247 invoke get. |
|
20248 </p> |
|
20249 |
|
20250 <p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p> |
|
20251 </dd> |
|
20252 |
|
20253 <dt>validator <Function | String></dt> |
|
20254 <dd> |
|
20255 <p> |
|
20256 The validator function invoked prior to setting the stored value. Returning |
|
20257 false from the validator function will prevent the value from being stored. |
|
20258 </p> |
|
20259 |
|
20260 <p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p> |
|
20261 </dd> |
|
20262 |
|
20263 <dt>lazyAdd <boolean></dt> |
|
20264 <dd>Whether or not to delay initialization of the attribute until the first call to get/set it. |
|
20265 This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through |
|
20266 the <a href="#method_addAttrs">addAttrs</a> method.</dd> |
|
20267 |
|
20268 </dl> |
|
20269 |
|
20270 <p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with |
|
20271 the context ("this") set to the host object.</p> |
|
20272 |
|
20273 <p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, |
|
20274 and are not intended for public use.</p> |
|
20275 </div> |
|
20276 |
|
20277 |
|
20278 <div class="params"> |
|
20279 <h4>Parameters:</h4> |
|
20280 |
|
20281 <ul class="params-list"> |
|
20282 |
|
20283 <li class="param"> |
|
20284 |
|
20285 <code class="param-name">name</code> |
|
20286 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
20287 |
|
20288 |
|
20289 |
|
20290 |
|
20291 <div class="param-description"> |
|
20292 <p>The name of the attribute.</p> |
|
20293 </div> |
|
20294 |
|
20295 |
|
20296 </li> |
|
20297 |
|
20298 <li class="param"> |
|
20299 |
|
20300 <code class="param-name">config</code> |
|
20301 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
20302 |
|
20303 |
|
20304 |
|
20305 |
|
20306 <div class="param-description"> |
|
20307 <p>An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</p> |
|
20308 |
|
20309 <p> |
|
20310 <strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need |
|
20311 to protect the original values, you will need to merge the object. |
|
20312 </p> |
|
20313 </div> |
|
20314 |
|
20315 |
|
20316 </li> |
|
20317 |
|
20318 <li class="param"> |
|
20319 |
|
20320 <code class="param-name">lazy</code> |
|
20321 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
20322 |
|
20323 |
|
20324 |
|
20325 |
|
20326 <div class="param-description"> |
|
20327 <p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</p> |
|
20328 </div> |
|
20329 |
|
20330 |
|
20331 </li> |
|
20332 |
|
20333 </ul> |
|
20334 </div> |
|
20335 |
|
20336 |
|
20337 |
|
20338 <div class="returns"> |
|
20339 <h4>Returns:</h4> |
|
20340 |
|
20341 <div class="returns-description"> |
|
20342 |
|
20343 |
|
20344 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
20345 |
|
20346 A reference to the host object. |
|
20347 |
|
20348 </div> |
|
20349 </div> |
|
20350 |
|
20351 |
|
20352 |
|
20353 </div> |
|
20354 |
|
20355 |
|
20356 <div id="method_addAttrs" class="method item inherited"> |
|
20357 <h3 class="name"><code>addAttrs</code></h3> |
|
20358 |
|
20359 |
|
20360 <div class="args"> |
|
20361 <span class="paren">(</span><ul class="args-list inline commas"> |
|
20362 |
|
20363 <li class="arg"> |
|
20364 |
|
20365 <code>cfgs</code> |
|
20366 |
|
20367 </li> |
|
20368 |
|
20369 <li class="arg"> |
|
20370 |
|
20371 <code>values</code> |
|
20372 |
|
20373 </li> |
|
20374 |
|
20375 <li class="arg"> |
|
20376 |
|
20377 <code>lazy</code> |
|
20378 |
|
20379 </li> |
|
20380 |
|
20381 </ul><span class="paren">)</span> |
|
20382 </div> |
|
20383 |
|
20384 |
|
20385 |
|
20386 <span class="returns-inline"> |
|
20387 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
20388 </span> |
|
20389 |
|
20390 |
|
20391 |
|
20392 |
|
20393 |
|
20394 |
|
20395 |
|
20396 |
|
20397 |
|
20398 |
|
20399 |
|
20400 <span class="flag chainable">chainable</span> |
|
20401 |
|
20402 |
|
20403 |
|
20404 |
|
20405 <div class="meta"> |
|
20406 |
|
20407 |
|
20408 <p>Inherited from |
|
20409 <a href="../classes/AttributeCore.html#method_addAttrs">AttributeCore</a>: |
|
20410 |
|
20411 |
|
20412 |
|
20413 <a href="../files/attribute_js_AttributeCore.js.html#l805"><code>attribute/js/AttributeCore.js:805</code></a> |
|
20414 |
|
20415 </p> |
|
20416 |
|
20417 |
|
20418 |
|
20419 |
|
20420 |
|
20421 </div> |
|
20422 |
|
20423 <div class="description"> |
|
20424 <p>Configures a group of attributes, and sets initial values.</p> |
|
20425 |
|
20426 <p> |
|
20427 <strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning. |
|
20428 The caller is responsible for merging/cloning the configuration object if required. |
|
20429 </p> |
|
20430 </div> |
|
20431 |
|
20432 |
|
20433 <div class="params"> |
|
20434 <h4>Parameters:</h4> |
|
20435 |
|
20436 <ul class="params-list"> |
|
20437 |
|
20438 <li class="param"> |
|
20439 |
|
20440 <code class="param-name">cfgs</code> |
|
20441 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
20442 |
|
20443 |
|
20444 |
|
20445 |
|
20446 <div class="param-description"> |
|
20447 <p>An object with attribute name/configuration pairs.</p> |
|
20448 </div> |
|
20449 |
|
20450 |
|
20451 </li> |
|
20452 |
|
20453 <li class="param"> |
|
20454 |
|
20455 <code class="param-name">values</code> |
|
20456 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
20457 |
|
20458 |
|
20459 |
|
20460 |
|
20461 <div class="param-description"> |
|
20462 <p>An object with attribute name/value pairs, defining the initial values to apply. |
|
20463 Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p> |
|
20464 </div> |
|
20465 |
|
20466 |
|
20467 </li> |
|
20468 |
|
20469 <li class="param"> |
|
20470 |
|
20471 <code class="param-name">lazy</code> |
|
20472 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
20473 |
|
20474 |
|
20475 |
|
20476 |
|
20477 <div class="param-description"> |
|
20478 <p>Whether or not to delay the intialization of these attributes until the first call to get/set. |
|
20479 Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. |
|
20480 See <a href="#method_addAttr">addAttr</a>.</p> |
|
20481 </div> |
|
20482 |
|
20483 |
|
20484 </li> |
|
20485 |
|
20486 </ul> |
|
20487 </div> |
|
20488 |
|
20489 |
|
20490 |
|
20491 <div class="returns"> |
|
20492 <h4>Returns:</h4> |
|
20493 |
|
20494 <div class="returns-description"> |
|
20495 |
|
20496 |
|
20497 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
20498 |
|
20499 A reference to the host object. |
|
20500 |
|
20501 </div> |
|
20502 </div> |
|
20503 |
|
20504 |
|
20505 |
|
20506 </div> |
|
20507 |
|
20508 |
|
20509 <div id="method_addColumn" class="method item"> |
|
20510 <h3 class="name"><code>addColumn</code></h3> |
|
20511 |
|
20512 |
|
20513 <div class="args"> |
|
20514 <span class="paren">(</span><ul class="args-list inline commas"> |
|
20515 |
|
20516 <li class="arg"> |
|
20517 |
|
20518 <code>config</code> |
|
20519 |
|
20520 </li> |
|
20521 |
|
20522 <li class="arg"> |
|
20523 |
|
20524 <code class="optional">[index]</code> |
|
20525 |
|
20526 </li> |
|
20527 |
|
20528 </ul><span class="paren">)</span> |
|
20529 </div> |
|
20530 |
|
20531 |
|
20532 |
|
20533 <span class="returns-inline"> |
|
20534 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
20535 </span> |
|
20536 |
|
20537 |
|
20538 |
|
20539 |
|
20540 |
|
20541 |
|
20542 |
|
20543 |
|
20544 |
|
20545 |
|
20546 |
|
20547 <span class="flag chainable">chainable</span> |
|
20548 |
|
20549 |
|
20550 |
|
20551 |
|
20552 <div class="meta"> |
|
20553 |
|
20554 |
|
20555 |
|
20556 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
20557 |
|
20558 <p> |
|
20559 |
|
20560 Defined in |
|
20561 |
|
20562 |
|
20563 |
|
20564 |
|
20565 <a href="../files/datatable_js_mutable.js.html#l60"><code>datatable/js/mutable.js:60</code></a> |
|
20566 |
|
20567 </p> |
|
20568 |
|
20569 |
|
20570 |
|
20571 |
|
20572 |
|
20573 <p>Available since 3.5.0</p> |
|
20574 |
|
20575 </div> |
|
20576 |
|
20577 <div class="description"> |
|
20578 <p>Adds the column configuration to the DataTable's <code>columns</code> configuration. |
|
20579 If the <code>index</code> parameter is supplied, it is injected at that index. If the |
|
20580 table has nested headers, inject a subcolumn by passing an array of indexes |
|
20581 to identify the new column's final location.</p> |
|
20582 |
|
20583 <p>The <code>index</code> parameter is required if adding a nested column.</p> |
|
20584 |
|
20585 <p>This method is a convienience method for fetching the DataTable's <code>columns</code> |
|
20586 attribute, updating it, and calling |
|
20587 <code>table.set('columns', _updatedColumnsDefs_)</code></p> |
|
20588 |
|
20589 <p>For example:</p> |
|
20590 |
|
20591 <pre class="code prettyprint"><code>// Becomes last column |
|
20592 table.addColumn('name'); |
|
20593 |
|
20594 // Inserted after the current second column, moving the current third column |
|
20595 // to index 4 |
|
20596 table.addColumn({ key: 'price', formatter: currencyFormatter }, 2 ); |
|
20597 |
|
20598 // Insert a new column in a set of headers three rows deep. The index array |
|
20599 // translates to |
|
20600 // [ 2, -- in the third column's children |
|
20601 // 1, -- in the second child's children |
|
20602 // 3 ] -- as the fourth child column |
|
20603 table.addColumn({ key: 'age', sortable: true }, [ 2, 1, 3 ]); |
|
20604 </code></pre> |
|
20605 </div> |
|
20606 |
|
20607 |
|
20608 <div class="params"> |
|
20609 <h4>Parameters:</h4> |
|
20610 |
|
20611 <ul class="params-list"> |
|
20612 |
|
20613 <li class="param"> |
|
20614 |
|
20615 <code class="param-name">config</code> |
|
20616 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
20617 |
|
20618 |
|
20619 |
|
20620 |
|
20621 <div class="param-description"> |
|
20622 <p>The new column configuration object</p> |
|
20623 </div> |
|
20624 |
|
20625 |
|
20626 </li> |
|
20627 |
|
20628 <li class="param"> |
|
20629 |
|
20630 <code class="param-name optional">[index]</code> |
|
20631 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span> |
|
20632 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
20633 |
|
20634 |
|
20635 |
|
20636 |
|
20637 <div class="param-description"> |
|
20638 <p>the insertion index</p> |
|
20639 </div> |
|
20640 |
|
20641 |
|
20642 </li> |
|
20643 |
|
20644 </ul> |
|
20645 </div> |
|
20646 |
|
20647 |
|
20648 |
|
20649 <div class="returns"> |
|
20650 <h4>Returns:</h4> |
|
20651 |
|
20652 <div class="returns-description"> |
|
20653 |
|
20654 |
|
20655 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
20656 |
|
20657 |
|
20658 </div> |
|
20659 </div> |
|
20660 |
|
20661 |
|
20662 |
|
20663 </div> |
|
20664 |
|
20665 |
|
20666 <div id="method_addRow" class="method item"> |
|
20667 <h3 class="name"><code>addRow</code></h3> |
|
20668 |
|
20669 |
|
20670 <div class="args"> |
|
20671 <span class="paren">(</span><ul class="args-list inline commas"> |
|
20672 |
|
20673 <li class="arg"> |
|
20674 |
|
20675 <code>data</code> |
|
20676 |
|
20677 </li> |
|
20678 |
|
20679 <li class="arg"> |
|
20680 |
|
20681 <code class="optional">[config]</code> |
|
20682 |
|
20683 </li> |
|
20684 |
|
20685 <li class="arg"> |
|
20686 |
|
20687 <code class="optional">[callback]</code> |
|
20688 |
|
20689 </li> |
|
20690 |
|
20691 </ul><span class="paren">)</span> |
|
20692 </div> |
|
20693 |
|
20694 |
|
20695 |
|
20696 <span class="returns-inline"> |
|
20697 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
20698 </span> |
|
20699 |
|
20700 |
|
20701 |
|
20702 |
|
20703 |
|
20704 |
|
20705 |
|
20706 |
|
20707 |
|
20708 |
|
20709 |
|
20710 <span class="flag chainable">chainable</span> |
|
20711 |
|
20712 |
|
20713 |
|
20714 |
|
20715 <div class="meta"> |
|
20716 |
|
20717 |
|
20718 |
|
20719 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
20720 |
|
20721 <p> |
|
20722 |
|
20723 Defined in |
|
20724 |
|
20725 |
|
20726 |
|
20727 |
|
20728 <a href="../files/datatable_js_mutable.js.html#l198"><code>datatable/js/mutable.js:198</code></a> |
|
20729 |
|
20730 </p> |
|
20731 |
|
20732 |
|
20733 |
|
20734 |
|
20735 |
|
20736 <p>Available since 3.5.0</p> |
|
20737 |
|
20738 </div> |
|
20739 |
|
20740 <div class="description"> |
|
20741 <p>Adds a new record to the DataTable's <code>data</code> ModelList. Record data can be |
|
20742 an object of field values or an instance of the DataTable's configured |
|
20743 <code>recordType</code> class.</p> |
|
20744 |
|
20745 <p>This relays all parameters to the <code>data</code> ModelList's <code>add</code> method.</p> |
|
20746 |
|
20747 <p>If a configuration object is passed as a second argument, and that object |
|
20748 has <code>sync: true</code> set, the underlying Model will be <code>save()</code>d.</p> |
|
20749 |
|
20750 <p>If the DataTable's <code>autoSync</code> attribute is set to <code>true</code>, the additional |
|
20751 argument is not needed.</p> |
|
20752 |
|
20753 <p>If syncing and the last argument is a function, that function will be used |
|
20754 as a callback to the Model's <code>save()</code> method.</p> |
|
20755 </div> |
|
20756 |
|
20757 |
|
20758 <div class="params"> |
|
20759 <h4>Parameters:</h4> |
|
20760 |
|
20761 <ul class="params-list"> |
|
20762 |
|
20763 <li class="param"> |
|
20764 |
|
20765 <code class="param-name">data</code> |
|
20766 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
20767 |
|
20768 |
|
20769 |
|
20770 |
|
20771 <div class="param-description"> |
|
20772 <p>The data or Model instance for the new record</p> |
|
20773 </div> |
|
20774 |
|
20775 |
|
20776 </li> |
|
20777 |
|
20778 <li class="param"> |
|
20779 |
|
20780 <code class="param-name optional">[config]</code> |
|
20781 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
20782 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
20783 |
|
20784 |
|
20785 |
|
20786 |
|
20787 <div class="param-description"> |
|
20788 <p>Configuration to pass along</p> |
|
20789 </div> |
|
20790 |
|
20791 |
|
20792 </li> |
|
20793 |
|
20794 <li class="param"> |
|
20795 |
|
20796 <code class="param-name optional">[callback]</code> |
|
20797 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
20798 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
20799 |
|
20800 |
|
20801 |
|
20802 |
|
20803 <div class="param-description"> |
|
20804 <p>Callback function for Model's <code>save()</code></p> |
|
20805 </div> |
|
20806 |
|
20807 |
|
20808 <ul class="params-list"> |
|
20809 |
|
20810 <li class="param"> |
|
20811 |
|
20812 <code class="param-name">err</code> |
|
20813 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span> |
|
20814 |
|
20815 |
|
20816 <div class="param-description"> |
|
20817 <p>If an error occurred or validation |
|
20818 failed, this parameter will contain the error. If the sync operation |
|
20819 succeeded, <em>err</em> will be <code>null</code>.</p> |
|
20820 </div> |
|
20821 |
|
20822 |
|
20823 </li> |
|
20824 |
|
20825 <li class="param"> |
|
20826 |
|
20827 <code class="param-name">response</code> |
|
20828 <span class="type">Any</span> |
|
20829 |
|
20830 |
|
20831 <div class="param-description"> |
|
20832 <p>The server's response. This value will |
|
20833 be passed to the <code>parse()</code> method, which is expected to parse it and |
|
20834 return an attribute hash.</p> |
|
20835 </div> |
|
20836 |
|
20837 |
|
20838 </li> |
|
20839 |
|
20840 </ul> |
|
20841 |
|
20842 </li> |
|
20843 |
|
20844 </ul> |
|
20845 </div> |
|
20846 |
|
20847 |
|
20848 |
|
20849 <div class="returns"> |
|
20850 <h4>Returns:</h4> |
|
20851 |
|
20852 <div class="returns-description"> |
|
20853 |
|
20854 |
|
20855 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
20856 |
|
20857 |
|
20858 </div> |
|
20859 </div> |
|
20860 |
|
20861 |
|
20862 |
|
20863 </div> |
|
20864 |
|
20865 |
|
20866 <div id="method_addRows" class="method item"> |
|
20867 <h3 class="name"><code>addRows</code></h3> |
|
20868 |
|
20869 |
|
20870 <div class="args"> |
|
20871 <span class="paren">(</span><ul class="args-list inline commas"> |
|
20872 |
|
20873 <li class="arg"> |
|
20874 |
|
20875 <code>data</code> |
|
20876 |
|
20877 </li> |
|
20878 |
|
20879 <li class="arg"> |
|
20880 |
|
20881 <code class="optional">[config]</code> |
|
20882 |
|
20883 </li> |
|
20884 |
|
20885 <li class="arg"> |
|
20886 |
|
20887 <code class="optional">[callback]</code> |
|
20888 |
|
20889 </li> |
|
20890 |
|
20891 </ul><span class="paren">)</span> |
|
20892 </div> |
|
20893 |
|
20894 |
|
20895 |
|
20896 <span class="returns-inline"> |
|
20897 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
20898 </span> |
|
20899 |
|
20900 |
|
20901 |
|
20902 |
|
20903 |
|
20904 |
|
20905 |
|
20906 |
|
20907 |
|
20908 |
|
20909 |
|
20910 <span class="flag chainable">chainable</span> |
|
20911 |
|
20912 |
|
20913 |
|
20914 |
|
20915 <div class="meta"> |
|
20916 |
|
20917 |
|
20918 |
|
20919 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
20920 |
|
20921 <p> |
|
20922 |
|
20923 Defined in |
|
20924 |
|
20925 |
|
20926 |
|
20927 |
|
20928 <a href="../files/datatable_js_mutable.js.html#l552"><code>datatable/js/mutable.js:552</code></a> |
|
20929 |
|
20930 </p> |
|
20931 |
|
20932 |
|
20933 |
|
20934 |
|
20935 |
|
20936 <p>Available since 3.5.0</p> |
|
20937 |
|
20938 </div> |
|
20939 |
|
20940 <div class="description"> |
|
20941 <p>Adds an array of new records to the DataTable's <code>data</code> ModelList. Record data |
|
20942 can be an array of objects containing field values or an array of instance of |
|
20943 the DataTable's configured <code>recordType</code> class.</p> |
|
20944 |
|
20945 <p>This relays all parameters to the <code>data</code> ModelList's <code>add</code> method.</p> |
|
20946 |
|
20947 <p>Technically, this is an alias to <code>addRow</code>, but please use the appropriately |
|
20948 named method for readability.</p> |
|
20949 |
|
20950 <p>If a configuration object is passed as a second argument, and that object |
|
20951 has <code>sync: true</code> set, the underlying Models will be <code>save()</code>d.</p> |
|
20952 |
|
20953 <p>If the DataTable's <code>autoSync</code> attribute is set to <code>true</code>, the additional |
|
20954 argument is not needed.</p> |
|
20955 |
|
20956 <p>If syncing and the last argument is a function, that function will be used |
|
20957 as a callback to each Model's <code>save()</code> method.</p> |
|
20958 </div> |
|
20959 |
|
20960 |
|
20961 <div class="params"> |
|
20962 <h4>Parameters:</h4> |
|
20963 |
|
20964 <ul class="params-list"> |
|
20965 |
|
20966 <li class="param"> |
|
20967 |
|
20968 <code class="param-name">data</code> |
|
20969 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
20970 |
|
20971 |
|
20972 |
|
20973 |
|
20974 <div class="param-description"> |
|
20975 <p>The data or Model instances to add</p> |
|
20976 </div> |
|
20977 |
|
20978 |
|
20979 </li> |
|
20980 |
|
20981 <li class="param"> |
|
20982 |
|
20983 <code class="param-name optional">[config]</code> |
|
20984 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
20985 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
20986 |
|
20987 |
|
20988 |
|
20989 |
|
20990 <div class="param-description"> |
|
20991 <p>Configuration to pass along</p> |
|
20992 </div> |
|
20993 |
|
20994 |
|
20995 </li> |
|
20996 |
|
20997 <li class="param"> |
|
20998 |
|
20999 <code class="param-name optional">[callback]</code> |
|
21000 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
21001 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
21002 |
|
21003 |
|
21004 |
|
21005 |
|
21006 <div class="param-description"> |
|
21007 <p>Callback function for each Model's <code>save()</code></p> |
|
21008 </div> |
|
21009 |
|
21010 |
|
21011 <ul class="params-list"> |
|
21012 |
|
21013 <li class="param"> |
|
21014 |
|
21015 <code class="param-name">err</code> |
|
21016 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span> |
|
21017 |
|
21018 |
|
21019 <div class="param-description"> |
|
21020 <p>If an error occurred or validation |
|
21021 failed, this parameter will contain the error. If the sync operation |
|
21022 succeeded, <em>err</em> will be <code>null</code>.</p> |
|
21023 </div> |
|
21024 |
|
21025 |
|
21026 </li> |
|
21027 |
|
21028 <li class="param"> |
|
21029 |
|
21030 <code class="param-name">response</code> |
|
21031 <span class="type">Any</span> |
|
21032 |
|
21033 |
|
21034 <div class="param-description"> |
|
21035 <p>The server's response. This value will |
|
21036 be passed to the <code>parse()</code> method, which is expected to parse it and |
|
21037 return an attribute hash.</p> |
|
21038 </div> |
|
21039 |
|
21040 |
|
21041 </li> |
|
21042 |
|
21043 </ul> |
|
21044 |
|
21045 </li> |
|
21046 |
|
21047 </ul> |
|
21048 </div> |
|
21049 |
|
21050 |
|
21051 |
|
21052 <div class="returns"> |
|
21053 <h4>Returns:</h4> |
|
21054 |
|
21055 <div class="returns-description"> |
|
21056 |
|
21057 |
|
21058 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
21059 |
|
21060 |
|
21061 </div> |
|
21062 </div> |
|
21063 |
|
21064 |
|
21065 |
|
21066 </div> |
|
21067 |
|
21068 |
|
21069 <div id="method_addTarget" class="method item inherited"> |
|
21070 <h3 class="name"><code>addTarget</code></h3> |
|
21071 |
|
21072 |
|
21073 <div class="args"> |
|
21074 <span class="paren">(</span><ul class="args-list inline commas"> |
|
21075 |
|
21076 <li class="arg"> |
|
21077 |
|
21078 <code>o</code> |
|
21079 |
|
21080 </li> |
|
21081 |
|
21082 </ul><span class="paren">)</span> |
|
21083 </div> |
|
21084 |
|
21085 |
|
21086 |
|
21087 |
|
21088 |
|
21089 |
|
21090 |
|
21091 |
|
21092 |
|
21093 |
|
21094 |
|
21095 |
|
21096 |
|
21097 |
|
21098 |
|
21099 |
|
21100 <div class="meta"> |
|
21101 |
|
21102 |
|
21103 <p>Inherited from |
|
21104 <a href="../classes/EventTarget.html#method_addTarget">EventTarget</a>: |
|
21105 |
|
21106 |
|
21107 |
|
21108 <a href="../files/event-custom_js_event-facade.js.html#l455"><code>event-custom/js/event-facade.js:455</code></a> |
|
21109 |
|
21110 </p> |
|
21111 |
|
21112 |
|
21113 |
|
21114 |
|
21115 |
|
21116 </div> |
|
21117 |
|
21118 <div class="description"> |
|
21119 <p>Registers another EventTarget as a bubble target. Bubble order |
|
21120 is determined by the order registered. Multiple targets can |
|
21121 be specified.</p> |
|
21122 |
|
21123 <p>Events can only bubble if emitFacade is true.</p> |
|
21124 |
|
21125 <p>Included in the event-custom-complex submodule.</p> |
|
21126 </div> |
|
21127 |
|
21128 |
|
21129 <div class="params"> |
|
21130 <h4>Parameters:</h4> |
|
21131 |
|
21132 <ul class="params-list"> |
|
21133 |
|
21134 <li class="param"> |
|
21135 |
|
21136 <code class="param-name">o</code> |
|
21137 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
21138 |
|
21139 |
|
21140 |
|
21141 |
|
21142 <div class="param-description"> |
|
21143 <p>the target to add</p> |
|
21144 </div> |
|
21145 |
|
21146 |
|
21147 </li> |
|
21148 |
|
21149 </ul> |
|
21150 </div> |
|
21151 |
|
21152 |
|
21153 |
|
21154 |
|
21155 |
|
21156 </div> |
|
21157 |
|
21158 |
|
21159 <div id="method_after" class="method item inherited"> |
|
21160 <h3 class="name"><code>after</code></h3> |
|
21161 |
|
21162 |
|
21163 <div class="args"> |
|
21164 <span class="paren">(</span><ul class="args-list inline commas"> |
|
21165 |
|
21166 <li class="arg"> |
|
21167 |
|
21168 <code>type</code> |
|
21169 |
|
21170 </li> |
|
21171 |
|
21172 <li class="arg"> |
|
21173 |
|
21174 <code>fn</code> |
|
21175 |
|
21176 </li> |
|
21177 |
|
21178 <li class="arg"> |
|
21179 |
|
21180 <code class="optional">[context]</code> |
|
21181 |
|
21182 </li> |
|
21183 |
|
21184 <li class="arg"> |
|
21185 |
|
21186 <code class="optional">[arg*]</code> |
|
21187 |
|
21188 </li> |
|
21189 |
|
21190 </ul><span class="paren">)</span> |
|
21191 </div> |
|
21192 |
|
21193 |
|
21194 |
|
21195 <span class="returns-inline"> |
|
21196 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
21197 </span> |
|
21198 |
|
21199 |
|
21200 |
|
21201 |
|
21202 |
|
21203 |
|
21204 |
|
21205 |
|
21206 |
|
21207 |
|
21208 |
|
21209 |
|
21210 |
|
21211 |
|
21212 <div class="meta"> |
|
21213 |
|
21214 |
|
21215 <p>Inherited from |
|
21216 <a href="../classes/EventTarget.html#method_after">EventTarget</a>: |
|
21217 |
|
21218 |
|
21219 |
|
21220 <a href="../files/event-custom_js_event-target.js.html#l833"><code>event-custom/js/event-target.js:833</code></a> |
|
21221 |
|
21222 </p> |
|
21223 |
|
21224 |
|
21225 |
|
21226 |
|
21227 |
|
21228 </div> |
|
21229 |
|
21230 <div class="description"> |
|
21231 <p>Subscribe to a custom event hosted by this object. The |
|
21232 supplied callback will execute after any listeners add |
|
21233 via the subscribe method, and after the default function, |
|
21234 if configured for the event, has executed.</p> |
|
21235 </div> |
|
21236 |
|
21237 |
|
21238 <div class="params"> |
|
21239 <h4>Parameters:</h4> |
|
21240 |
|
21241 <ul class="params-list"> |
|
21242 |
|
21243 <li class="param"> |
|
21244 |
|
21245 <code class="param-name">type</code> |
|
21246 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
21247 |
|
21248 |
|
21249 |
|
21250 |
|
21251 <div class="param-description"> |
|
21252 <p>The name of the event</p> |
|
21253 </div> |
|
21254 |
|
21255 |
|
21256 </li> |
|
21257 |
|
21258 <li class="param"> |
|
21259 |
|
21260 <code class="param-name">fn</code> |
|
21261 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
21262 |
|
21263 |
|
21264 |
|
21265 |
|
21266 <div class="param-description"> |
|
21267 <p>The callback to execute in response to the event</p> |
|
21268 </div> |
|
21269 |
|
21270 |
|
21271 </li> |
|
21272 |
|
21273 <li class="param"> |
|
21274 |
|
21275 <code class="param-name optional">[context]</code> |
|
21276 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
21277 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
21278 |
|
21279 |
|
21280 |
|
21281 |
|
21282 <div class="param-description"> |
|
21283 <p>Override <code>this</code> object in callback</p> |
|
21284 </div> |
|
21285 |
|
21286 |
|
21287 </li> |
|
21288 |
|
21289 <li class="param"> |
|
21290 |
|
21291 <code class="param-name optional">[arg*]</code> |
|
21292 <span class="type">Any</span> |
|
21293 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
21294 |
|
21295 |
|
21296 |
|
21297 |
|
21298 <div class="param-description"> |
|
21299 <p>0..n additional arguments to supply to the subscriber</p> |
|
21300 </div> |
|
21301 |
|
21302 |
|
21303 </li> |
|
21304 |
|
21305 </ul> |
|
21306 </div> |
|
21307 |
|
21308 |
|
21309 |
|
21310 <div class="returns"> |
|
21311 <h4>Returns:</h4> |
|
21312 |
|
21313 <div class="returns-description"> |
|
21314 |
|
21315 |
|
21316 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
21317 |
|
21318 A subscription handle capable of detaching the |
|
21319 subscription |
|
21320 |
|
21321 </div> |
|
21322 </div> |
|
21323 |
|
21324 |
|
21325 |
|
21326 </div> |
|
21327 |
|
21328 |
|
21329 <div id="method_ancestor" class="method item inherited"> |
|
21330 <h3 class="name"><code>ancestor</code></h3> |
|
21331 |
|
21332 |
|
21333 <div class="args"> |
|
21334 <span class="paren">(</span><ul class="args-list inline commas"> |
|
21335 |
|
21336 <li class="arg"> |
|
21337 |
|
21338 <code>depth</code> |
|
21339 |
|
21340 </li> |
|
21341 |
|
21342 </ul><span class="paren">)</span> |
|
21343 </div> |
|
21344 |
|
21345 |
|
21346 |
|
21347 <span class="returns-inline"> |
|
21348 <span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span> |
|
21349 </span> |
|
21350 |
|
21351 |
|
21352 |
|
21353 |
|
21354 |
|
21355 |
|
21356 |
|
21357 |
|
21358 |
|
21359 |
|
21360 |
|
21361 |
|
21362 |
|
21363 |
|
21364 <div class="meta"> |
|
21365 |
|
21366 |
|
21367 <p>Inherited from |
|
21368 <a href="../classes/Widget.html#method_ancestor">Widget</a>: |
|
21369 |
|
21370 |
|
21371 |
|
21372 <a href="../files/widget-child_js_Widget-Child.js.html#l279"><code>widget-child/js/Widget-Child.js:279</code></a> |
|
21373 |
|
21374 </p> |
|
21375 |
|
21376 |
|
21377 |
|
21378 |
|
21379 |
|
21380 </div> |
|
21381 |
|
21382 <div class="description"> |
|
21383 <p>Returns the Widget instance at the specified depth.</p> |
|
21384 </div> |
|
21385 |
|
21386 |
|
21387 <div class="params"> |
|
21388 <h4>Parameters:</h4> |
|
21389 |
|
21390 <ul class="params-list"> |
|
21391 |
|
21392 <li class="param"> |
|
21393 |
|
21394 <code class="param-name">depth</code> |
|
21395 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
21396 |
|
21397 |
|
21398 |
|
21399 |
|
21400 <div class="param-description"> |
|
21401 <p>Number representing the depth of the ancestor.</p> |
|
21402 </div> |
|
21403 |
|
21404 |
|
21405 </li> |
|
21406 |
|
21407 </ul> |
|
21408 </div> |
|
21409 |
|
21410 |
|
21411 |
|
21412 <div class="returns"> |
|
21413 <h4>Returns:</h4> |
|
21414 |
|
21415 <div class="returns-description"> |
|
21416 |
|
21417 |
|
21418 <span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>: |
|
21419 |
|
21420 Widget instance. |
|
21421 |
|
21422 </div> |
|
21423 </div> |
|
21424 |
|
21425 |
|
21426 |
|
21427 </div> |
|
21428 |
|
21429 |
|
21430 <div id="method_attrAdded" class="method item inherited"> |
|
21431 <h3 class="name"><code>attrAdded</code></h3> |
|
21432 |
|
21433 |
|
21434 <div class="args"> |
|
21435 <span class="paren">(</span><ul class="args-list inline commas"> |
|
21436 |
|
21437 <li class="arg"> |
|
21438 |
|
21439 <code>name</code> |
|
21440 |
|
21441 </li> |
|
21442 |
|
21443 </ul><span class="paren">)</span> |
|
21444 </div> |
|
21445 |
|
21446 |
|
21447 |
|
21448 <span class="returns-inline"> |
|
21449 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
21450 </span> |
|
21451 |
|
21452 |
|
21453 |
|
21454 |
|
21455 |
|
21456 |
|
21457 |
|
21458 |
|
21459 |
|
21460 |
|
21461 |
|
21462 |
|
21463 |
|
21464 |
|
21465 <div class="meta"> |
|
21466 |
|
21467 |
|
21468 <p>Inherited from |
|
21469 <a href="../classes/AttributeCore.html#method_attrAdded">AttributeCore</a>: |
|
21470 |
|
21471 |
|
21472 |
|
21473 <a href="../files/attribute_js_AttributeCore.js.html#l341"><code>attribute/js/AttributeCore.js:341</code></a> |
|
21474 |
|
21475 </p> |
|
21476 |
|
21477 |
|
21478 |
|
21479 |
|
21480 |
|
21481 </div> |
|
21482 |
|
21483 <div class="description"> |
|
21484 <p>Checks if the given attribute has been added to the host</p> |
|
21485 </div> |
|
21486 |
|
21487 |
|
21488 <div class="params"> |
|
21489 <h4>Parameters:</h4> |
|
21490 |
|
21491 <ul class="params-list"> |
|
21492 |
|
21493 <li class="param"> |
|
21494 |
|
21495 <code class="param-name">name</code> |
|
21496 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
21497 |
|
21498 |
|
21499 |
|
21500 |
|
21501 <div class="param-description"> |
|
21502 <p>The name of the attribute to check.</p> |
|
21503 </div> |
|
21504 |
|
21505 |
|
21506 </li> |
|
21507 |
|
21508 </ul> |
|
21509 </div> |
|
21510 |
|
21511 |
|
21512 |
|
21513 <div class="returns"> |
|
21514 <h4>Returns:</h4> |
|
21515 |
|
21516 <div class="returns-description"> |
|
21517 |
|
21518 |
|
21519 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
21520 |
|
21521 true if an attribute with the given name has been added, false if it hasn't. |
|
21522 This method will return true for lazily added attributes. |
|
21523 |
|
21524 </div> |
|
21525 </div> |
|
21526 |
|
21527 |
|
21528 |
|
21529 </div> |
|
21530 |
|
21531 |
|
21532 <div id="method_before" class="method item inherited"> |
|
21533 <h3 class="name"><code>before</code></h3> |
|
21534 |
|
21535 |
|
21536 <span class="paren">()</span> |
|
21537 |
|
21538 |
|
21539 |
|
21540 <span class="returns-inline"> |
|
21541 <span class="type"></span> |
|
21542 </span> |
|
21543 |
|
21544 |
|
21545 |
|
21546 |
|
21547 |
|
21548 |
|
21549 |
|
21550 |
|
21551 |
|
21552 |
|
21553 |
|
21554 |
|
21555 |
|
21556 |
|
21557 <div class="meta"> |
|
21558 |
|
21559 |
|
21560 <p>Inherited from |
|
21561 <a href="../classes/EventTarget.html#method_before">EventTarget</a>: |
|
21562 |
|
21563 |
|
21564 |
|
21565 <a href="../files/event-custom_js_event-target.js.html#l870"><code>event-custom/js/event-target.js:870</code></a> |
|
21566 |
|
21567 </p> |
|
21568 |
|
21569 |
|
21570 |
|
21571 |
|
21572 |
|
21573 </div> |
|
21574 |
|
21575 <div class="description"> |
|
21576 <p>Executes the callback before a DOM event, custom event |
|
21577 or method. If the first argument is a function, it |
|
21578 is assumed the target is a method. For DOM and custom |
|
21579 events, this is an alias for Y.on.</p> |
|
21580 |
|
21581 <p>For DOM and custom events: |
|
21582 type, callback, context, 0-n arguments</p> |
|
21583 |
|
21584 <p>For methods: |
|
21585 callback, object (method host), methodName, context, 0-n arguments</p> |
|
21586 </div> |
|
21587 |
|
21588 |
|
21589 |
|
21590 |
|
21591 <div class="returns"> |
|
21592 <h4>Returns:</h4> |
|
21593 |
|
21594 <div class="returns-description"> |
|
21595 |
|
21596 |
|
21597 detach handle |
|
21598 |
|
21599 </div> |
|
21600 </div> |
|
21601 |
|
21602 |
|
21603 |
|
21604 </div> |
|
21605 |
|
21606 |
|
21607 <div id="method_bindUI" class="method item protected inherited"> |
|
21608 <h3 class="name"><code>bindUI</code></h3> |
|
21609 |
|
21610 |
|
21611 <span class="paren">()</span> |
|
21612 |
|
21613 |
|
21614 |
|
21615 |
|
21616 |
|
21617 |
|
21618 |
|
21619 <span class="flag protected">protected</span> |
|
21620 |
|
21621 |
|
21622 |
|
21623 |
|
21624 |
|
21625 |
|
21626 |
|
21627 |
|
21628 |
|
21629 |
|
21630 <div class="meta"> |
|
21631 |
|
21632 <p>Inherited from |
|
21633 <a href="../classes/Widget.html#method_bindUI"> |
|
21634 Widget |
|
21635 </a> |
|
21636 |
|
21637 but overwritten in |
|
21638 |
|
21639 |
|
21640 |
|
21641 <a href="../files/datatable_js_base.js.html#l319"><code>datatable/js/base.js:319</code></a> |
|
21642 |
|
21643 </p> |
|
21644 |
|
21645 |
|
21646 |
|
21647 |
|
21648 |
|
21649 <p>Available since 3.6.0</p> |
|
21650 |
|
21651 </div> |
|
21652 |
|
21653 <div class="description"> |
|
21654 <p>Attaches subscriptions to relay core change events to the view.</p> |
|
21655 </div> |
|
21656 |
|
21657 |
|
21658 |
|
21659 |
|
21660 |
|
21661 |
|
21662 </div> |
|
21663 |
|
21664 |
|
21665 <div id="method_blur" class="method item inherited"> |
|
21666 <h3 class="name"><code>blur</code></h3> |
|
21667 |
|
21668 |
|
21669 <span class="paren">()</span> |
|
21670 |
|
21671 |
|
21672 |
|
21673 |
|
21674 |
|
21675 |
|
21676 |
|
21677 |
|
21678 |
|
21679 |
|
21680 |
|
21681 |
|
21682 |
|
21683 <span class="flag chainable">chainable</span> |
|
21684 |
|
21685 |
|
21686 |
|
21687 |
|
21688 <div class="meta"> |
|
21689 |
|
21690 |
|
21691 <p>Inherited from |
|
21692 <a href="../classes/Widget.html#method_blur">Widget</a>: |
|
21693 |
|
21694 |
|
21695 |
|
21696 <a href="../files/widget_js_Widget.js.html#l673"><code>widget/js/Widget.js:673</code></a> |
|
21697 |
|
21698 </p> |
|
21699 |
|
21700 |
|
21701 |
|
21702 |
|
21703 |
|
21704 </div> |
|
21705 |
|
21706 <div class="description"> |
|
21707 <p>Causes the Widget to lose focus by setting the "focused" attribute |
|
21708 to "false"</p> |
|
21709 </div> |
|
21710 |
|
21711 |
|
21712 |
|
21713 |
|
21714 |
|
21715 |
|
21716 </div> |
|
21717 |
|
21718 |
|
21719 <div id="method_bubble" class="method item inherited"> |
|
21720 <h3 class="name"><code>bubble</code></h3> |
|
21721 |
|
21722 |
|
21723 <div class="args"> |
|
21724 <span class="paren">(</span><ul class="args-list inline commas"> |
|
21725 |
|
21726 <li class="arg"> |
|
21727 |
|
21728 <code>evt</code> |
|
21729 |
|
21730 </li> |
|
21731 |
|
21732 </ul><span class="paren">)</span> |
|
21733 </div> |
|
21734 |
|
21735 |
|
21736 |
|
21737 <span class="returns-inline"> |
|
21738 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
21739 </span> |
|
21740 |
|
21741 |
|
21742 |
|
21743 |
|
21744 |
|
21745 |
|
21746 |
|
21747 |
|
21748 |
|
21749 |
|
21750 |
|
21751 |
|
21752 |
|
21753 |
|
21754 <div class="meta"> |
|
21755 |
|
21756 |
|
21757 <p>Inherited from |
|
21758 <a href="../classes/EventTarget.html#method_bubble">EventTarget</a>: |
|
21759 |
|
21760 |
|
21761 |
|
21762 <a href="../files/event-custom_js_event-facade.js.html#l507"><code>event-custom/js/event-facade.js:507</code></a> |
|
21763 |
|
21764 </p> |
|
21765 |
|
21766 |
|
21767 |
|
21768 |
|
21769 |
|
21770 </div> |
|
21771 |
|
21772 <div class="description"> |
|
21773 <p>Propagate an event. Requires the event-custom-complex module.</p> |
|
21774 </div> |
|
21775 |
|
21776 |
|
21777 <div class="params"> |
|
21778 <h4>Parameters:</h4> |
|
21779 |
|
21780 <ul class="params-list"> |
|
21781 |
|
21782 <li class="param"> |
|
21783 |
|
21784 <code class="param-name">evt</code> |
|
21785 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
21786 |
|
21787 |
|
21788 |
|
21789 |
|
21790 <div class="param-description"> |
|
21791 <p>the custom event to propagate</p> |
|
21792 </div> |
|
21793 |
|
21794 |
|
21795 </li> |
|
21796 |
|
21797 </ul> |
|
21798 </div> |
|
21799 |
|
21800 |
|
21801 |
|
21802 <div class="returns"> |
|
21803 <h4>Returns:</h4> |
|
21804 |
|
21805 <div class="returns-description"> |
|
21806 |
|
21807 |
|
21808 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
21809 |
|
21810 the aggregated return value from Event.Custom.fire |
|
21811 |
|
21812 </div> |
|
21813 </div> |
|
21814 |
|
21815 |
|
21816 |
|
21817 </div> |
|
21818 |
|
21819 |
|
21820 <div id="method_delegate" class="method item inherited"> |
|
21821 <h3 class="name"><code>delegate</code></h3> |
|
21822 |
|
21823 |
|
21824 <div class="args"> |
|
21825 <span class="paren">(</span><ul class="args-list inline commas"> |
|
21826 |
|
21827 <li class="arg"> |
|
21828 |
|
21829 <code>type</code> |
|
21830 |
|
21831 </li> |
|
21832 |
|
21833 <li class="arg"> |
|
21834 |
|
21835 <code>fn</code> |
|
21836 |
|
21837 </li> |
|
21838 |
|
21839 <li class="arg"> |
|
21840 |
|
21841 <code>spec</code> |
|
21842 |
|
21843 </li> |
|
21844 |
|
21845 <li class="arg"> |
|
21846 |
|
21847 <code>context</code> |
|
21848 |
|
21849 </li> |
|
21850 |
|
21851 <li class="arg"> |
|
21852 |
|
21853 <code>args</code> |
|
21854 |
|
21855 </li> |
|
21856 |
|
21857 </ul><span class="paren">)</span> |
|
21858 </div> |
|
21859 |
|
21860 |
|
21861 |
|
21862 <span class="returns-inline"> |
|
21863 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
21864 </span> |
|
21865 |
|
21866 |
|
21867 |
|
21868 |
|
21869 |
|
21870 |
|
21871 |
|
21872 |
|
21873 |
|
21874 |
|
21875 |
|
21876 |
|
21877 |
|
21878 |
|
21879 <div class="meta"> |
|
21880 |
|
21881 |
|
21882 <p>Inherited from |
|
21883 <a href="../classes/DataTable.Base.html#method_delegate">DataTable.Base</a>: |
|
21884 |
|
21885 |
|
21886 |
|
21887 <a href="../files/datatable_js_base.js.html#l219"><code>datatable/js/base.js:219</code></a> |
|
21888 |
|
21889 </p> |
|
21890 |
|
21891 |
|
21892 |
|
21893 |
|
21894 |
|
21895 <p>Available since 3.5.0</p> |
|
21896 |
|
21897 </div> |
|
21898 |
|
21899 <div class="description"> |
|
21900 <p>Pass through to <code>delegate()</code> called from the <code>contentBox</code>.</p> |
|
21901 </div> |
|
21902 |
|
21903 |
|
21904 <div class="params"> |
|
21905 <h4>Parameters:</h4> |
|
21906 |
|
21907 <ul class="params-list"> |
|
21908 |
|
21909 <li class="param"> |
|
21910 |
|
21911 <code class="param-name">type</code> |
|
21912 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
21913 |
|
21914 |
|
21915 |
|
21916 |
|
21917 <div class="param-description"> |
|
21918 <p>the event type to delegate</p> |
|
21919 </div> |
|
21920 |
|
21921 |
|
21922 </li> |
|
21923 |
|
21924 <li class="param"> |
|
21925 |
|
21926 <code class="param-name">fn</code> |
|
21927 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
21928 |
|
21929 |
|
21930 |
|
21931 |
|
21932 <div class="param-description"> |
|
21933 <p>the callback function to execute. This function |
|
21934 will be provided the event object for the delegated event.</p> |
|
21935 </div> |
|
21936 |
|
21937 |
|
21938 </li> |
|
21939 |
|
21940 <li class="param"> |
|
21941 |
|
21942 <code class="param-name">spec</code> |
|
21943 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
21944 |
|
21945 |
|
21946 |
|
21947 |
|
21948 <div class="param-description"> |
|
21949 <p>a selector that must match the target of the |
|
21950 event or a function to test target and its parents for a match</p> |
|
21951 </div> |
|
21952 |
|
21953 |
|
21954 </li> |
|
21955 |
|
21956 <li class="param"> |
|
21957 |
|
21958 <code class="param-name">context</code> |
|
21959 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
21960 |
|
21961 |
|
21962 |
|
21963 |
|
21964 <div class="param-description"> |
|
21965 <p>optional argument that specifies what 'this' refers to</p> |
|
21966 </div> |
|
21967 |
|
21968 |
|
21969 </li> |
|
21970 |
|
21971 <li class="param"> |
|
21972 |
|
21973 <code class="param-name">args</code> |
|
21974 <span class="type">Any</span> |
|
21975 |
|
21976 |
|
21977 |
|
21978 <span class="flag multiple" title="This argument may occur one or more times.">multiple</span> |
|
21979 |
|
21980 |
|
21981 <div class="param-description"> |
|
21982 <p>0..n additional arguments to pass on to the callback |
|
21983 function. These arguments will be added after the event object.</p> |
|
21984 </div> |
|
21985 |
|
21986 |
|
21987 </li> |
|
21988 |
|
21989 </ul> |
|
21990 </div> |
|
21991 |
|
21992 |
|
21993 |
|
21994 <div class="returns"> |
|
21995 <h4>Returns:</h4> |
|
21996 |
|
21997 <div class="returns-description"> |
|
21998 |
|
21999 |
|
22000 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
22001 |
|
22002 the detach handle |
|
22003 |
|
22004 </div> |
|
22005 </div> |
|
22006 |
|
22007 |
|
22008 |
|
22009 </div> |
|
22010 |
|
22011 |
|
22012 <div id="method_destroy" class="method item inherited"> |
|
22013 <h3 class="name"><code>destroy</code></h3> |
|
22014 |
|
22015 |
|
22016 <div class="args"> |
|
22017 <span class="paren">(</span><ul class="args-list inline commas"> |
|
22018 |
|
22019 <li class="arg"> |
|
22020 |
|
22021 <code>destroyAllNodes</code> |
|
22022 |
|
22023 </li> |
|
22024 |
|
22025 </ul><span class="paren">)</span> |
|
22026 </div> |
|
22027 |
|
22028 |
|
22029 |
|
22030 <span class="returns-inline"> |
|
22031 <span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span> |
|
22032 </span> |
|
22033 |
|
22034 |
|
22035 |
|
22036 |
|
22037 |
|
22038 |
|
22039 |
|
22040 |
|
22041 |
|
22042 |
|
22043 |
|
22044 <span class="flag chainable">chainable</span> |
|
22045 |
|
22046 |
|
22047 |
|
22048 |
|
22049 <div class="meta"> |
|
22050 |
|
22051 <p>Inherited from |
|
22052 <a href="../classes/BaseObservable.html#method_destroy"> |
|
22053 BaseObservable |
|
22054 </a> |
|
22055 |
|
22056 but overwritten in |
|
22057 |
|
22058 |
|
22059 |
|
22060 <a href="../files/widget_js_Widget.js.html#l452"><code>widget/js/Widget.js:452</code></a> |
|
22061 |
|
22062 </p> |
|
22063 |
|
22064 |
|
22065 |
|
22066 |
|
22067 |
|
22068 </div> |
|
22069 |
|
22070 <div class="description"> |
|
22071 <p> |
|
22072 Destroy lifecycle method. Fires the destroy |
|
22073 event, prior to invoking destructors for the |
|
22074 class hierarchy. |
|
22075 |
|
22076 Overrides Base's implementation, to support arguments to destroy |
|
22077 </p> |
|
22078 |
|
22079 <p> |
|
22080 Subscribers to the destroy |
|
22081 event can invoke preventDefault on the event object, to prevent destruction |
|
22082 from proceeding. |
|
22083 </p> |
|
22084 </div> |
|
22085 |
|
22086 |
|
22087 <div class="params"> |
|
22088 <h4>Parameters:</h4> |
|
22089 |
|
22090 <ul class="params-list"> |
|
22091 |
|
22092 <li class="param"> |
|
22093 |
|
22094 <code class="param-name">destroyAllNodes</code> |
|
22095 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
22096 |
|
22097 |
|
22098 |
|
22099 |
|
22100 <div class="param-description"> |
|
22101 <p>If true, all nodes contained within the Widget are |
|
22102 removed and destroyed. Defaults to false due to potentially high run-time cost.</p> |
|
22103 </div> |
|
22104 |
|
22105 |
|
22106 </li> |
|
22107 |
|
22108 </ul> |
|
22109 </div> |
|
22110 |
|
22111 |
|
22112 |
|
22113 <div class="returns"> |
|
22114 <h4>Returns:</h4> |
|
22115 |
|
22116 <div class="returns-description"> |
|
22117 |
|
22118 |
|
22119 <span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>: |
|
22120 |
|
22121 A reference to this object |
|
22122 |
|
22123 </div> |
|
22124 </div> |
|
22125 |
|
22126 |
|
22127 |
|
22128 </div> |
|
22129 |
|
22130 |
|
22131 <div id="method_destructor" class="method item protected"> |
|
22132 <h3 class="name"><code>destructor</code></h3> |
|
22133 |
|
22134 |
|
22135 <span class="paren">()</span> |
|
22136 |
|
22137 |
|
22138 |
|
22139 |
|
22140 |
|
22141 |
|
22142 |
|
22143 <span class="flag protected">protected</span> |
|
22144 |
|
22145 |
|
22146 |
|
22147 |
|
22148 |
|
22149 |
|
22150 |
|
22151 |
|
22152 |
|
22153 |
|
22154 <div class="meta"> |
|
22155 |
|
22156 |
|
22157 |
|
22158 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
22159 |
|
22160 <p> |
|
22161 |
|
22162 Defined in |
|
22163 |
|
22164 |
|
22165 |
|
22166 |
|
22167 <a href="../files/datatable_js_scroll.js.html#l588"><code>datatable/js/scroll.js:588</code></a> |
|
22168 |
|
22169 </p> |
|
22170 |
|
22171 |
|
22172 |
|
22173 |
|
22174 |
|
22175 <p>Available since 3.5.0</p> |
|
22176 |
|
22177 </div> |
|
22178 |
|
22179 <div class="description"> |
|
22180 <p>Cleans up external event subscriptions.</p> |
|
22181 </div> |
|
22182 |
|
22183 |
|
22184 |
|
22185 |
|
22186 |
|
22187 |
|
22188 </div> |
|
22189 |
|
22190 |
|
22191 <div id="method_destructor" class="method item protected"> |
|
22192 <h3 class="name"><code>destructor</code></h3> |
|
22193 |
|
22194 |
|
22195 <span class="paren">()</span> |
|
22196 |
|
22197 |
|
22198 |
|
22199 |
|
22200 |
|
22201 |
|
22202 |
|
22203 <span class="flag protected">protected</span> |
|
22204 |
|
22205 |
|
22206 |
|
22207 |
|
22208 |
|
22209 |
|
22210 |
|
22211 |
|
22212 |
|
22213 |
|
22214 <div class="meta"> |
|
22215 |
|
22216 <p>Inherited from |
|
22217 <a href="../classes/Widget.html#method_destructor"> |
|
22218 Widget |
|
22219 </a> |
|
22220 |
|
22221 but overwritten in |
|
22222 |
|
22223 |
|
22224 |
|
22225 <a href="../files/datatable_js_core.js.html#l420"><code>datatable/js/core.js:420</code></a> |
|
22226 |
|
22227 </p> |
|
22228 |
|
22229 |
|
22230 |
|
22231 |
|
22232 |
|
22233 <p>Available since 3.6.0</p> |
|
22234 |
|
22235 </div> |
|
22236 |
|
22237 <div class="description"> |
|
22238 <p>Tears down the instance.</p> |
|
22239 </div> |
|
22240 |
|
22241 |
|
22242 |
|
22243 |
|
22244 |
|
22245 |
|
22246 </div> |
|
22247 |
|
22248 |
|
22249 <div id="method_detach" class="method item inherited"> |
|
22250 <h3 class="name"><code>detach</code></h3> |
|
22251 |
|
22252 |
|
22253 <div class="args"> |
|
22254 <span class="paren">(</span><ul class="args-list inline commas"> |
|
22255 |
|
22256 <li class="arg"> |
|
22257 |
|
22258 <code>type</code> |
|
22259 |
|
22260 </li> |
|
22261 |
|
22262 <li class="arg"> |
|
22263 |
|
22264 <code>fn</code> |
|
22265 |
|
22266 </li> |
|
22267 |
|
22268 <li class="arg"> |
|
22269 |
|
22270 <code>context</code> |
|
22271 |
|
22272 </li> |
|
22273 |
|
22274 </ul><span class="paren">)</span> |
|
22275 </div> |
|
22276 |
|
22277 |
|
22278 |
|
22279 <span class="returns-inline"> |
|
22280 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
22281 </span> |
|
22282 |
|
22283 |
|
22284 |
|
22285 |
|
22286 |
|
22287 |
|
22288 |
|
22289 |
|
22290 |
|
22291 |
|
22292 |
|
22293 |
|
22294 |
|
22295 |
|
22296 <div class="meta"> |
|
22297 |
|
22298 |
|
22299 <p>Inherited from |
|
22300 <a href="../classes/EventTarget.html#method_detach">EventTarget</a>: |
|
22301 |
|
22302 |
|
22303 |
|
22304 <a href="../files/event-custom_js_event-target.js.html#l346"><code>event-custom/js/event-target.js:346</code></a> |
|
22305 |
|
22306 </p> |
|
22307 |
|
22308 |
|
22309 |
|
22310 |
|
22311 |
|
22312 </div> |
|
22313 |
|
22314 <div class="description"> |
|
22315 <p>Detach one or more listeners the from the specified event</p> |
|
22316 </div> |
|
22317 |
|
22318 |
|
22319 <div class="params"> |
|
22320 <h4>Parameters:</h4> |
|
22321 |
|
22322 <ul class="params-list"> |
|
22323 |
|
22324 <li class="param"> |
|
22325 |
|
22326 <code class="param-name">type</code> |
|
22327 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
22328 |
|
22329 |
|
22330 |
|
22331 |
|
22332 <div class="param-description"> |
|
22333 <p>Either the handle to the subscriber or the |
|
22334 type of event. If the type |
|
22335 is not specified, it will attempt to remove |
|
22336 the listener from all hosted events.</p> |
|
22337 </div> |
|
22338 |
|
22339 |
|
22340 </li> |
|
22341 |
|
22342 <li class="param"> |
|
22343 |
|
22344 <code class="param-name">fn</code> |
|
22345 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
22346 |
|
22347 |
|
22348 |
|
22349 |
|
22350 <div class="param-description"> |
|
22351 <p>The subscribed function to unsubscribe, if not |
|
22352 supplied, all subscribers will be removed.</p> |
|
22353 </div> |
|
22354 |
|
22355 |
|
22356 </li> |
|
22357 |
|
22358 <li class="param"> |
|
22359 |
|
22360 <code class="param-name">context</code> |
|
22361 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
22362 |
|
22363 |
|
22364 |
|
22365 |
|
22366 <div class="param-description"> |
|
22367 <p>The custom object passed to subscribe. This is |
|
22368 optional, but if supplied will be used to |
|
22369 disambiguate multiple listeners that are the same |
|
22370 (e.g., you subscribe many object using a function |
|
22371 that lives on the prototype)</p> |
|
22372 </div> |
|
22373 |
|
22374 |
|
22375 </li> |
|
22376 |
|
22377 </ul> |
|
22378 </div> |
|
22379 |
|
22380 |
|
22381 |
|
22382 <div class="returns"> |
|
22383 <h4>Returns:</h4> |
|
22384 |
|
22385 <div class="returns-description"> |
|
22386 |
|
22387 |
|
22388 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>: |
|
22389 |
|
22390 the host |
|
22391 |
|
22392 </div> |
|
22393 </div> |
|
22394 |
|
22395 |
|
22396 |
|
22397 </div> |
|
22398 |
|
22399 |
|
22400 <div id="method_detachAll" class="method item inherited"> |
|
22401 <h3 class="name"><code>detachAll</code></h3> |
|
22402 |
|
22403 |
|
22404 <div class="args"> |
|
22405 <span class="paren">(</span><ul class="args-list inline commas"> |
|
22406 |
|
22407 <li class="arg"> |
|
22408 |
|
22409 <code>type</code> |
|
22410 |
|
22411 </li> |
|
22412 |
|
22413 </ul><span class="paren">)</span> |
|
22414 </div> |
|
22415 |
|
22416 |
|
22417 |
|
22418 |
|
22419 |
|
22420 |
|
22421 |
|
22422 |
|
22423 |
|
22424 |
|
22425 |
|
22426 |
|
22427 |
|
22428 |
|
22429 |
|
22430 |
|
22431 <div class="meta"> |
|
22432 |
|
22433 |
|
22434 <p>Inherited from |
|
22435 <a href="../classes/EventTarget.html#method_detachAll">EventTarget</a>: |
|
22436 |
|
22437 |
|
22438 |
|
22439 <a href="../files/event-custom_js_event-target.js.html#l469"><code>event-custom/js/event-target.js:469</code></a> |
|
22440 |
|
22441 </p> |
|
22442 |
|
22443 |
|
22444 |
|
22445 |
|
22446 |
|
22447 </div> |
|
22448 |
|
22449 <div class="description"> |
|
22450 <p>Removes all listeners from the specified event. If the event type |
|
22451 is not specified, all listeners from all hosted custom events will |
|
22452 be removed.</p> |
|
22453 </div> |
|
22454 |
|
22455 |
|
22456 <div class="params"> |
|
22457 <h4>Parameters:</h4> |
|
22458 |
|
22459 <ul class="params-list"> |
|
22460 |
|
22461 <li class="param"> |
|
22462 |
|
22463 <code class="param-name">type</code> |
|
22464 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
22465 |
|
22466 |
|
22467 |
|
22468 |
|
22469 <div class="param-description"> |
|
22470 <p>The type, or name of the event</p> |
|
22471 </div> |
|
22472 |
|
22473 |
|
22474 </li> |
|
22475 |
|
22476 </ul> |
|
22477 </div> |
|
22478 |
|
22479 |
|
22480 |
|
22481 |
|
22482 |
|
22483 </div> |
|
22484 |
|
22485 |
|
22486 <div id="method_disable" class="method item inherited"> |
|
22487 <h3 class="name"><code>disable</code></h3> |
|
22488 |
|
22489 |
|
22490 <span class="paren">()</span> |
|
22491 |
|
22492 |
|
22493 |
|
22494 |
|
22495 |
|
22496 |
|
22497 |
|
22498 |
|
22499 |
|
22500 |
|
22501 |
|
22502 |
|
22503 |
|
22504 <span class="flag chainable">chainable</span> |
|
22505 |
|
22506 |
|
22507 |
|
22508 |
|
22509 <div class="meta"> |
|
22510 |
|
22511 |
|
22512 <p>Inherited from |
|
22513 <a href="../classes/Widget.html#method_disable">Widget</a>: |
|
22514 |
|
22515 |
|
22516 |
|
22517 <a href="../files/widget_js_Widget.js.html#l692"><code>widget/js/Widget.js:692</code></a> |
|
22518 |
|
22519 </p> |
|
22520 |
|
22521 |
|
22522 |
|
22523 |
|
22524 |
|
22525 </div> |
|
22526 |
|
22527 <div class="description"> |
|
22528 <p>Set the Widget's "disabled" attribute to "true".</p> |
|
22529 </div> |
|
22530 |
|
22531 |
|
22532 |
|
22533 |
|
22534 |
|
22535 |
|
22536 </div> |
|
22537 |
|
22538 |
|
22539 <div id="method_enable" class="method item inherited"> |
|
22540 <h3 class="name"><code>enable</code></h3> |
|
22541 |
|
22542 |
|
22543 <span class="paren">()</span> |
|
22544 |
|
22545 |
|
22546 |
|
22547 |
|
22548 |
|
22549 |
|
22550 |
|
22551 |
|
22552 |
|
22553 |
|
22554 |
|
22555 |
|
22556 |
|
22557 <span class="flag chainable">chainable</span> |
|
22558 |
|
22559 |
|
22560 |
|
22561 |
|
22562 <div class="meta"> |
|
22563 |
|
22564 |
|
22565 <p>Inherited from |
|
22566 <a href="../classes/Widget.html#method_enable">Widget</a>: |
|
22567 |
|
22568 |
|
22569 |
|
22570 <a href="../files/widget_js_Widget.js.html#l683"><code>widget/js/Widget.js:683</code></a> |
|
22571 |
|
22572 </p> |
|
22573 |
|
22574 |
|
22575 |
|
22576 |
|
22577 |
|
22578 </div> |
|
22579 |
|
22580 <div class="description"> |
|
22581 <p>Set the Widget's "disabled" attribute to "false".</p> |
|
22582 </div> |
|
22583 |
|
22584 |
|
22585 |
|
22586 |
|
22587 |
|
22588 |
|
22589 </div> |
|
22590 |
|
22591 |
|
22592 <div id="method_fire" class="method item inherited"> |
|
22593 <h3 class="name"><code>fire</code></h3> |
|
22594 |
|
22595 |
|
22596 <div class="args"> |
|
22597 <span class="paren">(</span><ul class="args-list inline commas"> |
|
22598 |
|
22599 <li class="arg"> |
|
22600 |
|
22601 <code>type</code> |
|
22602 |
|
22603 </li> |
|
22604 |
|
22605 <li class="arg"> |
|
22606 |
|
22607 <code>arguments</code> |
|
22608 |
|
22609 </li> |
|
22610 |
|
22611 </ul><span class="paren">)</span> |
|
22612 </div> |
|
22613 |
|
22614 |
|
22615 |
|
22616 <span class="returns-inline"> |
|
22617 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
22618 </span> |
|
22619 |
|
22620 |
|
22621 |
|
22622 |
|
22623 |
|
22624 |
|
22625 |
|
22626 |
|
22627 |
|
22628 |
|
22629 |
|
22630 |
|
22631 |
|
22632 |
|
22633 <div class="meta"> |
|
22634 |
|
22635 |
|
22636 <p>Inherited from |
|
22637 <a href="../classes/EventTarget.html#method_fire">EventTarget</a>: |
|
22638 |
|
22639 |
|
22640 |
|
22641 <a href="../files/event-custom_js_event-target.js.html#l695"><code>event-custom/js/event-target.js:695</code></a> |
|
22642 |
|
22643 </p> |
|
22644 |
|
22645 |
|
22646 |
|
22647 |
|
22648 |
|
22649 </div> |
|
22650 |
|
22651 <div class="description"> |
|
22652 <p>Fire a custom event by name. The callback functions will be executed |
|
22653 from the context specified when the event was created, and with the |
|
22654 following parameters.</p> |
|
22655 |
|
22656 <p>If the custom event object hasn't been created, then the event hasn't |
|
22657 been published and it has no subscribers. For performance sake, we |
|
22658 immediate exit in this case. This means the event won't bubble, so |
|
22659 if the intention is that a bubble target be notified, the event must |
|
22660 be published on this object first.</p> |
|
22661 |
|
22662 <p>The first argument is the event type, and any additional arguments are |
|
22663 passed to the listeners as parameters. If the first of these is an |
|
22664 object literal, and the event is configured to emit an event facade, |
|
22665 that object is mixed into the event facade and the facade is provided |
|
22666 in place of the original object.</p> |
|
22667 </div> |
|
22668 |
|
22669 |
|
22670 <div class="params"> |
|
22671 <h4>Parameters:</h4> |
|
22672 |
|
22673 <ul class="params-list"> |
|
22674 |
|
22675 <li class="param"> |
|
22676 |
|
22677 <code class="param-name">type</code> |
|
22678 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
22679 |
|
22680 |
|
22681 |
|
22682 |
|
22683 <div class="param-description"> |
|
22684 <p>The type of the event, or an object that contains |
|
22685 a 'type' property.</p> |
|
22686 </div> |
|
22687 |
|
22688 |
|
22689 </li> |
|
22690 |
|
22691 <li class="param"> |
|
22692 |
|
22693 <code class="param-name">arguments</code> |
|
22694 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object*</a></span> |
|
22695 |
|
22696 |
|
22697 |
|
22698 |
|
22699 <div class="param-description"> |
|
22700 <p>an arbitrary set of parameters to pass to |
|
22701 the handler. If the first of these is an object literal and the event is |
|
22702 configured to emit an event facade, the event facade will replace that |
|
22703 parameter after the properties the object literal contains are copied to |
|
22704 the event facade.</p> |
|
22705 </div> |
|
22706 |
|
22707 |
|
22708 </li> |
|
22709 |
|
22710 </ul> |
|
22711 </div> |
|
22712 |
|
22713 |
|
22714 |
|
22715 <div class="returns"> |
|
22716 <h4>Returns:</h4> |
|
22717 |
|
22718 <div class="returns-description"> |
|
22719 |
|
22720 |
|
22721 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>: |
|
22722 |
|
22723 the event host |
|
22724 |
|
22725 </div> |
|
22726 </div> |
|
22727 |
|
22728 |
|
22729 |
|
22730 </div> |
|
22731 |
|
22732 |
|
22733 <div id="method_focus" class="method item inherited"> |
|
22734 <h3 class="name"><code>focus</code></h3> |
|
22735 |
|
22736 |
|
22737 <span class="paren">()</span> |
|
22738 |
|
22739 |
|
22740 |
|
22741 |
|
22742 |
|
22743 |
|
22744 |
|
22745 |
|
22746 |
|
22747 |
|
22748 |
|
22749 |
|
22750 |
|
22751 <span class="flag chainable">chainable</span> |
|
22752 |
|
22753 |
|
22754 |
|
22755 |
|
22756 <div class="meta"> |
|
22757 |
|
22758 |
|
22759 <p>Inherited from |
|
22760 <a href="../classes/Widget.html#method_focus">Widget</a>: |
|
22761 |
|
22762 |
|
22763 |
|
22764 <a href="../files/widget_js_Widget.js.html#l663"><code>widget/js/Widget.js:663</code></a> |
|
22765 |
|
22766 </p> |
|
22767 |
|
22768 |
|
22769 |
|
22770 |
|
22771 |
|
22772 </div> |
|
22773 |
|
22774 <div class="description"> |
|
22775 <p>Causes the Widget to receive the focus by setting the "focused" |
|
22776 attribute to "true".</p> |
|
22777 </div> |
|
22778 |
|
22779 |
|
22780 |
|
22781 |
|
22782 |
|
22783 |
|
22784 </div> |
|
22785 |
|
22786 |
|
22787 <div id="method_get" class="method item inherited"> |
|
22788 <h3 class="name"><code>get</code></h3> |
|
22789 |
|
22790 |
|
22791 <div class="args"> |
|
22792 <span class="paren">(</span><ul class="args-list inline commas"> |
|
22793 |
|
22794 <li class="arg"> |
|
22795 |
|
22796 <code>name</code> |
|
22797 |
|
22798 </li> |
|
22799 |
|
22800 </ul><span class="paren">)</span> |
|
22801 </div> |
|
22802 |
|
22803 |
|
22804 |
|
22805 <span class="returns-inline"> |
|
22806 <span class="type">Any</span> |
|
22807 </span> |
|
22808 |
|
22809 |
|
22810 |
|
22811 |
|
22812 |
|
22813 |
|
22814 |
|
22815 |
|
22816 |
|
22817 |
|
22818 |
|
22819 |
|
22820 |
|
22821 |
|
22822 <div class="meta"> |
|
22823 |
|
22824 |
|
22825 <p>Inherited from |
|
22826 <a href="../classes/AttributeCore.html#method_get">AttributeCore</a>: |
|
22827 |
|
22828 |
|
22829 |
|
22830 <a href="../files/attribute_js_AttributeCore.js.html#l353"><code>attribute/js/AttributeCore.js:353</code></a> |
|
22831 |
|
22832 </p> |
|
22833 |
|
22834 |
|
22835 |
|
22836 |
|
22837 |
|
22838 </div> |
|
22839 |
|
22840 <div class="description"> |
|
22841 <p>Returns the current value of the attribute. If the attribute |
|
22842 has been configured with a 'getter' function, this method will delegate |
|
22843 to the 'getter' to obtain the value of the attribute.</p> |
|
22844 </div> |
|
22845 |
|
22846 |
|
22847 <div class="params"> |
|
22848 <h4>Parameters:</h4> |
|
22849 |
|
22850 <ul class="params-list"> |
|
22851 |
|
22852 <li class="param"> |
|
22853 |
|
22854 <code class="param-name">name</code> |
|
22855 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
22856 |
|
22857 |
|
22858 |
|
22859 |
|
22860 <div class="param-description"> |
|
22861 <p>The name of the attribute. If the value of the attribute is an Object, |
|
22862 dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</p> |
|
22863 </div> |
|
22864 |
|
22865 |
|
22866 </li> |
|
22867 |
|
22868 </ul> |
|
22869 </div> |
|
22870 |
|
22871 |
|
22872 |
|
22873 <div class="returns"> |
|
22874 <h4>Returns:</h4> |
|
22875 |
|
22876 <div class="returns-description"> |
|
22877 |
|
22878 |
|
22879 <span class="type">Any</span>: |
|
22880 |
|
22881 The value of the attribute |
|
22882 |
|
22883 </div> |
|
22884 </div> |
|
22885 |
|
22886 |
|
22887 |
|
22888 </div> |
|
22889 |
|
22890 |
|
22891 <div id="method_getAttrs" class="method item inherited"> |
|
22892 <h3 class="name"><code>getAttrs</code></h3> |
|
22893 |
|
22894 |
|
22895 <div class="args"> |
|
22896 <span class="paren">(</span><ul class="args-list inline commas"> |
|
22897 |
|
22898 <li class="arg"> |
|
22899 |
|
22900 <code>attrs</code> |
|
22901 |
|
22902 </li> |
|
22903 |
|
22904 </ul><span class="paren">)</span> |
|
22905 </div> |
|
22906 |
|
22907 |
|
22908 |
|
22909 <span class="returns-inline"> |
|
22910 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
22911 </span> |
|
22912 |
|
22913 |
|
22914 |
|
22915 |
|
22916 |
|
22917 |
|
22918 |
|
22919 |
|
22920 |
|
22921 |
|
22922 |
|
22923 |
|
22924 |
|
22925 |
|
22926 <div class="meta"> |
|
22927 |
|
22928 |
|
22929 <p>Inherited from |
|
22930 <a href="../classes/AttributeCore.html#method_getAttrs">AttributeCore</a>: |
|
22931 |
|
22932 |
|
22933 |
|
22934 <a href="../files/attribute_js_AttributeCore.js.html#l762"><code>attribute/js/AttributeCore.js:762</code></a> |
|
22935 |
|
22936 </p> |
|
22937 |
|
22938 |
|
22939 |
|
22940 |
|
22941 |
|
22942 </div> |
|
22943 |
|
22944 <div class="description"> |
|
22945 <p>Gets multiple attribute values.</p> |
|
22946 </div> |
|
22947 |
|
22948 |
|
22949 <div class="params"> |
|
22950 <h4>Parameters:</h4> |
|
22951 |
|
22952 <ul class="params-list"> |
|
22953 |
|
22954 <li class="param"> |
|
22955 |
|
22956 <code class="param-name">attrs</code> |
|
22957 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span> |
|
22958 |
|
22959 |
|
22960 |
|
22961 |
|
22962 <div class="param-description"> |
|
22963 <p>Optional. An array of attribute names. If omitted, all attribute values are |
|
22964 returned. If set to true, all attributes modified from their initial values are returned.</p> |
|
22965 </div> |
|
22966 |
|
22967 |
|
22968 </li> |
|
22969 |
|
22970 </ul> |
|
22971 </div> |
|
22972 |
|
22973 |
|
22974 |
|
22975 <div class="returns"> |
|
22976 <h4>Returns:</h4> |
|
22977 |
|
22978 <div class="returns-description"> |
|
22979 |
|
22980 |
|
22981 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
22982 |
|
22983 An object with attribute name/value pairs. |
|
22984 |
|
22985 </div> |
|
22986 </div> |
|
22987 |
|
22988 |
|
22989 |
|
22990 </div> |
|
22991 |
|
22992 |
|
22993 <div id="method_getCell" class="method item inherited"> |
|
22994 <h3 class="name"><code>getCell</code></h3> |
|
22995 |
|
22996 |
|
22997 <div class="args"> |
|
22998 <span class="paren">(</span><ul class="args-list inline commas"> |
|
22999 |
|
23000 <li class="arg"> |
|
23001 |
|
23002 <code>seed</code> |
|
23003 |
|
23004 </li> |
|
23005 |
|
23006 <li class="arg"> |
|
23007 |
|
23008 <code class="optional">[shift]</code> |
|
23009 |
|
23010 </li> |
|
23011 |
|
23012 </ul><span class="paren">)</span> |
|
23013 </div> |
|
23014 |
|
23015 |
|
23016 |
|
23017 <span class="returns-inline"> |
|
23018 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
23019 </span> |
|
23020 |
|
23021 |
|
23022 |
|
23023 |
|
23024 |
|
23025 |
|
23026 |
|
23027 |
|
23028 |
|
23029 |
|
23030 |
|
23031 |
|
23032 |
|
23033 |
|
23034 <div class="meta"> |
|
23035 |
|
23036 |
|
23037 <p>Inherited from |
|
23038 <a href="../classes/DataTable.Base.html#method_getCell">DataTable.Base</a>: |
|
23039 |
|
23040 |
|
23041 |
|
23042 <a href="../files/datatable_js_base.js.html#l253"><code>datatable/js/base.js:253</code></a> |
|
23043 |
|
23044 </p> |
|
23045 |
|
23046 |
|
23047 |
|
23048 |
|
23049 |
|
23050 <p>Available since 3.5.0</p> |
|
23051 |
|
23052 </div> |
|
23053 |
|
23054 <div class="description"> |
|
23055 <p>Returns the <code><td></code> Node from the given row and column index. Alternately, |
|
23056 the <code>seed</code> can be a Node. If so, the nearest ancestor cell is returned. |
|
23057 If the <code>seed</code> is a cell, it is returned. If there is no cell at the given |
|
23058 coordinates, <code>null</code> is returned.</p> |
|
23059 |
|
23060 <p>Optionally, include an offset array or string to return a cell near the |
|
23061 cell identified by the <code>seed</code>. The offset can be an array containing the |
|
23062 number of rows to shift followed by the number of columns to shift, or one |
|
23063 of "above", "below", "next", or "previous".</p> |
|
23064 |
|
23065 <p><pre class="code prettyprint"><code>// Previous cell in the previous row |
|
23066 var cell = table.getCell(e.target, [-1, -1]);</p> |
|
23067 |
|
23068 <p>// Next cell |
|
23069 var cell = table.getCell(e.target, 'next'); |
|
23070 var cell = table.getCell(e.taregt, [0, 1];</pre></code></p> |
|
23071 |
|
23072 <p>This is actually just a pass through to the <code>view</code> instance's method |
|
23073 by the same name.</p> |
|
23074 </div> |
|
23075 |
|
23076 |
|
23077 <div class="params"> |
|
23078 <h4>Parameters:</h4> |
|
23079 |
|
23080 <ul class="params-list"> |
|
23081 |
|
23082 <li class="param"> |
|
23083 |
|
23084 <code class="param-name">seed</code> |
|
23085 <span class="type"><a href="../classes/Number.html" class="crosslink">Number[]</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
23086 |
|
23087 |
|
23088 |
|
23089 |
|
23090 <div class="param-description"> |
|
23091 <p>Array of row and column indexes, or a Node that |
|
23092 is either the cell itself or a descendant of one.</p> |
|
23093 </div> |
|
23094 |
|
23095 |
|
23096 </li> |
|
23097 |
|
23098 <li class="param"> |
|
23099 |
|
23100 <code class="param-name optional">[shift]</code> |
|
23101 <span class="type"><a href="../classes/Number.html" class="crosslink">Number[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
23102 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
23103 |
|
23104 |
|
23105 |
|
23106 |
|
23107 <div class="param-description"> |
|
23108 <p>Offset by which to identify the returned |
|
23109 cell Node</p> |
|
23110 </div> |
|
23111 |
|
23112 |
|
23113 </li> |
|
23114 |
|
23115 </ul> |
|
23116 </div> |
|
23117 |
|
23118 |
|
23119 |
|
23120 <div class="returns"> |
|
23121 <h4>Returns:</h4> |
|
23122 |
|
23123 <div class="returns-description"> |
|
23124 |
|
23125 |
|
23126 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
23127 |
|
23128 |
|
23129 </div> |
|
23130 </div> |
|
23131 |
|
23132 |
|
23133 |
|
23134 </div> |
|
23135 |
|
23136 |
|
23137 <div id="method_getClassName" class="method item inherited"> |
|
23138 <h3 class="name"><code>getClassName</code></h3> |
|
23139 |
|
23140 |
|
23141 <div class="args"> |
|
23142 <span class="paren">(</span><ul class="args-list inline commas"> |
|
23143 |
|
23144 <li class="arg"> |
|
23145 |
|
23146 <code>args</code> |
|
23147 |
|
23148 </li> |
|
23149 |
|
23150 </ul><span class="paren">)</span> |
|
23151 </div> |
|
23152 |
|
23153 |
|
23154 |
|
23155 |
|
23156 |
|
23157 |
|
23158 |
|
23159 |
|
23160 |
|
23161 |
|
23162 |
|
23163 |
|
23164 |
|
23165 |
|
23166 |
|
23167 |
|
23168 <div class="meta"> |
|
23169 |
|
23170 <p>Inherited from |
|
23171 <a href="../classes/Widget.html#method_getClassName"> |
|
23172 Widget |
|
23173 </a> |
|
23174 |
|
23175 but overwritten in |
|
23176 |
|
23177 |
|
23178 |
|
23179 <a href="../files/widget_js_Widget.js.html#l309"><code>widget/js/Widget.js:309</code></a> |
|
23180 |
|
23181 </p> |
|
23182 |
|
23183 |
|
23184 |
|
23185 |
|
23186 |
|
23187 </div> |
|
23188 |
|
23189 <div class="description"> |
|
23190 <p>Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined |
|
23191 by the <code>Y.config.classNamePrefix</code> attribute used by <code>ClassNameManager</code> and |
|
23192 <code>Widget.NAME.toLowerCase()</code> (e.g. "yui-widget-xxxxx-yyyyy", based on default values for |
|
23193 the prefix and widget class name).</p> |
|
23194 |
|
23195 <p> |
|
23196 The instance based version of this method can be used to generate standard prefixed classnames, |
|
23197 based on the instances NAME, as opposed to Widget.NAME. This method should be used when you |
|
23198 need to use a constant class name across different types instances. |
|
23199 </p> |
|
23200 </div> |
|
23201 |
|
23202 |
|
23203 <div class="params"> |
|
23204 <h4>Parameters:</h4> |
|
23205 |
|
23206 <ul class="params-list"> |
|
23207 |
|
23208 <li class="param"> |
|
23209 |
|
23210 <code class="param-name">args</code> |
|
23211 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String*</a></span> |
|
23212 |
|
23213 |
|
23214 |
|
23215 <span class="flag multiple" title="This argument may occur one or more times.">multiple</span> |
|
23216 |
|
23217 |
|
23218 <div class="param-description"> |
|
23219 <p>0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name</p> |
|
23220 </div> |
|
23221 |
|
23222 |
|
23223 </li> |
|
23224 |
|
23225 </ul> |
|
23226 </div> |
|
23227 |
|
23228 |
|
23229 |
|
23230 |
|
23231 |
|
23232 </div> |
|
23233 |
|
23234 |
|
23235 <div id="method_getColumn" class="method item"> |
|
23236 <h3 class="name"><code>getColumn</code></h3> |
|
23237 |
|
23238 |
|
23239 <div class="args"> |
|
23240 <span class="paren">(</span><ul class="args-list inline commas"> |
|
23241 |
|
23242 <li class="arg"> |
|
23243 |
|
23244 <code>name</code> |
|
23245 |
|
23246 </li> |
|
23247 |
|
23248 </ul><span class="paren">)</span> |
|
23249 </div> |
|
23250 |
|
23251 |
|
23252 |
|
23253 <span class="returns-inline"> |
|
23254 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
23255 </span> |
|
23256 |
|
23257 |
|
23258 |
|
23259 |
|
23260 |
|
23261 |
|
23262 |
|
23263 |
|
23264 |
|
23265 |
|
23266 |
|
23267 |
|
23268 |
|
23269 |
|
23270 <div class="meta"> |
|
23271 |
|
23272 |
|
23273 |
|
23274 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
23275 |
|
23276 <p> |
|
23277 |
|
23278 Defined in |
|
23279 |
|
23280 |
|
23281 |
|
23282 |
|
23283 <a href="../files/datatable_js_core.js.html#l213"><code>datatable/js/core.js:213</code></a> |
|
23284 |
|
23285 </p> |
|
23286 |
|
23287 |
|
23288 |
|
23289 |
|
23290 |
|
23291 <p>Available since 3.5.0</p> |
|
23292 |
|
23293 </div> |
|
23294 |
|
23295 <div class="description"> |
|
23296 <p>Gets the column configuration object for the given key, name, or index. For |
|
23297 nested columns, <code>name</code> can be an array of indexes, each identifying the index |
|
23298 of that column in the respective parent's "children" array.</p> |
|
23299 |
|
23300 <p>If you pass a column object, it will be returned.</p> |
|
23301 |
|
23302 <p>For columns with keys, you can also fetch the column with |
|
23303 <code>instance.get('columns.foo')</code>.</p> |
|
23304 </div> |
|
23305 |
|
23306 |
|
23307 <div class="params"> |
|
23308 <h4>Parameters:</h4> |
|
23309 |
|
23310 <ul class="params-list"> |
|
23311 |
|
23312 <li class="param"> |
|
23313 |
|
23314 <code class="param-name">name</code> |
|
23315 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span> |
|
23316 |
|
23317 |
|
23318 |
|
23319 |
|
23320 <div class="param-description"> |
|
23321 <p>Key, "name", index, or index array to |
|
23322 identify the column</p> |
|
23323 </div> |
|
23324 |
|
23325 |
|
23326 </li> |
|
23327 |
|
23328 </ul> |
|
23329 </div> |
|
23330 |
|
23331 |
|
23332 |
|
23333 <div class="returns"> |
|
23334 <h4>Returns:</h4> |
|
23335 |
|
23336 <div class="returns-description"> |
|
23337 |
|
23338 |
|
23339 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
23340 |
|
23341 the column configuration object |
|
23342 |
|
23343 </div> |
|
23344 </div> |
|
23345 |
|
23346 |
|
23347 |
|
23348 </div> |
|
23349 |
|
23350 |
|
23351 <div id="method_getDefaultLocale" class="method item inherited"> |
|
23352 <h3 class="name"><code>getDefaultLocale</code></h3> |
|
23353 |
|
23354 |
|
23355 <span class="paren">()</span> |
|
23356 |
|
23357 |
|
23358 |
|
23359 <span class="returns-inline"> |
|
23360 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
23361 </span> |
|
23362 |
|
23363 |
|
23364 |
|
23365 |
|
23366 |
|
23367 |
|
23368 |
|
23369 |
|
23370 |
|
23371 |
|
23372 |
|
23373 |
|
23374 |
|
23375 |
|
23376 <div class="meta"> |
|
23377 |
|
23378 |
|
23379 <p>Inherited from |
|
23380 <a href="../classes/Widget.html#method_getDefaultLocale">Widget</a>: |
|
23381 |
|
23382 |
|
23383 |
|
23384 <a href="../files/widget_js_WidgetLocale.js.html#l153"><code>widget/js/WidgetLocale.js:153</code></a> |
|
23385 |
|
23386 </p> |
|
23387 |
|
23388 |
|
23389 |
|
23390 |
|
23391 |
|
23392 </div> |
|
23393 |
|
23394 <div class="description"> |
|
23395 <p>Returns the default locale for the widget (the locale value defined by the |
|
23396 widget class, or provided by the user during construction).</p> |
|
23397 </div> |
|
23398 |
|
23399 |
|
23400 |
|
23401 |
|
23402 <div class="returns"> |
|
23403 <h4>Returns:</h4> |
|
23404 |
|
23405 <div class="returns-description"> |
|
23406 |
|
23407 |
|
23408 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
23409 |
|
23410 The default locale for the widget |
|
23411 |
|
23412 </div> |
|
23413 </div> |
|
23414 |
|
23415 |
|
23416 |
|
23417 </div> |
|
23418 |
|
23419 |
|
23420 <div id="method_getEvent" class="method item inherited"> |
|
23421 <h3 class="name"><code>getEvent</code></h3> |
|
23422 |
|
23423 |
|
23424 <div class="args"> |
|
23425 <span class="paren">(</span><ul class="args-list inline commas"> |
|
23426 |
|
23427 <li class="arg"> |
|
23428 |
|
23429 <code>type</code> |
|
23430 |
|
23431 </li> |
|
23432 |
|
23433 <li class="arg"> |
|
23434 |
|
23435 <code>prefixed</code> |
|
23436 |
|
23437 </li> |
|
23438 |
|
23439 </ul><span class="paren">)</span> |
|
23440 </div> |
|
23441 |
|
23442 |
|
23443 |
|
23444 <span class="returns-inline"> |
|
23445 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
23446 </span> |
|
23447 |
|
23448 |
|
23449 |
|
23450 |
|
23451 |
|
23452 |
|
23453 |
|
23454 |
|
23455 |
|
23456 |
|
23457 |
|
23458 |
|
23459 |
|
23460 |
|
23461 <div class="meta"> |
|
23462 |
|
23463 |
|
23464 <p>Inherited from |
|
23465 <a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>: |
|
23466 |
|
23467 |
|
23468 |
|
23469 <a href="../files/event-custom_js_event-target.js.html#l814"><code>event-custom/js/event-target.js:814</code></a> |
|
23470 |
|
23471 </p> |
|
23472 |
|
23473 |
|
23474 |
|
23475 |
|
23476 |
|
23477 </div> |
|
23478 |
|
23479 <div class="description"> |
|
23480 <p>Returns the custom event of the provided type has been created, a |
|
23481 falsy value otherwise</p> |
|
23482 </div> |
|
23483 |
|
23484 |
|
23485 <div class="params"> |
|
23486 <h4>Parameters:</h4> |
|
23487 |
|
23488 <ul class="params-list"> |
|
23489 |
|
23490 <li class="param"> |
|
23491 |
|
23492 <code class="param-name">type</code> |
|
23493 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
23494 |
|
23495 |
|
23496 |
|
23497 |
|
23498 <div class="param-description"> |
|
23499 <p>the type, or name of the event</p> |
|
23500 </div> |
|
23501 |
|
23502 |
|
23503 </li> |
|
23504 |
|
23505 <li class="param"> |
|
23506 |
|
23507 <code class="param-name">prefixed</code> |
|
23508 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
23509 |
|
23510 |
|
23511 |
|
23512 |
|
23513 <div class="param-description"> |
|
23514 <p>if true, the type is prefixed already</p> |
|
23515 </div> |
|
23516 |
|
23517 |
|
23518 </li> |
|
23519 |
|
23520 </ul> |
|
23521 </div> |
|
23522 |
|
23523 |
|
23524 |
|
23525 <div class="returns"> |
|
23526 <h4>Returns:</h4> |
|
23527 |
|
23528 <div class="returns-description"> |
|
23529 |
|
23530 |
|
23531 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>: |
|
23532 |
|
23533 the custom event or null |
|
23534 |
|
23535 </div> |
|
23536 </div> |
|
23537 |
|
23538 |
|
23539 |
|
23540 </div> |
|
23541 |
|
23542 |
|
23543 <div id="method_getRecord" class="method item"> |
|
23544 <h3 class="name"><code>getRecord</code></h3> |
|
23545 |
|
23546 |
|
23547 <div class="args"> |
|
23548 <span class="paren">(</span><ul class="args-list inline commas"> |
|
23549 |
|
23550 <li class="arg"> |
|
23551 |
|
23552 <code>seed</code> |
|
23553 |
|
23554 </li> |
|
23555 |
|
23556 </ul><span class="paren">)</span> |
|
23557 </div> |
|
23558 |
|
23559 |
|
23560 |
|
23561 <span class="returns-inline"> |
|
23562 <span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span> |
|
23563 </span> |
|
23564 |
|
23565 |
|
23566 |
|
23567 |
|
23568 |
|
23569 |
|
23570 |
|
23571 |
|
23572 |
|
23573 |
|
23574 |
|
23575 |
|
23576 |
|
23577 |
|
23578 <div class="meta"> |
|
23579 |
|
23580 |
|
23581 |
|
23582 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
23583 |
|
23584 <p> |
|
23585 |
|
23586 Defined in |
|
23587 |
|
23588 |
|
23589 |
|
23590 |
|
23591 <a href="../files/datatable_js_core.js.html#l262"><code>datatable/js/core.js:262</code></a> |
|
23592 |
|
23593 </p> |
|
23594 |
|
23595 |
|
23596 |
|
23597 |
|
23598 |
|
23599 <p>Available since 3.5.0</p> |
|
23600 |
|
23601 </div> |
|
23602 |
|
23603 <div class="description"> |
|
23604 <p>Returns the Model associated to the record <code>id</code>, <code>clientId</code>, or index (not |
|
23605 row index). If none of those yield a Model from the <code>data</code> ModelList, the |
|
23606 arguments will be passed to the <code>view</code> instance's <code>getRecord</code> method |
|
23607 if it has one.</p> |
|
23608 |
|
23609 <p>If no Model can be found, <code>null</code> is returned.</p> |
|
23610 </div> |
|
23611 |
|
23612 |
|
23613 <div class="params"> |
|
23614 <h4>Parameters:</h4> |
|
23615 |
|
23616 <ul class="params-list"> |
|
23617 |
|
23618 <li class="param"> |
|
23619 |
|
23620 <code class="param-name">seed</code> |
|
23621 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
23622 |
|
23623 |
|
23624 |
|
23625 |
|
23626 <div class="param-description"> |
|
23627 <p>Record <code>id</code>, <code>clientId</code>, index, Node, or |
|
23628 identifier for a row or child element</p> |
|
23629 </div> |
|
23630 |
|
23631 |
|
23632 </li> |
|
23633 |
|
23634 </ul> |
|
23635 </div> |
|
23636 |
|
23637 |
|
23638 |
|
23639 <div class="returns"> |
|
23640 <h4>Returns:</h4> |
|
23641 |
|
23642 <div class="returns-description"> |
|
23643 |
|
23644 |
|
23645 <span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>: |
|
23646 |
|
23647 |
|
23648 </div> |
|
23649 </div> |
|
23650 |
|
23651 |
|
23652 |
|
23653 </div> |
|
23654 |
|
23655 |
|
23656 <div id="method_getRow" class="method item inherited"> |
|
23657 <h3 class="name"><code>getRow</code></h3> |
|
23658 |
|
23659 |
|
23660 <div class="args"> |
|
23661 <span class="paren">(</span><ul class="args-list inline commas"> |
|
23662 |
|
23663 <li class="arg"> |
|
23664 |
|
23665 <code>id</code> |
|
23666 |
|
23667 </li> |
|
23668 |
|
23669 </ul><span class="paren">)</span> |
|
23670 </div> |
|
23671 |
|
23672 |
|
23673 |
|
23674 <span class="returns-inline"> |
|
23675 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
23676 </span> |
|
23677 |
|
23678 |
|
23679 |
|
23680 |
|
23681 |
|
23682 |
|
23683 |
|
23684 |
|
23685 |
|
23686 |
|
23687 |
|
23688 |
|
23689 |
|
23690 |
|
23691 <div class="meta"> |
|
23692 |
|
23693 |
|
23694 <p>Inherited from |
|
23695 <a href="../classes/DataTable.Base.html#method_getRow">DataTable.Base</a>: |
|
23696 |
|
23697 |
|
23698 |
|
23699 <a href="../files/datatable_js_base.js.html#l287"><code>datatable/js/base.js:287</code></a> |
|
23700 |
|
23701 </p> |
|
23702 |
|
23703 |
|
23704 |
|
23705 |
|
23706 |
|
23707 <p>Available since 3.5.0</p> |
|
23708 |
|
23709 </div> |
|
23710 |
|
23711 <div class="description"> |
|
23712 <p>Returns the <code><tr></code> Node from the given row index, Model, or Model's |
|
23713 <code>clientId</code>. If the rows haven't been rendered yet, or if the row can't be |
|
23714 found by the input, <code>null</code> is returned.</p> |
|
23715 |
|
23716 <p>This is actually just a pass through to the <code>view</code> instance's method |
|
23717 by the same name.</p> |
|
23718 </div> |
|
23719 |
|
23720 |
|
23721 <div class="params"> |
|
23722 <h4>Parameters:</h4> |
|
23723 |
|
23724 <ul class="params-list"> |
|
23725 |
|
23726 <li class="param"> |
|
23727 |
|
23728 <code class="param-name">id</code> |
|
23729 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Model.html" class="crosslink">Model</a></span> |
|
23730 |
|
23731 |
|
23732 |
|
23733 |
|
23734 <div class="param-description"> |
|
23735 <p>Row index, Model instance, or clientId</p> |
|
23736 </div> |
|
23737 |
|
23738 |
|
23739 </li> |
|
23740 |
|
23741 </ul> |
|
23742 </div> |
|
23743 |
|
23744 |
|
23745 |
|
23746 <div class="returns"> |
|
23747 <h4>Returns:</h4> |
|
23748 |
|
23749 <div class="returns-description"> |
|
23750 |
|
23751 |
|
23752 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
23753 |
|
23754 |
|
23755 </div> |
|
23756 </div> |
|
23757 |
|
23758 |
|
23759 |
|
23760 </div> |
|
23761 |
|
23762 |
|
23763 <div id="method_getSkinName" class="method item inherited"> |
|
23764 <h3 class="name"><code>getSkinName</code></h3> |
|
23765 |
|
23766 |
|
23767 <div class="args"> |
|
23768 <span class="paren">(</span><ul class="args-list inline commas"> |
|
23769 |
|
23770 <li class="arg"> |
|
23771 |
|
23772 <code class="optional">[skinPrefix]</code> |
|
23773 |
|
23774 </li> |
|
23775 |
|
23776 </ul><span class="paren">)</span> |
|
23777 </div> |
|
23778 |
|
23779 |
|
23780 |
|
23781 <span class="returns-inline"> |
|
23782 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
23783 </span> |
|
23784 |
|
23785 |
|
23786 |
|
23787 |
|
23788 |
|
23789 |
|
23790 |
|
23791 |
|
23792 |
|
23793 |
|
23794 |
|
23795 |
|
23796 |
|
23797 |
|
23798 <div class="meta"> |
|
23799 |
|
23800 |
|
23801 <p>Inherited from |
|
23802 <a href="../classes/Widget.html#method_getSkinName">Widget</a>: |
|
23803 |
|
23804 |
|
23805 |
|
23806 <a href="../files/widget_js_WidgetSkin.js.html#l12"><code>widget/js/WidgetSkin.js:12</code></a> |
|
23807 |
|
23808 </p> |
|
23809 |
|
23810 |
|
23811 |
|
23812 |
|
23813 |
|
23814 </div> |
|
23815 |
|
23816 <div class="description"> |
|
23817 <p>Returns the name of the skin that's currently applied to the widget.</p> |
|
23818 |
|
23819 <p>Searches up the Widget's ancestor axis for, by default, a class |
|
23820 yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.</p> |
|
23821 |
|
23822 <p>This is only really useful after the widget's DOM structure is in the |
|
23823 document, either by render or by progressive enhancement.</p> |
|
23824 </div> |
|
23825 |
|
23826 |
|
23827 <div class="params"> |
|
23828 <h4>Parameters:</h4> |
|
23829 |
|
23830 <ul class="params-list"> |
|
23831 |
|
23832 <li class="param"> |
|
23833 |
|
23834 <code class="param-name optional">[skinPrefix]</code> |
|
23835 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
23836 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
23837 |
|
23838 |
|
23839 |
|
23840 |
|
23841 <div class="param-description"> |
|
23842 <p>The prefix which the implementation uses for the skin |
|
23843 ("yui3-skin-" is the default).</p> |
|
23844 |
|
23845 <p>NOTE: skinPrefix will be used as part of a regular expression:</p> |
|
23846 |
|
23847 <pre><code>new RegExp('\\b' + skinPrefix + '(\\S+)') |
|
23848 </code></pre> |
|
23849 |
|
23850 <p>Although an unlikely use case, literal characters which may result in an invalid |
|
23851 regular expression should be escaped.</p> |
|
23852 </div> |
|
23853 |
|
23854 |
|
23855 </li> |
|
23856 |
|
23857 </ul> |
|
23858 </div> |
|
23859 |
|
23860 |
|
23861 |
|
23862 <div class="returns"> |
|
23863 <h4>Returns:</h4> |
|
23864 |
|
23865 <div class="returns-description"> |
|
23866 |
|
23867 |
|
23868 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
23869 |
|
23870 The name of the skin, or null, if a matching skin class is not found. |
|
23871 |
|
23872 </div> |
|
23873 </div> |
|
23874 |
|
23875 |
|
23876 |
|
23877 </div> |
|
23878 |
|
23879 |
|
23880 <div id="method_getString" class="method item deprecated inherited"> |
|
23881 <h3 class="name"><code>getString</code></h3> |
|
23882 |
|
23883 |
|
23884 <div class="args"> |
|
23885 <span class="paren">(</span><ul class="args-list inline commas"> |
|
23886 |
|
23887 <li class="arg"> |
|
23888 |
|
23889 <code>key</code> |
|
23890 |
|
23891 </li> |
|
23892 |
|
23893 </ul><span class="paren">)</span> |
|
23894 </div> |
|
23895 |
|
23896 |
|
23897 |
|
23898 <span class="returns-inline"> |
|
23899 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
23900 </span> |
|
23901 |
|
23902 |
|
23903 |
|
23904 <span class="flag deprecated" title="Used by deprecated WidgetLocale implementations.">deprecated</span> |
|
23905 |
|
23906 |
|
23907 |
|
23908 |
|
23909 |
|
23910 |
|
23911 |
|
23912 |
|
23913 |
|
23914 |
|
23915 |
|
23916 |
|
23917 <div class="meta"> |
|
23918 |
|
23919 <p>Inherited from |
|
23920 <a href="../classes/Widget.html#method_getString"> |
|
23921 Widget |
|
23922 </a> |
|
23923 |
|
23924 but overwritten in |
|
23925 |
|
23926 |
|
23927 |
|
23928 <a href="../files/widget_js_Widget.js.html#l1225"><code>widget/js/Widget.js:1225</code></a> |
|
23929 |
|
23930 </p> |
|
23931 |
|
23932 |
|
23933 |
|
23934 <p>Deprecated: Used by deprecated WidgetLocale implementations.</p> |
|
23935 |
|
23936 |
|
23937 |
|
23938 </div> |
|
23939 |
|
23940 <div class="description"> |
|
23941 <p>Helper method to get a specific string value</p> |
|
23942 </div> |
|
23943 |
|
23944 |
|
23945 <div class="params"> |
|
23946 <h4>Parameters:</h4> |
|
23947 |
|
23948 <ul class="params-list"> |
|
23949 |
|
23950 <li class="param"> |
|
23951 |
|
23952 <code class="param-name">key</code> |
|
23953 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
23954 |
|
23955 |
|
23956 |
|
23957 |
|
23958 <div class="param-description"> |
|
23959 |
|
23960 </div> |
|
23961 |
|
23962 |
|
23963 </li> |
|
23964 |
|
23965 </ul> |
|
23966 </div> |
|
23967 |
|
23968 |
|
23969 |
|
23970 <div class="returns"> |
|
23971 <h4>Returns:</h4> |
|
23972 |
|
23973 <div class="returns-description"> |
|
23974 |
|
23975 |
|
23976 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
23977 |
|
23978 The string |
|
23979 |
|
23980 </div> |
|
23981 </div> |
|
23982 |
|
23983 |
|
23984 |
|
23985 </div> |
|
23986 |
|
23987 |
|
23988 <div id="method_getStrings" class="method item deprecated inherited"> |
|
23989 <h3 class="name"><code>getStrings</code></h3> |
|
23990 |
|
23991 |
|
23992 <div class="args"> |
|
23993 <span class="paren">(</span><ul class="args-list inline commas"> |
|
23994 |
|
23995 <li class="arg"> |
|
23996 |
|
23997 <code>key</code> |
|
23998 |
|
23999 </li> |
|
24000 |
|
24001 </ul><span class="paren">)</span> |
|
24002 </div> |
|
24003 |
|
24004 |
|
24005 |
|
24006 <span class="returns-inline"> |
|
24007 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
24008 </span> |
|
24009 |
|
24010 |
|
24011 |
|
24012 <span class="flag deprecated" title="Used by deprecated WidgetLocale implementations.">deprecated</span> |
|
24013 |
|
24014 |
|
24015 |
|
24016 |
|
24017 |
|
24018 |
|
24019 |
|
24020 |
|
24021 |
|
24022 |
|
24023 |
|
24024 |
|
24025 <div class="meta"> |
|
24026 |
|
24027 <p>Inherited from |
|
24028 <a href="../classes/Widget.html#method_getStrings"> |
|
24029 Widget |
|
24030 </a> |
|
24031 |
|
24032 but overwritten in |
|
24033 |
|
24034 |
|
24035 |
|
24036 <a href="../files/widget_js_Widget.js.html#l1237"><code>widget/js/Widget.js:1237</code></a> |
|
24037 |
|
24038 </p> |
|
24039 |
|
24040 |
|
24041 |
|
24042 <p>Deprecated: Used by deprecated WidgetLocale implementations.</p> |
|
24043 |
|
24044 |
|
24045 |
|
24046 </div> |
|
24047 |
|
24048 <div class="description"> |
|
24049 <p>Helper method to get the complete set of strings for the widget</p> |
|
24050 </div> |
|
24051 |
|
24052 |
|
24053 <div class="params"> |
|
24054 <h4>Parameters:</h4> |
|
24055 |
|
24056 <ul class="params-list"> |
|
24057 |
|
24058 <li class="param"> |
|
24059 |
|
24060 <code class="param-name">key</code> |
|
24061 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
24062 |
|
24063 |
|
24064 |
|
24065 |
|
24066 <div class="param-description"> |
|
24067 |
|
24068 </div> |
|
24069 |
|
24070 |
|
24071 </li> |
|
24072 |
|
24073 </ul> |
|
24074 </div> |
|
24075 |
|
24076 |
|
24077 |
|
24078 <div class="returns"> |
|
24079 <h4>Returns:</h4> |
|
24080 |
|
24081 <div class="returns-description"> |
|
24082 |
|
24083 |
|
24084 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
24085 |
|
24086 The strings |
|
24087 |
|
24088 </div> |
|
24089 </div> |
|
24090 |
|
24091 |
|
24092 |
|
24093 </div> |
|
24094 |
|
24095 |
|
24096 <div id="method_getTargets" class="method item inherited"> |
|
24097 <h3 class="name"><code>getTargets</code></h3> |
|
24098 |
|
24099 |
|
24100 <span class="paren">()</span> |
|
24101 |
|
24102 |
|
24103 |
|
24104 <span class="returns-inline"> |
|
24105 <span class="type"></span> |
|
24106 </span> |
|
24107 |
|
24108 |
|
24109 |
|
24110 |
|
24111 |
|
24112 |
|
24113 |
|
24114 |
|
24115 |
|
24116 |
|
24117 |
|
24118 |
|
24119 |
|
24120 |
|
24121 <div class="meta"> |
|
24122 |
|
24123 |
|
24124 <p>Inherited from |
|
24125 <a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>: |
|
24126 |
|
24127 |
|
24128 |
|
24129 <a href="../files/event-custom_js_event-facade.js.html#l479"><code>event-custom/js/event-facade.js:479</code></a> |
|
24130 |
|
24131 </p> |
|
24132 |
|
24133 |
|
24134 |
|
24135 |
|
24136 |
|
24137 </div> |
|
24138 |
|
24139 <div class="description"> |
|
24140 <p>Returns an array of bubble targets for this object.</p> |
|
24141 </div> |
|
24142 |
|
24143 |
|
24144 |
|
24145 |
|
24146 <div class="returns"> |
|
24147 <h4>Returns:</h4> |
|
24148 |
|
24149 <div class="returns-description"> |
|
24150 |
|
24151 |
|
24152 EventTarget[] |
|
24153 |
|
24154 </div> |
|
24155 </div> |
|
24156 |
|
24157 |
|
24158 |
|
24159 </div> |
|
24160 |
|
24161 |
|
24162 <div id="method_hide" class="method item inherited"> |
|
24163 <h3 class="name"><code>hide</code></h3> |
|
24164 |
|
24165 |
|
24166 <span class="paren">()</span> |
|
24167 |
|
24168 |
|
24169 |
|
24170 |
|
24171 |
|
24172 |
|
24173 |
|
24174 |
|
24175 |
|
24176 |
|
24177 |
|
24178 |
|
24179 |
|
24180 <span class="flag chainable">chainable</span> |
|
24181 |
|
24182 |
|
24183 |
|
24184 |
|
24185 <div class="meta"> |
|
24186 |
|
24187 |
|
24188 <p>Inherited from |
|
24189 <a href="../classes/Widget.html#method_hide">Widget</a>: |
|
24190 |
|
24191 |
|
24192 |
|
24193 <a href="../files/widget_js_Widget.js.html#l645"><code>widget/js/Widget.js:645</code></a> |
|
24194 |
|
24195 </p> |
|
24196 |
|
24197 |
|
24198 |
|
24199 |
|
24200 |
|
24201 </div> |
|
24202 |
|
24203 <div class="description"> |
|
24204 <p>Hides the Widget by setting the "visible" attribute to "false".</p> |
|
24205 </div> |
|
24206 |
|
24207 |
|
24208 |
|
24209 |
|
24210 |
|
24211 |
|
24212 </div> |
|
24213 |
|
24214 |
|
24215 <div id="method_hideMessage" class="method item"> |
|
24216 <h3 class="name"><code>hideMessage</code></h3> |
|
24217 |
|
24218 |
|
24219 <span class="paren">()</span> |
|
24220 |
|
24221 |
|
24222 |
|
24223 <span class="returns-inline"> |
|
24224 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
24225 </span> |
|
24226 |
|
24227 |
|
24228 |
|
24229 |
|
24230 |
|
24231 |
|
24232 |
|
24233 |
|
24234 |
|
24235 |
|
24236 |
|
24237 <span class="flag chainable">chainable</span> |
|
24238 |
|
24239 |
|
24240 |
|
24241 |
|
24242 <div class="meta"> |
|
24243 |
|
24244 |
|
24245 |
|
24246 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
24247 |
|
24248 <p> |
|
24249 |
|
24250 Defined in |
|
24251 |
|
24252 |
|
24253 |
|
24254 |
|
24255 <a href="../files/datatable_js_message.js.html#l56"><code>datatable/js/message.js:56</code></a> |
|
24256 |
|
24257 </p> |
|
24258 |
|
24259 |
|
24260 |
|
24261 |
|
24262 |
|
24263 <p>Available since 3.5.0</p> |
|
24264 |
|
24265 </div> |
|
24266 |
|
24267 <div class="description"> |
|
24268 <p>Hides the message node.</p> |
|
24269 </div> |
|
24270 |
|
24271 |
|
24272 |
|
24273 |
|
24274 <div class="returns"> |
|
24275 <h4>Returns:</h4> |
|
24276 |
|
24277 <div class="returns-description"> |
|
24278 |
|
24279 |
|
24280 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
24281 |
|
24282 |
|
24283 </div> |
|
24284 </div> |
|
24285 |
|
24286 |
|
24287 |
|
24288 </div> |
|
24289 |
|
24290 |
|
24291 <div id="method_init" class="method item inherited"> |
|
24292 <h3 class="name"><code>init</code></h3> |
|
24293 |
|
24294 |
|
24295 <div class="args"> |
|
24296 <span class="paren">(</span><ul class="args-list inline commas"> |
|
24297 |
|
24298 <li class="arg"> |
|
24299 |
|
24300 <code>cfg</code> |
|
24301 |
|
24302 </li> |
|
24303 |
|
24304 </ul><span class="paren">)</span> |
|
24305 </div> |
|
24306 |
|
24307 |
|
24308 |
|
24309 <span class="returns-inline"> |
|
24310 <span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span> |
|
24311 </span> |
|
24312 |
|
24313 |
|
24314 |
|
24315 |
|
24316 |
|
24317 |
|
24318 |
|
24319 |
|
24320 |
|
24321 |
|
24322 |
|
24323 <span class="flag chainable">chainable</span> |
|
24324 |
|
24325 |
|
24326 |
|
24327 |
|
24328 <div class="meta"> |
|
24329 |
|
24330 <p>Inherited from |
|
24331 <a href="../classes/BaseObservable.html#method_init"> |
|
24332 BaseObservable |
|
24333 </a> |
|
24334 |
|
24335 but overwritten in |
|
24336 |
|
24337 |
|
24338 |
|
24339 <a href="../files/base_js_BaseCore.js.html#l264"><code>base/js/BaseCore.js:264</code></a> |
|
24340 |
|
24341 </p> |
|
24342 |
|
24343 |
|
24344 |
|
24345 |
|
24346 |
|
24347 </div> |
|
24348 |
|
24349 <div class="description"> |
|
24350 <p>Init lifecycle method, invoked during construction. Sets up attributes |
|
24351 and invokes initializers for the class hierarchy.</p> |
|
24352 </div> |
|
24353 |
|
24354 |
|
24355 <div class="params"> |
|
24356 <h4>Parameters:</h4> |
|
24357 |
|
24358 <ul class="params-list"> |
|
24359 |
|
24360 <li class="param"> |
|
24361 |
|
24362 <code class="param-name">cfg</code> |
|
24363 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
24364 |
|
24365 |
|
24366 |
|
24367 |
|
24368 <div class="param-description"> |
|
24369 <p>Object with configuration property name/value pairs</p> |
|
24370 </div> |
|
24371 |
|
24372 |
|
24373 </li> |
|
24374 |
|
24375 </ul> |
|
24376 </div> |
|
24377 |
|
24378 |
|
24379 |
|
24380 <div class="returns"> |
|
24381 <h4>Returns:</h4> |
|
24382 |
|
24383 <div class="returns-description"> |
|
24384 |
|
24385 |
|
24386 <span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span>: |
|
24387 |
|
24388 A reference to this object |
|
24389 |
|
24390 </div> |
|
24391 </div> |
|
24392 |
|
24393 |
|
24394 |
|
24395 </div> |
|
24396 |
|
24397 |
|
24398 <div id="method_initializer" class="method item protected"> |
|
24399 <h3 class="name"><code>initializer</code></h3> |
|
24400 |
|
24401 |
|
24402 <span class="paren">()</span> |
|
24403 |
|
24404 |
|
24405 |
|
24406 |
|
24407 |
|
24408 |
|
24409 |
|
24410 <span class="flag protected">protected</span> |
|
24411 |
|
24412 |
|
24413 |
|
24414 |
|
24415 |
|
24416 |
|
24417 |
|
24418 |
|
24419 |
|
24420 |
|
24421 <div class="meta"> |
|
24422 |
|
24423 |
|
24424 |
|
24425 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
24426 |
|
24427 <p> |
|
24428 |
|
24429 Defined in |
|
24430 |
|
24431 |
|
24432 |
|
24433 |
|
24434 <a href="../files/datatable_js_mutable.js.html#l530"><code>datatable/js/mutable.js:530</code></a> |
|
24435 |
|
24436 </p> |
|
24437 |
|
24438 |
|
24439 |
|
24440 |
|
24441 |
|
24442 <p>Available since 3.5.0</p> |
|
24443 |
|
24444 </div> |
|
24445 |
|
24446 <div class="description"> |
|
24447 <p>Publishes the events used by the mutation methods:</p> |
|
24448 |
|
24449 <ul> |
|
24450 <li>addColumn</li> |
|
24451 <li>removeColumn</li> |
|
24452 <li>modifyColumn</li> |
|
24453 <li>moveColumn</li> |
|
24454 </ul> |
|
24455 </div> |
|
24456 |
|
24457 |
|
24458 |
|
24459 |
|
24460 |
|
24461 |
|
24462 </div> |
|
24463 |
|
24464 |
|
24465 <div id="method_initializer" class="method item protected"> |
|
24466 <h3 class="name"><code>initializer</code></h3> |
|
24467 |
|
24468 |
|
24469 <div class="args"> |
|
24470 <span class="paren">(</span><ul class="args-list inline commas"> |
|
24471 |
|
24472 <li class="arg"> |
|
24473 |
|
24474 <code>config</code> |
|
24475 |
|
24476 </li> |
|
24477 |
|
24478 </ul><span class="paren">)</span> |
|
24479 </div> |
|
24480 |
|
24481 |
|
24482 |
|
24483 |
|
24484 |
|
24485 |
|
24486 |
|
24487 <span class="flag protected">protected</span> |
|
24488 |
|
24489 |
|
24490 |
|
24491 |
|
24492 |
|
24493 |
|
24494 |
|
24495 |
|
24496 |
|
24497 |
|
24498 <div class="meta"> |
|
24499 |
|
24500 |
|
24501 |
|
24502 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
24503 |
|
24504 <p> |
|
24505 |
|
24506 Defined in |
|
24507 |
|
24508 |
|
24509 |
|
24510 |
|
24511 <a href="../files/datatable_js_core.js.html#l597"><code>datatable/js/core.js:597</code></a> |
|
24512 |
|
24513 </p> |
|
24514 |
|
24515 |
|
24516 |
|
24517 |
|
24518 |
|
24519 <p>Available since 3.5.0</p> |
|
24520 |
|
24521 </div> |
|
24522 |
|
24523 <div class="description"> |
|
24524 <p>Initializes the columns, <code>recordType</code> and data ModelList.</p> |
|
24525 </div> |
|
24526 |
|
24527 |
|
24528 <div class="params"> |
|
24529 <h4>Parameters:</h4> |
|
24530 |
|
24531 <ul class="params-list"> |
|
24532 |
|
24533 <li class="param"> |
|
24534 |
|
24535 <code class="param-name">config</code> |
|
24536 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
24537 |
|
24538 |
|
24539 |
|
24540 |
|
24541 <div class="param-description"> |
|
24542 <p>Configuration object passed to constructor</p> |
|
24543 </div> |
|
24544 |
|
24545 |
|
24546 </li> |
|
24547 |
|
24548 </ul> |
|
24549 </div> |
|
24550 |
|
24551 |
|
24552 |
|
24553 |
|
24554 |
|
24555 </div> |
|
24556 |
|
24557 |
|
24558 <div id="method_initializer" class="method item protected"> |
|
24559 <h3 class="name"><code>initializer</code></h3> |
|
24560 |
|
24561 |
|
24562 <span class="paren">()</span> |
|
24563 |
|
24564 |
|
24565 |
|
24566 |
|
24567 |
|
24568 |
|
24569 |
|
24570 <span class="flag protected">protected</span> |
|
24571 |
|
24572 |
|
24573 |
|
24574 |
|
24575 |
|
24576 |
|
24577 |
|
24578 |
|
24579 |
|
24580 |
|
24581 <div class="meta"> |
|
24582 |
|
24583 |
|
24584 |
|
24585 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
24586 |
|
24587 <p> |
|
24588 |
|
24589 Defined in |
|
24590 |
|
24591 |
|
24592 |
|
24593 |
|
24594 <a href="../files/datatable_js_sort.js.html#l442"><code>datatable/js/sort.js:442</code></a> |
|
24595 |
|
24596 </p> |
|
24597 |
|
24598 |
|
24599 |
|
24600 |
|
24601 |
|
24602 <p>Available since 3.5.0</p> |
|
24603 |
|
24604 </div> |
|
24605 |
|
24606 <div class="description"> |
|
24607 <p>Sets up the initial sort state and instance properties. Publishes events |
|
24608 and subscribes to attribute change events to maintain internal state.</p> |
|
24609 </div> |
|
24610 |
|
24611 |
|
24612 |
|
24613 |
|
24614 |
|
24615 |
|
24616 </div> |
|
24617 |
|
24618 |
|
24619 <div id="method_initializer" class="method item protected"> |
|
24620 <h3 class="name"><code>initializer</code></h3> |
|
24621 |
|
24622 |
|
24623 <span class="paren">()</span> |
|
24624 |
|
24625 |
|
24626 |
|
24627 |
|
24628 |
|
24629 |
|
24630 |
|
24631 <span class="flag protected">protected</span> |
|
24632 |
|
24633 |
|
24634 |
|
24635 |
|
24636 |
|
24637 |
|
24638 |
|
24639 |
|
24640 |
|
24641 |
|
24642 <div class="meta"> |
|
24643 |
|
24644 |
|
24645 |
|
24646 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
24647 |
|
24648 <p> |
|
24649 |
|
24650 Defined in |
|
24651 |
|
24652 |
|
24653 |
|
24654 |
|
24655 <a href="../files/datatable_js_message.js.html#l184"><code>datatable/js/message.js:184</code></a> |
|
24656 |
|
24657 </p> |
|
24658 |
|
24659 |
|
24660 |
|
24661 |
|
24662 |
|
24663 <p>Available since 3.5.0</p> |
|
24664 |
|
24665 </div> |
|
24666 |
|
24667 <div class="description"> |
|
24668 <p>Merges in the message related strings and hooks into the rendering cycle to |
|
24669 also render and bind the message node.</p> |
|
24670 </div> |
|
24671 |
|
24672 |
|
24673 |
|
24674 |
|
24675 |
|
24676 |
|
24677 </div> |
|
24678 |
|
24679 |
|
24680 <div id="method_initializer" class="method item protected"> |
|
24681 <h3 class="name"><code>initializer</code></h3> |
|
24682 |
|
24683 |
|
24684 <span class="paren">()</span> |
|
24685 |
|
24686 |
|
24687 |
|
24688 |
|
24689 |
|
24690 |
|
24691 |
|
24692 <span class="flag protected">protected</span> |
|
24693 |
|
24694 |
|
24695 |
|
24696 |
|
24697 |
|
24698 |
|
24699 |
|
24700 |
|
24701 |
|
24702 |
|
24703 <div class="meta"> |
|
24704 |
|
24705 <p>Inherited from |
|
24706 <a href="../classes/Widget.html#method_initializer"> |
|
24707 Widget |
|
24708 </a> |
|
24709 |
|
24710 but overwritten in |
|
24711 |
|
24712 |
|
24713 |
|
24714 <a href="../files/datatable_js_colwidths.js.html#l186"><code>datatable/js/colwidths.js:186</code></a> |
|
24715 |
|
24716 </p> |
|
24717 |
|
24718 |
|
24719 |
|
24720 |
|
24721 |
|
24722 <p>Available since 3.5.0</p> |
|
24723 |
|
24724 </div> |
|
24725 |
|
24726 <div class="description"> |
|
24727 <p>Hooks up to the rendering lifecycle to also render the <code><colgroup></code> and |
|
24728 subscribe to <code>columnChange</code> events.</p> |
|
24729 </div> |
|
24730 |
|
24731 |
|
24732 |
|
24733 |
|
24734 |
|
24735 |
|
24736 </div> |
|
24737 |
|
24738 |
|
24739 <div id="method_initializer" class="method item protected"> |
|
24740 <h3 class="name"><code>initializer</code></h3> |
|
24741 |
|
24742 |
|
24743 <div class="args"> |
|
24744 <span class="paren">(</span><ul class="args-list inline commas"> |
|
24745 |
|
24746 <li class="arg"> |
|
24747 |
|
24748 <code>config</code> |
|
24749 |
|
24750 </li> |
|
24751 |
|
24752 </ul><span class="paren">)</span> |
|
24753 </div> |
|
24754 |
|
24755 |
|
24756 |
|
24757 |
|
24758 |
|
24759 |
|
24760 |
|
24761 <span class="flag protected">protected</span> |
|
24762 |
|
24763 |
|
24764 |
|
24765 |
|
24766 |
|
24767 |
|
24768 |
|
24769 |
|
24770 |
|
24771 |
|
24772 <div class="meta"> |
|
24773 |
|
24774 |
|
24775 |
|
24776 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
24777 |
|
24778 <p> |
|
24779 |
|
24780 Defined in |
|
24781 |
|
24782 |
|
24783 |
|
24784 |
|
24785 <a href="../files/datatable_js_scroll.js.html#l601"><code>datatable/js/scroll.js:601</code></a> |
|
24786 |
|
24787 </p> |
|
24788 |
|
24789 |
|
24790 |
|
24791 |
|
24792 |
|
24793 <p>Available since 3.5.0</p> |
|
24794 |
|
24795 </div> |
|
24796 |
|
24797 <div class="description"> |
|
24798 <p>Sets up event handlers and AOP advice methods to bind the DataTable's natural |
|
24799 behaviors with the scrolling APIs and state.</p> |
|
24800 </div> |
|
24801 |
|
24802 |
|
24803 <div class="params"> |
|
24804 <h4>Parameters:</h4> |
|
24805 |
|
24806 <ul class="params-list"> |
|
24807 |
|
24808 <li class="param"> |
|
24809 |
|
24810 <code class="param-name">config</code> |
|
24811 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
24812 |
|
24813 |
|
24814 |
|
24815 |
|
24816 <div class="param-description"> |
|
24817 <p>The config object passed to the constructor (ignored)</p> |
|
24818 </div> |
|
24819 |
|
24820 |
|
24821 </li> |
|
24822 |
|
24823 </ul> |
|
24824 </div> |
|
24825 |
|
24826 |
|
24827 |
|
24828 |
|
24829 |
|
24830 </div> |
|
24831 |
|
24832 |
|
24833 <div id="method_isRoot" class="method item inherited"> |
|
24834 <h3 class="name"><code>isRoot</code></h3> |
|
24835 |
|
24836 |
|
24837 <span class="paren">()</span> |
|
24838 |
|
24839 |
|
24840 |
|
24841 <span class="returns-inline"> |
|
24842 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
24843 </span> |
|
24844 |
|
24845 |
|
24846 |
|
24847 |
|
24848 |
|
24849 |
|
24850 |
|
24851 |
|
24852 |
|
24853 |
|
24854 |
|
24855 |
|
24856 |
|
24857 |
|
24858 <div class="meta"> |
|
24859 |
|
24860 |
|
24861 <p>Inherited from |
|
24862 <a href="../classes/Widget.html#method_isRoot">Widget</a>: |
|
24863 |
|
24864 |
|
24865 |
|
24866 <a href="../files/widget-child_js_Widget-Child.js.html#l267"><code>widget-child/js/Widget-Child.js:267</code></a> |
|
24867 |
|
24868 </p> |
|
24869 |
|
24870 |
|
24871 |
|
24872 |
|
24873 |
|
24874 </div> |
|
24875 |
|
24876 <div class="description"> |
|
24877 <p>Determines if the Widget is the root Widget in the |
|
24878 object hierarchy.</p> |
|
24879 </div> |
|
24880 |
|
24881 |
|
24882 |
|
24883 |
|
24884 <div class="returns"> |
|
24885 <h4>Returns:</h4> |
|
24886 |
|
24887 <div class="returns-description"> |
|
24888 |
|
24889 |
|
24890 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
24891 |
|
24892 Boolean indicating if Widget is the root Widget in the |
|
24893 object hierarchy. |
|
24894 |
|
24895 </div> |
|
24896 </div> |
|
24897 |
|
24898 |
|
24899 |
|
24900 </div> |
|
24901 |
|
24902 |
|
24903 <div id="method_modifyAttr" class="method item inherited"> |
|
24904 <h3 class="name"><code>modifyAttr</code></h3> |
|
24905 |
|
24906 |
|
24907 <div class="args"> |
|
24908 <span class="paren">(</span><ul class="args-list inline commas"> |
|
24909 |
|
24910 <li class="arg"> |
|
24911 |
|
24912 <code>name</code> |
|
24913 |
|
24914 </li> |
|
24915 |
|
24916 <li class="arg"> |
|
24917 |
|
24918 <code>config</code> |
|
24919 |
|
24920 </li> |
|
24921 |
|
24922 </ul><span class="paren">)</span> |
|
24923 </div> |
|
24924 |
|
24925 |
|
24926 |
|
24927 |
|
24928 |
|
24929 |
|
24930 |
|
24931 |
|
24932 |
|
24933 |
|
24934 |
|
24935 |
|
24936 |
|
24937 |
|
24938 |
|
24939 |
|
24940 <div class="meta"> |
|
24941 |
|
24942 |
|
24943 <p>Inherited from |
|
24944 <a href="../classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>: |
|
24945 |
|
24946 |
|
24947 |
|
24948 <a href="../files/attribute_js_AttributeExtras.js.html#l40"><code>attribute/js/AttributeExtras.js:40</code></a> |
|
24949 |
|
24950 </p> |
|
24951 |
|
24952 |
|
24953 |
|
24954 |
|
24955 |
|
24956 </div> |
|
24957 |
|
24958 <div class="description"> |
|
24959 <p>Updates the configuration of an attribute which has already been added.</p> |
|
24960 |
|
24961 <p> |
|
24962 The properties which can be modified through this interface are limited |
|
24963 to the following subset of attributes, which can be safely modified |
|
24964 after a value has already been set on the attribute: readOnly, writeOnce, |
|
24965 broadcast and getter. |
|
24966 </p> |
|
24967 </div> |
|
24968 |
|
24969 |
|
24970 <div class="params"> |
|
24971 <h4>Parameters:</h4> |
|
24972 |
|
24973 <ul class="params-list"> |
|
24974 |
|
24975 <li class="param"> |
|
24976 |
|
24977 <code class="param-name">name</code> |
|
24978 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
24979 |
|
24980 |
|
24981 |
|
24982 |
|
24983 <div class="param-description"> |
|
24984 <p>The name of the attribute whose configuration is to be updated.</p> |
|
24985 </div> |
|
24986 |
|
24987 |
|
24988 </li> |
|
24989 |
|
24990 <li class="param"> |
|
24991 |
|
24992 <code class="param-name">config</code> |
|
24993 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
24994 |
|
24995 |
|
24996 |
|
24997 |
|
24998 <div class="param-description"> |
|
24999 <p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p> |
|
25000 </div> |
|
25001 |
|
25002 |
|
25003 </li> |
|
25004 |
|
25005 </ul> |
|
25006 </div> |
|
25007 |
|
25008 |
|
25009 |
|
25010 |
|
25011 |
|
25012 </div> |
|
25013 |
|
25014 |
|
25015 <div id="method_modifyColumn" class="method item"> |
|
25016 <h3 class="name"><code>modifyColumn</code></h3> |
|
25017 |
|
25018 |
|
25019 <div class="args"> |
|
25020 <span class="paren">(</span><ul class="args-list inline commas"> |
|
25021 |
|
25022 <li class="arg"> |
|
25023 |
|
25024 <code>name</code> |
|
25025 |
|
25026 </li> |
|
25027 |
|
25028 <li class="arg"> |
|
25029 |
|
25030 <code>config</code> |
|
25031 |
|
25032 </li> |
|
25033 |
|
25034 </ul><span class="paren">)</span> |
|
25035 </div> |
|
25036 |
|
25037 |
|
25038 |
|
25039 <span class="returns-inline"> |
|
25040 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
25041 </span> |
|
25042 |
|
25043 |
|
25044 |
|
25045 |
|
25046 |
|
25047 |
|
25048 |
|
25049 |
|
25050 |
|
25051 |
|
25052 |
|
25053 <span class="flag chainable">chainable</span> |
|
25054 |
|
25055 |
|
25056 |
|
25057 |
|
25058 <div class="meta"> |
|
25059 |
|
25060 |
|
25061 |
|
25062 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
25063 |
|
25064 <p> |
|
25065 |
|
25066 Defined in |
|
25067 |
|
25068 |
|
25069 |
|
25070 |
|
25071 <a href="../files/datatable_js_mutable.js.html#l114"><code>datatable/js/mutable.js:114</code></a> |
|
25072 |
|
25073 </p> |
|
25074 |
|
25075 |
|
25076 |
|
25077 |
|
25078 |
|
25079 <p>Available since 3.5.0</p> |
|
25080 |
|
25081 </div> |
|
25082 |
|
25083 <div class="description"> |
|
25084 <p>Updates an existing column definition. Fires the <code>modifyColumn</code> event.</p> |
|
25085 |
|
25086 <p>For example:</p> |
|
25087 |
|
25088 <pre class="code prettyprint"><code>// Add a formatter to the existing 'price' column definition |
|
25089 table.modifyColumn('price', { formatter: currencyFormatter }); |
|
25090 |
|
25091 // Change the label on a header cell in a set of nested headers three rows |
|
25092 // deep. The index array translates to |
|
25093 // [ 2, -- in the third column's children |
|
25094 // 1, -- the second child |
|
25095 // 3 ] -- the fourth child column |
|
25096 table.modifyColumn([2, 1, 3], { label: 'Experience' }); |
|
25097 </code></pre> |
|
25098 </div> |
|
25099 |
|
25100 |
|
25101 <div class="params"> |
|
25102 <h4>Parameters:</h4> |
|
25103 |
|
25104 <ul class="params-list"> |
|
25105 |
|
25106 <li class="param"> |
|
25107 |
|
25108 <code class="param-name">name</code> |
|
25109 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
25110 |
|
25111 |
|
25112 |
|
25113 |
|
25114 <div class="param-description"> |
|
25115 <p>The column key, name, index, or |
|
25116 current configuration object</p> |
|
25117 </div> |
|
25118 |
|
25119 |
|
25120 </li> |
|
25121 |
|
25122 <li class="param"> |
|
25123 |
|
25124 <code class="param-name">config</code> |
|
25125 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
25126 |
|
25127 |
|
25128 |
|
25129 |
|
25130 <div class="param-description"> |
|
25131 <p>The new column configuration properties</p> |
|
25132 </div> |
|
25133 |
|
25134 |
|
25135 </li> |
|
25136 |
|
25137 </ul> |
|
25138 </div> |
|
25139 |
|
25140 |
|
25141 |
|
25142 <div class="returns"> |
|
25143 <h4>Returns:</h4> |
|
25144 |
|
25145 <div class="returns-description"> |
|
25146 |
|
25147 |
|
25148 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
25149 |
|
25150 |
|
25151 </div> |
|
25152 </div> |
|
25153 |
|
25154 |
|
25155 |
|
25156 </div> |
|
25157 |
|
25158 |
|
25159 <div id="method_modifyRow" class="method item"> |
|
25160 <h3 class="name"><code>modifyRow</code></h3> |
|
25161 |
|
25162 |
|
25163 <div class="args"> |
|
25164 <span class="paren">(</span><ul class="args-list inline commas"> |
|
25165 |
|
25166 <li class="arg"> |
|
25167 |
|
25168 <code>id</code> |
|
25169 |
|
25170 </li> |
|
25171 |
|
25172 <li class="arg"> |
|
25173 |
|
25174 <code>data</code> |
|
25175 |
|
25176 </li> |
|
25177 |
|
25178 <li class="arg"> |
|
25179 |
|
25180 <code class="optional">[config]</code> |
|
25181 |
|
25182 </li> |
|
25183 |
|
25184 <li class="arg"> |
|
25185 |
|
25186 <code class="optional">[callback]</code> |
|
25187 |
|
25188 </li> |
|
25189 |
|
25190 </ul><span class="paren">)</span> |
|
25191 </div> |
|
25192 |
|
25193 |
|
25194 |
|
25195 <span class="returns-inline"> |
|
25196 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
25197 </span> |
|
25198 |
|
25199 |
|
25200 |
|
25201 |
|
25202 |
|
25203 |
|
25204 |
|
25205 |
|
25206 |
|
25207 |
|
25208 |
|
25209 <span class="flag chainable">chainable</span> |
|
25210 |
|
25211 |
|
25212 |
|
25213 |
|
25214 <div class="meta"> |
|
25215 |
|
25216 |
|
25217 |
|
25218 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
25219 |
|
25220 <p> |
|
25221 |
|
25222 Defined in |
|
25223 |
|
25224 |
|
25225 |
|
25226 |
|
25227 <a href="../files/datatable_js_mutable.js.html#l329"><code>datatable/js/mutable.js:329</code></a> |
|
25228 |
|
25229 </p> |
|
25230 |
|
25231 |
|
25232 |
|
25233 |
|
25234 |
|
25235 <p>Available since 3.5.0</p> |
|
25236 |
|
25237 </div> |
|
25238 |
|
25239 <div class="description"> |
|
25240 <p>Updates an existing record in the DataTable's <code>data</code> ModelList. The record |
|
25241 can be provided explicitly or targeted by it's <code>id</code> (see ModelList's |
|
25242 <code>getById</code> method), <code>clientId</code>, or index in the ModelList.</p> |
|
25243 |
|
25244 <p>After locating the target Model, this relays the all other passed |
|
25245 arguments to the Model's <code>setAttrs</code> method.</p> |
|
25246 |
|
25247 <p>If a configuration object is passed as a second argument, and that object |
|
25248 has <code>sync: true</code> set, the underlying Model will be <code>save()</code>d.</p> |
|
25249 |
|
25250 <p>If the DataTable's <code>autoSync</code> attribute is set to <code>true</code>, the additional |
|
25251 argument is not needed.</p> |
|
25252 |
|
25253 <p>If syncing and the last argument is a function, that function will be used |
|
25254 as a callback to the Model's <code>save()</code> method.</p> |
|
25255 </div> |
|
25256 |
|
25257 |
|
25258 <div class="params"> |
|
25259 <h4>Parameters:</h4> |
|
25260 |
|
25261 <ul class="params-list"> |
|
25262 |
|
25263 <li class="param"> |
|
25264 |
|
25265 <code class="param-name">id</code> |
|
25266 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
25267 |
|
25268 |
|
25269 |
|
25270 |
|
25271 <div class="param-description"> |
|
25272 <p>The Model instance or identifier</p> |
|
25273 </div> |
|
25274 |
|
25275 |
|
25276 </li> |
|
25277 |
|
25278 <li class="param"> |
|
25279 |
|
25280 <code class="param-name">data</code> |
|
25281 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
25282 |
|
25283 |
|
25284 |
|
25285 |
|
25286 <div class="param-description"> |
|
25287 <p>New data values for the Model</p> |
|
25288 </div> |
|
25289 |
|
25290 |
|
25291 </li> |
|
25292 |
|
25293 <li class="param"> |
|
25294 |
|
25295 <code class="param-name optional">[config]</code> |
|
25296 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
25297 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
25298 |
|
25299 |
|
25300 |
|
25301 |
|
25302 <div class="param-description"> |
|
25303 <p>Configuration to pass along to <code>setAttrs()</code></p> |
|
25304 </div> |
|
25305 |
|
25306 |
|
25307 </li> |
|
25308 |
|
25309 <li class="param"> |
|
25310 |
|
25311 <code class="param-name optional">[callback]</code> |
|
25312 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
25313 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
25314 |
|
25315 |
|
25316 |
|
25317 |
|
25318 <div class="param-description"> |
|
25319 <p>Callback function for Model's <code>save()</code></p> |
|
25320 </div> |
|
25321 |
|
25322 |
|
25323 <ul class="params-list"> |
|
25324 |
|
25325 <li class="param"> |
|
25326 |
|
25327 <code class="param-name">err</code> |
|
25328 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span> |
|
25329 |
|
25330 |
|
25331 <div class="param-description"> |
|
25332 <p>If an error occurred or validation |
|
25333 failed, this parameter will contain the error. If the sync operation |
|
25334 succeeded, <em>err</em> will be <code>null</code>.</p> |
|
25335 </div> |
|
25336 |
|
25337 |
|
25338 </li> |
|
25339 |
|
25340 <li class="param"> |
|
25341 |
|
25342 <code class="param-name">response</code> |
|
25343 <span class="type">Any</span> |
|
25344 |
|
25345 |
|
25346 <div class="param-description"> |
|
25347 <p>The server's response. This value will |
|
25348 be passed to the <code>parse()</code> method, which is expected to parse it and |
|
25349 return an attribute hash.</p> |
|
25350 </div> |
|
25351 |
|
25352 |
|
25353 </li> |
|
25354 |
|
25355 </ul> |
|
25356 |
|
25357 </li> |
|
25358 |
|
25359 </ul> |
|
25360 </div> |
|
25361 |
|
25362 |
|
25363 |
|
25364 <div class="returns"> |
|
25365 <h4>Returns:</h4> |
|
25366 |
|
25367 <div class="returns-description"> |
|
25368 |
|
25369 |
|
25370 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
25371 |
|
25372 |
|
25373 </div> |
|
25374 </div> |
|
25375 |
|
25376 |
|
25377 |
|
25378 </div> |
|
25379 |
|
25380 |
|
25381 <div id="method_moveColumn" class="method item"> |
|
25382 <h3 class="name"><code>moveColumn</code></h3> |
|
25383 |
|
25384 |
|
25385 <div class="args"> |
|
25386 <span class="paren">(</span><ul class="args-list inline commas"> |
|
25387 |
|
25388 <li class="arg"> |
|
25389 |
|
25390 <code>name</code> |
|
25391 |
|
25392 </li> |
|
25393 |
|
25394 <li class="arg"> |
|
25395 |
|
25396 <code>index</code> |
|
25397 |
|
25398 </li> |
|
25399 |
|
25400 </ul><span class="paren">)</span> |
|
25401 </div> |
|
25402 |
|
25403 |
|
25404 |
|
25405 <span class="returns-inline"> |
|
25406 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
25407 </span> |
|
25408 |
|
25409 |
|
25410 |
|
25411 |
|
25412 |
|
25413 |
|
25414 |
|
25415 |
|
25416 |
|
25417 |
|
25418 |
|
25419 <span class="flag chainable">chainable</span> |
|
25420 |
|
25421 |
|
25422 |
|
25423 |
|
25424 <div class="meta"> |
|
25425 |
|
25426 |
|
25427 |
|
25428 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
25429 |
|
25430 <p> |
|
25431 |
|
25432 Defined in |
|
25433 |
|
25434 |
|
25435 |
|
25436 |
|
25437 <a href="../files/datatable_js_mutable.js.html#l153"><code>datatable/js/mutable.js:153</code></a> |
|
25438 |
|
25439 </p> |
|
25440 |
|
25441 |
|
25442 |
|
25443 |
|
25444 |
|
25445 <p>Available since 3.5.0</p> |
|
25446 |
|
25447 </div> |
|
25448 |
|
25449 <div class="description"> |
|
25450 <p>Moves an existing column to a new location. Fires the <code>moveColumn</code> event.</p> |
|
25451 |
|
25452 <p>The destination index can be a number or array of numbers to place a column |
|
25453 header in a nested header row.</p> |
|
25454 </div> |
|
25455 |
|
25456 |
|
25457 <div class="params"> |
|
25458 <h4>Parameters:</h4> |
|
25459 |
|
25460 <ul class="params-list"> |
|
25461 |
|
25462 <li class="param"> |
|
25463 |
|
25464 <code class="param-name">name</code> |
|
25465 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
25466 |
|
25467 |
|
25468 |
|
25469 |
|
25470 <div class="param-description"> |
|
25471 <p>The column key, name, index, or |
|
25472 current configuration object</p> |
|
25473 </div> |
|
25474 |
|
25475 |
|
25476 </li> |
|
25477 |
|
25478 <li class="param"> |
|
25479 |
|
25480 <code class="param-name">index</code> |
|
25481 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span> |
|
25482 |
|
25483 |
|
25484 |
|
25485 |
|
25486 <div class="param-description"> |
|
25487 <p>The destination index of the column</p> |
|
25488 </div> |
|
25489 |
|
25490 |
|
25491 </li> |
|
25492 |
|
25493 </ul> |
|
25494 </div> |
|
25495 |
|
25496 |
|
25497 |
|
25498 <div class="returns"> |
|
25499 <h4>Returns:</h4> |
|
25500 |
|
25501 <div class="returns-description"> |
|
25502 |
|
25503 |
|
25504 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
25505 |
|
25506 |
|
25507 </div> |
|
25508 </div> |
|
25509 |
|
25510 |
|
25511 |
|
25512 </div> |
|
25513 |
|
25514 |
|
25515 <div id="method_next" class="method item inherited"> |
|
25516 <h3 class="name"><code>next</code></h3> |
|
25517 |
|
25518 |
|
25519 <div class="args"> |
|
25520 <span class="paren">(</span><ul class="args-list inline commas"> |
|
25521 |
|
25522 <li class="arg"> |
|
25523 |
|
25524 <code>circular</code> |
|
25525 |
|
25526 </li> |
|
25527 |
|
25528 </ul><span class="paren">)</span> |
|
25529 </div> |
|
25530 |
|
25531 |
|
25532 |
|
25533 <span class="returns-inline"> |
|
25534 <span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span> |
|
25535 </span> |
|
25536 |
|
25537 |
|
25538 |
|
25539 |
|
25540 |
|
25541 |
|
25542 |
|
25543 |
|
25544 |
|
25545 |
|
25546 |
|
25547 |
|
25548 |
|
25549 |
|
25550 <div class="meta"> |
|
25551 |
|
25552 |
|
25553 <p>Inherited from |
|
25554 <a href="../classes/Widget.html#method_next">Widget</a>: |
|
25555 |
|
25556 |
|
25557 |
|
25558 <a href="../files/widget-child_js_Widget-Child.js.html#l191"><code>widget-child/js/Widget-Child.js:191</code></a> |
|
25559 |
|
25560 </p> |
|
25561 |
|
25562 |
|
25563 |
|
25564 |
|
25565 |
|
25566 </div> |
|
25567 |
|
25568 <div class="description"> |
|
25569 <p>Returns the Widget's next sibling.</p> |
|
25570 </div> |
|
25571 |
|
25572 |
|
25573 <div class="params"> |
|
25574 <h4>Parameters:</h4> |
|
25575 |
|
25576 <ul class="params-list"> |
|
25577 |
|
25578 <li class="param"> |
|
25579 |
|
25580 <code class="param-name">circular</code> |
|
25581 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
25582 |
|
25583 |
|
25584 |
|
25585 |
|
25586 <div class="param-description"> |
|
25587 <p>Boolean indicating if the parent's first child |
|
25588 should be returned if the child has no next sibling.</p> |
|
25589 </div> |
|
25590 |
|
25591 |
|
25592 </li> |
|
25593 |
|
25594 </ul> |
|
25595 </div> |
|
25596 |
|
25597 |
|
25598 |
|
25599 <div class="returns"> |
|
25600 <h4>Returns:</h4> |
|
25601 |
|
25602 <div class="returns-description"> |
|
25603 |
|
25604 |
|
25605 <span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>: |
|
25606 |
|
25607 Widget instance. |
|
25608 |
|
25609 </div> |
|
25610 </div> |
|
25611 |
|
25612 |
|
25613 |
|
25614 </div> |
|
25615 |
|
25616 |
|
25617 <div id="method_on" class="method item inherited"> |
|
25618 <h3 class="name"><code>on</code></h3> |
|
25619 |
|
25620 |
|
25621 <div class="args"> |
|
25622 <span class="paren">(</span><ul class="args-list inline commas"> |
|
25623 |
|
25624 <li class="arg"> |
|
25625 |
|
25626 <code>type</code> |
|
25627 |
|
25628 </li> |
|
25629 |
|
25630 <li class="arg"> |
|
25631 |
|
25632 <code>fn</code> |
|
25633 |
|
25634 </li> |
|
25635 |
|
25636 <li class="arg"> |
|
25637 |
|
25638 <code class="optional">[context]</code> |
|
25639 |
|
25640 </li> |
|
25641 |
|
25642 <li class="arg"> |
|
25643 |
|
25644 <code class="optional">[arg*]</code> |
|
25645 |
|
25646 </li> |
|
25647 |
|
25648 </ul><span class="paren">)</span> |
|
25649 </div> |
|
25650 |
|
25651 |
|
25652 |
|
25653 <span class="returns-inline"> |
|
25654 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
25655 </span> |
|
25656 |
|
25657 |
|
25658 |
|
25659 |
|
25660 |
|
25661 |
|
25662 |
|
25663 |
|
25664 |
|
25665 |
|
25666 |
|
25667 |
|
25668 |
|
25669 |
|
25670 <div class="meta"> |
|
25671 |
|
25672 |
|
25673 <p>Inherited from |
|
25674 <a href="../classes/EventTarget.html#method_on">EventTarget</a>: |
|
25675 |
|
25676 |
|
25677 |
|
25678 <a href="../files/event-custom_js_event-target.js.html#l188"><code>event-custom/js/event-target.js:188</code></a> |
|
25679 |
|
25680 </p> |
|
25681 |
|
25682 |
|
25683 |
|
25684 |
|
25685 |
|
25686 </div> |
|
25687 |
|
25688 <div class="description"> |
|
25689 <p>Subscribe a callback function to a custom event fired by this object or |
|
25690 from an object that bubbles its events to this object.</p> |
|
25691 |
|
25692 <p>Callback functions for events published with <code>emitFacade = true</code> will |
|
25693 receive an <code>EventFacade</code> as the first argument (typically named "e"). |
|
25694 These callbacks can then call <code>e.preventDefault()</code> to disable the |
|
25695 behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code> |
|
25696 API for all available properties and methods. Subscribers to |
|
25697 non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code> |
|
25698 after the event name.</p> |
|
25699 |
|
25700 <p>To subscribe to multiple events at once, pass an object as the first |
|
25701 argument, where the key:value pairs correspond to the eventName:callback, |
|
25702 or pass an array of event names as the first argument to subscribe to |
|
25703 all listed events with the same callback.</p> |
|
25704 |
|
25705 <p>Returning <code>false</code> from a callback is supported as an alternative to |
|
25706 calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is |
|
25707 recommended to use the event methods whenever possible.</p> |
|
25708 </div> |
|
25709 |
|
25710 |
|
25711 <div class="params"> |
|
25712 <h4>Parameters:</h4> |
|
25713 |
|
25714 <ul class="params-list"> |
|
25715 |
|
25716 <li class="param"> |
|
25717 |
|
25718 <code class="param-name">type</code> |
|
25719 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
25720 |
|
25721 |
|
25722 |
|
25723 |
|
25724 <div class="param-description"> |
|
25725 <p>The name of the event</p> |
|
25726 </div> |
|
25727 |
|
25728 |
|
25729 </li> |
|
25730 |
|
25731 <li class="param"> |
|
25732 |
|
25733 <code class="param-name">fn</code> |
|
25734 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
25735 |
|
25736 |
|
25737 |
|
25738 |
|
25739 <div class="param-description"> |
|
25740 <p>The callback to execute in response to the event</p> |
|
25741 </div> |
|
25742 |
|
25743 |
|
25744 </li> |
|
25745 |
|
25746 <li class="param"> |
|
25747 |
|
25748 <code class="param-name optional">[context]</code> |
|
25749 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
25750 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
25751 |
|
25752 |
|
25753 |
|
25754 |
|
25755 <div class="param-description"> |
|
25756 <p>Override <code>this</code> object in callback</p> |
|
25757 </div> |
|
25758 |
|
25759 |
|
25760 </li> |
|
25761 |
|
25762 <li class="param"> |
|
25763 |
|
25764 <code class="param-name optional">[arg*]</code> |
|
25765 <span class="type">Any</span> |
|
25766 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
25767 |
|
25768 |
|
25769 |
|
25770 |
|
25771 <div class="param-description"> |
|
25772 <p>0..n additional arguments to supply to the subscriber</p> |
|
25773 </div> |
|
25774 |
|
25775 |
|
25776 </li> |
|
25777 |
|
25778 </ul> |
|
25779 </div> |
|
25780 |
|
25781 |
|
25782 |
|
25783 <div class="returns"> |
|
25784 <h4>Returns:</h4> |
|
25785 |
|
25786 <div class="returns-description"> |
|
25787 |
|
25788 |
|
25789 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
25790 |
|
25791 A subscription handle capable of detaching that |
|
25792 subscription |
|
25793 |
|
25794 </div> |
|
25795 </div> |
|
25796 |
|
25797 |
|
25798 |
|
25799 </div> |
|
25800 |
|
25801 |
|
25802 <div id="method_once" class="method item inherited"> |
|
25803 <h3 class="name"><code>once</code></h3> |
|
25804 |
|
25805 |
|
25806 <div class="args"> |
|
25807 <span class="paren">(</span><ul class="args-list inline commas"> |
|
25808 |
|
25809 <li class="arg"> |
|
25810 |
|
25811 <code>type</code> |
|
25812 |
|
25813 </li> |
|
25814 |
|
25815 <li class="arg"> |
|
25816 |
|
25817 <code>fn</code> |
|
25818 |
|
25819 </li> |
|
25820 |
|
25821 <li class="arg"> |
|
25822 |
|
25823 <code class="optional">[context]</code> |
|
25824 |
|
25825 </li> |
|
25826 |
|
25827 <li class="arg"> |
|
25828 |
|
25829 <code class="optional">[arg*]</code> |
|
25830 |
|
25831 </li> |
|
25832 |
|
25833 </ul><span class="paren">)</span> |
|
25834 </div> |
|
25835 |
|
25836 |
|
25837 |
|
25838 <span class="returns-inline"> |
|
25839 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
25840 </span> |
|
25841 |
|
25842 |
|
25843 |
|
25844 |
|
25845 |
|
25846 |
|
25847 |
|
25848 |
|
25849 |
|
25850 |
|
25851 |
|
25852 |
|
25853 |
|
25854 |
|
25855 <div class="meta"> |
|
25856 |
|
25857 |
|
25858 <p>Inherited from |
|
25859 <a href="../classes/EventTarget.html#method_once">EventTarget</a>: |
|
25860 |
|
25861 |
|
25862 |
|
25863 <a href="../files/event-custom_js_event-target.js.html#l124"><code>event-custom/js/event-target.js:124</code></a> |
|
25864 |
|
25865 </p> |
|
25866 |
|
25867 |
|
25868 |
|
25869 |
|
25870 |
|
25871 </div> |
|
25872 |
|
25873 <div class="description"> |
|
25874 <p>Listen to a custom event hosted by this object one time. |
|
25875 This is the equivalent to <code>on</code> except the |
|
25876 listener is immediatelly detached when it is executed.</p> |
|
25877 </div> |
|
25878 |
|
25879 |
|
25880 <div class="params"> |
|
25881 <h4>Parameters:</h4> |
|
25882 |
|
25883 <ul class="params-list"> |
|
25884 |
|
25885 <li class="param"> |
|
25886 |
|
25887 <code class="param-name">type</code> |
|
25888 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
25889 |
|
25890 |
|
25891 |
|
25892 |
|
25893 <div class="param-description"> |
|
25894 <p>The name of the event</p> |
|
25895 </div> |
|
25896 |
|
25897 |
|
25898 </li> |
|
25899 |
|
25900 <li class="param"> |
|
25901 |
|
25902 <code class="param-name">fn</code> |
|
25903 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
25904 |
|
25905 |
|
25906 |
|
25907 |
|
25908 <div class="param-description"> |
|
25909 <p>The callback to execute in response to the event</p> |
|
25910 </div> |
|
25911 |
|
25912 |
|
25913 </li> |
|
25914 |
|
25915 <li class="param"> |
|
25916 |
|
25917 <code class="param-name optional">[context]</code> |
|
25918 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
25919 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
25920 |
|
25921 |
|
25922 |
|
25923 |
|
25924 <div class="param-description"> |
|
25925 <p>Override <code>this</code> object in callback</p> |
|
25926 </div> |
|
25927 |
|
25928 |
|
25929 </li> |
|
25930 |
|
25931 <li class="param"> |
|
25932 |
|
25933 <code class="param-name optional">[arg*]</code> |
|
25934 <span class="type">Any</span> |
|
25935 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
25936 |
|
25937 |
|
25938 |
|
25939 |
|
25940 <div class="param-description"> |
|
25941 <p>0..n additional arguments to supply to the subscriber</p> |
|
25942 </div> |
|
25943 |
|
25944 |
|
25945 </li> |
|
25946 |
|
25947 </ul> |
|
25948 </div> |
|
25949 |
|
25950 |
|
25951 |
|
25952 <div class="returns"> |
|
25953 <h4>Returns:</h4> |
|
25954 |
|
25955 <div class="returns-description"> |
|
25956 |
|
25957 |
|
25958 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
25959 |
|
25960 A subscription handle capable of detaching the |
|
25961 subscription |
|
25962 |
|
25963 </div> |
|
25964 </div> |
|
25965 |
|
25966 |
|
25967 |
|
25968 </div> |
|
25969 |
|
25970 |
|
25971 <div id="method_onceAfter" class="method item inherited"> |
|
25972 <h3 class="name"><code>onceAfter</code></h3> |
|
25973 |
|
25974 |
|
25975 <div class="args"> |
|
25976 <span class="paren">(</span><ul class="args-list inline commas"> |
|
25977 |
|
25978 <li class="arg"> |
|
25979 |
|
25980 <code>type</code> |
|
25981 |
|
25982 </li> |
|
25983 |
|
25984 <li class="arg"> |
|
25985 |
|
25986 <code>fn</code> |
|
25987 |
|
25988 </li> |
|
25989 |
|
25990 <li class="arg"> |
|
25991 |
|
25992 <code class="optional">[context]</code> |
|
25993 |
|
25994 </li> |
|
25995 |
|
25996 <li class="arg"> |
|
25997 |
|
25998 <code class="optional">[arg*]</code> |
|
25999 |
|
26000 </li> |
|
26001 |
|
26002 </ul><span class="paren">)</span> |
|
26003 </div> |
|
26004 |
|
26005 |
|
26006 |
|
26007 <span class="returns-inline"> |
|
26008 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
26009 </span> |
|
26010 |
|
26011 |
|
26012 |
|
26013 |
|
26014 |
|
26015 |
|
26016 |
|
26017 |
|
26018 |
|
26019 |
|
26020 |
|
26021 |
|
26022 |
|
26023 |
|
26024 <div class="meta"> |
|
26025 |
|
26026 |
|
26027 <p>Inherited from |
|
26028 <a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>: |
|
26029 |
|
26030 |
|
26031 |
|
26032 <a href="../files/event-custom_js_event-target.js.html#l146"><code>event-custom/js/event-target.js:146</code></a> |
|
26033 |
|
26034 </p> |
|
26035 |
|
26036 |
|
26037 |
|
26038 |
|
26039 |
|
26040 </div> |
|
26041 |
|
26042 <div class="description"> |
|
26043 <p>Listen to a custom event hosted by this object one time. |
|
26044 This is the equivalent to <code>after</code> except the |
|
26045 listener is immediatelly detached when it is executed.</p> |
|
26046 </div> |
|
26047 |
|
26048 |
|
26049 <div class="params"> |
|
26050 <h4>Parameters:</h4> |
|
26051 |
|
26052 <ul class="params-list"> |
|
26053 |
|
26054 <li class="param"> |
|
26055 |
|
26056 <code class="param-name">type</code> |
|
26057 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
26058 |
|
26059 |
|
26060 |
|
26061 |
|
26062 <div class="param-description"> |
|
26063 <p>The name of the event</p> |
|
26064 </div> |
|
26065 |
|
26066 |
|
26067 </li> |
|
26068 |
|
26069 <li class="param"> |
|
26070 |
|
26071 <code class="param-name">fn</code> |
|
26072 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
26073 |
|
26074 |
|
26075 |
|
26076 |
|
26077 <div class="param-description"> |
|
26078 <p>The callback to execute in response to the event</p> |
|
26079 </div> |
|
26080 |
|
26081 |
|
26082 </li> |
|
26083 |
|
26084 <li class="param"> |
|
26085 |
|
26086 <code class="param-name optional">[context]</code> |
|
26087 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
26088 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
26089 |
|
26090 |
|
26091 |
|
26092 |
|
26093 <div class="param-description"> |
|
26094 <p>Override <code>this</code> object in callback</p> |
|
26095 </div> |
|
26096 |
|
26097 |
|
26098 </li> |
|
26099 |
|
26100 <li class="param"> |
|
26101 |
|
26102 <code class="param-name optional">[arg*]</code> |
|
26103 <span class="type">Any</span> |
|
26104 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
26105 |
|
26106 |
|
26107 |
|
26108 |
|
26109 <div class="param-description"> |
|
26110 <p>0..n additional arguments to supply to the subscriber</p> |
|
26111 </div> |
|
26112 |
|
26113 |
|
26114 </li> |
|
26115 |
|
26116 </ul> |
|
26117 </div> |
|
26118 |
|
26119 |
|
26120 |
|
26121 <div class="returns"> |
|
26122 <h4>Returns:</h4> |
|
26123 |
|
26124 <div class="returns-description"> |
|
26125 |
|
26126 |
|
26127 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
26128 |
|
26129 A subscription handle capable of detaching that |
|
26130 subscription |
|
26131 |
|
26132 </div> |
|
26133 </div> |
|
26134 |
|
26135 |
|
26136 |
|
26137 </div> |
|
26138 |
|
26139 |
|
26140 <div id="method_parseType" class="method item inherited"> |
|
26141 <h3 class="name"><code>parseType</code></h3> |
|
26142 |
|
26143 |
|
26144 <div class="args"> |
|
26145 <span class="paren">(</span><ul class="args-list inline commas"> |
|
26146 |
|
26147 <li class="arg"> |
|
26148 |
|
26149 <code>type</code> |
|
26150 |
|
26151 </li> |
|
26152 |
|
26153 <li class="arg"> |
|
26154 |
|
26155 <code class="optional">[pre=this._yuievt.config.prefix]</code> |
|
26156 |
|
26157 </li> |
|
26158 |
|
26159 </ul><span class="paren">)</span> |
|
26160 </div> |
|
26161 |
|
26162 |
|
26163 |
|
26164 <span class="returns-inline"> |
|
26165 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
26166 </span> |
|
26167 |
|
26168 |
|
26169 |
|
26170 |
|
26171 |
|
26172 |
|
26173 |
|
26174 |
|
26175 |
|
26176 |
|
26177 |
|
26178 |
|
26179 |
|
26180 |
|
26181 <div class="meta"> |
|
26182 |
|
26183 |
|
26184 <p>Inherited from |
|
26185 <a href="../classes/EventTarget.html#method_parseType">EventTarget</a>: |
|
26186 |
|
26187 |
|
26188 |
|
26189 <a href="../files/event-custom_js_event-target.js.html#l168"><code>event-custom/js/event-target.js:168</code></a> |
|
26190 |
|
26191 </p> |
|
26192 |
|
26193 |
|
26194 |
|
26195 |
|
26196 |
|
26197 <p>Available since 3.3.0</p> |
|
26198 |
|
26199 </div> |
|
26200 |
|
26201 <div class="description"> |
|
26202 <p>Takes the type parameter passed to 'on' and parses out the |
|
26203 various pieces that could be included in the type. If the |
|
26204 event type is passed without a prefix, it will be expanded |
|
26205 to include the prefix one is supplied or the event target |
|
26206 is configured with a default prefix.</p> |
|
26207 </div> |
|
26208 |
|
26209 |
|
26210 <div class="params"> |
|
26211 <h4>Parameters:</h4> |
|
26212 |
|
26213 <ul class="params-list"> |
|
26214 |
|
26215 <li class="param"> |
|
26216 |
|
26217 <code class="param-name">type</code> |
|
26218 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
26219 |
|
26220 |
|
26221 |
|
26222 |
|
26223 <div class="param-description"> |
|
26224 <p>the type</p> |
|
26225 </div> |
|
26226 |
|
26227 |
|
26228 </li> |
|
26229 |
|
26230 <li class="param"> |
|
26231 |
|
26232 <code class="param-name optional">[pre=this._yuievt.config.prefix]</code> |
|
26233 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
26234 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
26235 |
|
26236 |
|
26237 |
|
26238 |
|
26239 <div class="param-description"> |
|
26240 <p>the prefix</p> |
|
26241 </div> |
|
26242 |
|
26243 |
|
26244 </li> |
|
26245 |
|
26246 </ul> |
|
26247 </div> |
|
26248 |
|
26249 |
|
26250 |
|
26251 <div class="returns"> |
|
26252 <h4>Returns:</h4> |
|
26253 |
|
26254 <div class="returns-description"> |
|
26255 |
|
26256 |
|
26257 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>: |
|
26258 |
|
26259 an array containing: |
|
26260 * the detach category, if supplied, |
|
26261 * the prefixed event type, |
|
26262 * whether or not this is an after listener, |
|
26263 * the supplied event type |
|
26264 |
|
26265 </div> |
|
26266 </div> |
|
26267 |
|
26268 |
|
26269 |
|
26270 </div> |
|
26271 |
|
26272 |
|
26273 <div id="method_previous" class="method item inherited"> |
|
26274 <h3 class="name"><code>previous</code></h3> |
|
26275 |
|
26276 |
|
26277 <div class="args"> |
|
26278 <span class="paren">(</span><ul class="args-list inline commas"> |
|
26279 |
|
26280 <li class="arg"> |
|
26281 |
|
26282 <code>circular</code> |
|
26283 |
|
26284 </li> |
|
26285 |
|
26286 </ul><span class="paren">)</span> |
|
26287 </div> |
|
26288 |
|
26289 |
|
26290 |
|
26291 <span class="returns-inline"> |
|
26292 <span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span> |
|
26293 </span> |
|
26294 |
|
26295 |
|
26296 |
|
26297 |
|
26298 |
|
26299 |
|
26300 |
|
26301 |
|
26302 |
|
26303 |
|
26304 |
|
26305 |
|
26306 |
|
26307 |
|
26308 <div class="meta"> |
|
26309 |
|
26310 |
|
26311 <p>Inherited from |
|
26312 <a href="../classes/Widget.html#method_previous">Widget</a>: |
|
26313 |
|
26314 |
|
26315 |
|
26316 <a href="../files/widget-child_js_Widget-Child.js.html#l216"><code>widget-child/js/Widget-Child.js:216</code></a> |
|
26317 |
|
26318 </p> |
|
26319 |
|
26320 |
|
26321 |
|
26322 |
|
26323 |
|
26324 </div> |
|
26325 |
|
26326 <div class="description"> |
|
26327 <p>Returns the Widget's previous sibling.</p> |
|
26328 </div> |
|
26329 |
|
26330 |
|
26331 <div class="params"> |
|
26332 <h4>Parameters:</h4> |
|
26333 |
|
26334 <ul class="params-list"> |
|
26335 |
|
26336 <li class="param"> |
|
26337 |
|
26338 <code class="param-name">circular</code> |
|
26339 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
26340 |
|
26341 |
|
26342 |
|
26343 |
|
26344 <div class="param-description"> |
|
26345 <p>Boolean indicating if the parent's last child |
|
26346 should be returned if the child has no previous sibling.</p> |
|
26347 </div> |
|
26348 |
|
26349 |
|
26350 </li> |
|
26351 |
|
26352 </ul> |
|
26353 </div> |
|
26354 |
|
26355 |
|
26356 |
|
26357 <div class="returns"> |
|
26358 <h4>Returns:</h4> |
|
26359 |
|
26360 <div class="returns-description"> |
|
26361 |
|
26362 |
|
26363 <span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>: |
|
26364 |
|
26365 Widget instance. |
|
26366 |
|
26367 </div> |
|
26368 </div> |
|
26369 |
|
26370 |
|
26371 |
|
26372 </div> |
|
26373 |
|
26374 |
|
26375 <div id="method_publish" class="method item inherited"> |
|
26376 <h3 class="name"><code>publish</code></h3> |
|
26377 |
|
26378 |
|
26379 <div class="args"> |
|
26380 <span class="paren">(</span><ul class="args-list inline commas"> |
|
26381 |
|
26382 <li class="arg"> |
|
26383 |
|
26384 <code>type</code> |
|
26385 |
|
26386 </li> |
|
26387 |
|
26388 <li class="arg"> |
|
26389 |
|
26390 <code>opts</code> |
|
26391 |
|
26392 </li> |
|
26393 |
|
26394 </ul><span class="paren">)</span> |
|
26395 </div> |
|
26396 |
|
26397 |
|
26398 |
|
26399 <span class="returns-inline"> |
|
26400 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
26401 </span> |
|
26402 |
|
26403 |
|
26404 |
|
26405 |
|
26406 |
|
26407 |
|
26408 |
|
26409 |
|
26410 |
|
26411 |
|
26412 |
|
26413 |
|
26414 |
|
26415 |
|
26416 <div class="meta"> |
|
26417 |
|
26418 |
|
26419 <p>Inherited from |
|
26420 <a href="../classes/EventTarget.html#method_publish">EventTarget</a>: |
|
26421 |
|
26422 |
|
26423 |
|
26424 <a href="../files/event-custom_js_event-target.js.html#l493"><code>event-custom/js/event-target.js:493</code></a> |
|
26425 |
|
26426 </p> |
|
26427 |
|
26428 |
|
26429 |
|
26430 |
|
26431 |
|
26432 </div> |
|
26433 |
|
26434 <div class="description"> |
|
26435 <p>Creates a new custom event of the specified type. If a custom event |
|
26436 by that name already exists, it will not be re-created. In either |
|
26437 case the custom event is returned.</p> |
|
26438 </div> |
|
26439 |
|
26440 |
|
26441 <div class="params"> |
|
26442 <h4>Parameters:</h4> |
|
26443 |
|
26444 <ul class="params-list"> |
|
26445 |
|
26446 <li class="param"> |
|
26447 |
|
26448 <code class="param-name">type</code> |
|
26449 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
26450 |
|
26451 |
|
26452 |
|
26453 |
|
26454 <div class="param-description"> |
|
26455 <p>the type, or name of the event</p> |
|
26456 </div> |
|
26457 |
|
26458 |
|
26459 </li> |
|
26460 |
|
26461 <li class="param"> |
|
26462 |
|
26463 <code class="param-name">opts</code> |
|
26464 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
26465 |
|
26466 |
|
26467 |
|
26468 |
|
26469 <div class="param-description"> |
|
26470 <p>optional config params. Valid properties are:</p> |
|
26471 |
|
26472 <p><ul> |
|
26473 <li> |
|
26474 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false) |
|
26475 </li> |
|
26476 <li> |
|
26477 'bubbles': whether or not this event bubbles (true) |
|
26478 Events can only bubble if emitFacade is true. |
|
26479 </li> |
|
26480 <li> |
|
26481 'context': the default execution context for the listeners (this) |
|
26482 </li> |
|
26483 <li> |
|
26484 'defaultFn': the default function to execute when this event fires if preventDefault was not called |
|
26485 </li> |
|
26486 <li> |
|
26487 'emitFacade': whether or not this event emits a facade (false) |
|
26488 </li> |
|
26489 <li> |
|
26490 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click' |
|
26491 </li> |
|
26492 <li> |
|
26493 'fireOnce': if an event is configured to fire once, new subscribers after |
|
26494 the fire will be notified immediately. |
|
26495 </li> |
|
26496 <li> |
|
26497 'async': fireOnce event listeners will fire synchronously if the event has already |
|
26498 fired unless async is true. |
|
26499 </li> |
|
26500 <li> |
|
26501 'preventable': whether or not preventDefault() has an effect (true) |
|
26502 </li> |
|
26503 <li> |
|
26504 'preventedFn': a function that is executed when preventDefault is called |
|
26505 </li> |
|
26506 <li> |
|
26507 'queuable': whether or not this event can be queued during bubbling (false) |
|
26508 </li> |
|
26509 <li> |
|
26510 'silent': if silent is true, debug messages are not provided for this event. |
|
26511 </li> |
|
26512 <li> |
|
26513 'stoppedFn': a function that is executed when stopPropagation is called |
|
26514 </li></p> |
|
26515 |
|
26516 <p><li> |
|
26517 'monitored': specifies whether or not this event should send notifications about |
|
26518 when the event has been attached, detached, or published. |
|
26519 </li> |
|
26520 <li> |
|
26521 'type': the event type (valid option if not provided as the first parameter to publish) |
|
26522 </li> |
|
26523 </ul></p> |
|
26524 </div> |
|
26525 |
|
26526 |
|
26527 </li> |
|
26528 |
|
26529 </ul> |
|
26530 </div> |
|
26531 |
|
26532 |
|
26533 |
|
26534 <div class="returns"> |
|
26535 <h4>Returns:</h4> |
|
26536 |
|
26537 <div class="returns-description"> |
|
26538 |
|
26539 |
|
26540 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>: |
|
26541 |
|
26542 the custom event |
|
26543 |
|
26544 </div> |
|
26545 </div> |
|
26546 |
|
26547 |
|
26548 |
|
26549 </div> |
|
26550 |
|
26551 |
|
26552 <div id="method_removeAttr" class="method item inherited"> |
|
26553 <h3 class="name"><code>removeAttr</code></h3> |
|
26554 |
|
26555 |
|
26556 <div class="args"> |
|
26557 <span class="paren">(</span><ul class="args-list inline commas"> |
|
26558 |
|
26559 <li class="arg"> |
|
26560 |
|
26561 <code>name</code> |
|
26562 |
|
26563 </li> |
|
26564 |
|
26565 </ul><span class="paren">)</span> |
|
26566 </div> |
|
26567 |
|
26568 |
|
26569 |
|
26570 |
|
26571 |
|
26572 |
|
26573 |
|
26574 |
|
26575 |
|
26576 |
|
26577 |
|
26578 |
|
26579 |
|
26580 |
|
26581 |
|
26582 |
|
26583 <div class="meta"> |
|
26584 |
|
26585 |
|
26586 <p>Inherited from |
|
26587 <a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>: |
|
26588 |
|
26589 |
|
26590 |
|
26591 <a href="../files/attribute_js_AttributeExtras.js.html#l79"><code>attribute/js/AttributeExtras.js:79</code></a> |
|
26592 |
|
26593 </p> |
|
26594 |
|
26595 |
|
26596 |
|
26597 |
|
26598 |
|
26599 </div> |
|
26600 |
|
26601 <div class="description"> |
|
26602 <p>Removes an attribute from the host object</p> |
|
26603 </div> |
|
26604 |
|
26605 |
|
26606 <div class="params"> |
|
26607 <h4>Parameters:</h4> |
|
26608 |
|
26609 <ul class="params-list"> |
|
26610 |
|
26611 <li class="param"> |
|
26612 |
|
26613 <code class="param-name">name</code> |
|
26614 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
26615 |
|
26616 |
|
26617 |
|
26618 |
|
26619 <div class="param-description"> |
|
26620 <p>The name of the attribute to be removed.</p> |
|
26621 </div> |
|
26622 |
|
26623 |
|
26624 </li> |
|
26625 |
|
26626 </ul> |
|
26627 </div> |
|
26628 |
|
26629 |
|
26630 |
|
26631 |
|
26632 |
|
26633 </div> |
|
26634 |
|
26635 |
|
26636 <div id="method_removeColumn" class="method item"> |
|
26637 <h3 class="name"><code>removeColumn</code></h3> |
|
26638 |
|
26639 |
|
26640 <div class="args"> |
|
26641 <span class="paren">(</span><ul class="args-list inline commas"> |
|
26642 |
|
26643 <li class="arg"> |
|
26644 |
|
26645 <code>name</code> |
|
26646 |
|
26647 </li> |
|
26648 |
|
26649 </ul><span class="paren">)</span> |
|
26650 </div> |
|
26651 |
|
26652 |
|
26653 |
|
26654 <span class="returns-inline"> |
|
26655 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
26656 </span> |
|
26657 |
|
26658 |
|
26659 |
|
26660 |
|
26661 |
|
26662 |
|
26663 |
|
26664 |
|
26665 |
|
26666 |
|
26667 |
|
26668 <span class="flag chainable">chainable</span> |
|
26669 |
|
26670 |
|
26671 |
|
26672 |
|
26673 <div class="meta"> |
|
26674 |
|
26675 |
|
26676 |
|
26677 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
26678 |
|
26679 <p> |
|
26680 |
|
26681 Defined in |
|
26682 |
|
26683 |
|
26684 |
|
26685 |
|
26686 <a href="../files/datatable_js_mutable.js.html#l178"><code>datatable/js/mutable.js:178</code></a> |
|
26687 |
|
26688 </p> |
|
26689 |
|
26690 |
|
26691 |
|
26692 |
|
26693 |
|
26694 <p>Available since 3.5.0</p> |
|
26695 |
|
26696 </div> |
|
26697 |
|
26698 <div class="description"> |
|
26699 <p>Removes an existing column. Fires the <code>removeColumn</code> event.</p> |
|
26700 </div> |
|
26701 |
|
26702 |
|
26703 <div class="params"> |
|
26704 <h4>Parameters:</h4> |
|
26705 |
|
26706 <ul class="params-list"> |
|
26707 |
|
26708 <li class="param"> |
|
26709 |
|
26710 <code class="param-name">name</code> |
|
26711 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
26712 |
|
26713 |
|
26714 |
|
26715 |
|
26716 <div class="param-description"> |
|
26717 <p>The column key, name, index, or |
|
26718 current configuration object</p> |
|
26719 </div> |
|
26720 |
|
26721 |
|
26722 </li> |
|
26723 |
|
26724 </ul> |
|
26725 </div> |
|
26726 |
|
26727 |
|
26728 |
|
26729 <div class="returns"> |
|
26730 <h4>Returns:</h4> |
|
26731 |
|
26732 <div class="returns-description"> |
|
26733 |
|
26734 |
|
26735 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
26736 |
|
26737 |
|
26738 </div> |
|
26739 </div> |
|
26740 |
|
26741 |
|
26742 |
|
26743 </div> |
|
26744 |
|
26745 |
|
26746 <div id="method_removeRow" class="method item"> |
|
26747 <h3 class="name"><code>removeRow</code></h3> |
|
26748 |
|
26749 |
|
26750 <div class="args"> |
|
26751 <span class="paren">(</span><ul class="args-list inline commas"> |
|
26752 |
|
26753 <li class="arg"> |
|
26754 |
|
26755 <code>id</code> |
|
26756 |
|
26757 </li> |
|
26758 |
|
26759 <li class="arg"> |
|
26760 |
|
26761 <code class="optional">[config]</code> |
|
26762 |
|
26763 </li> |
|
26764 |
|
26765 <li class="arg"> |
|
26766 |
|
26767 <code class="optional">[callback]</code> |
|
26768 |
|
26769 </li> |
|
26770 |
|
26771 </ul><span class="paren">)</span> |
|
26772 </div> |
|
26773 |
|
26774 |
|
26775 |
|
26776 <span class="returns-inline"> |
|
26777 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
26778 </span> |
|
26779 |
|
26780 |
|
26781 |
|
26782 |
|
26783 |
|
26784 |
|
26785 |
|
26786 |
|
26787 |
|
26788 |
|
26789 |
|
26790 <span class="flag chainable">chainable</span> |
|
26791 |
|
26792 |
|
26793 |
|
26794 |
|
26795 <div class="meta"> |
|
26796 |
|
26797 |
|
26798 |
|
26799 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
26800 |
|
26801 <p> |
|
26802 |
|
26803 Defined in |
|
26804 |
|
26805 |
|
26806 |
|
26807 |
|
26808 <a href="../files/datatable_js_mutable.js.html#l255"><code>datatable/js/mutable.js:255</code></a> |
|
26809 |
|
26810 </p> |
|
26811 |
|
26812 |
|
26813 |
|
26814 |
|
26815 |
|
26816 <p>Available since 3.5.0</p> |
|
26817 |
|
26818 </div> |
|
26819 |
|
26820 <div class="description"> |
|
26821 <p>Removes a record from the DataTable's <code>data</code> ModelList. The record can be |
|
26822 provided explicitly or targeted by it's <code>id</code> (see ModelList's <code>getById</code> |
|
26823 method), <code>clientId</code>, or index in the ModelList.</p> |
|
26824 |
|
26825 <p>After locating the target Model, this relays the Model and all other passed |
|
26826 arguments to the <code>data</code> ModelList's <code>remove</code> method.</p> |
|
26827 |
|
26828 <p>If a configuration object is passed as a second argument, and that object |
|
26829 has <code>sync: true</code> set, the underlying Model will be destroyed, passing |
|
26830 <code>{ delete: true }</code> to trigger calling the Model's sync layer.</p> |
|
26831 |
|
26832 <p>If the DataTable's <code>autoSync</code> attribute is set to <code>true</code>, the additional |
|
26833 argument is not needed.</p> |
|
26834 |
|
26835 <p>If syncing and the last argument is a function, that function will be used |
|
26836 as a callback to the Model's <code>destroy()</code> method.</p> |
|
26837 </div> |
|
26838 |
|
26839 |
|
26840 <div class="params"> |
|
26841 <h4>Parameters:</h4> |
|
26842 |
|
26843 <ul class="params-list"> |
|
26844 |
|
26845 <li class="param"> |
|
26846 |
|
26847 <code class="param-name">id</code> |
|
26848 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
26849 |
|
26850 |
|
26851 |
|
26852 |
|
26853 <div class="param-description"> |
|
26854 <p>The Model instance or identifier</p> |
|
26855 </div> |
|
26856 |
|
26857 |
|
26858 </li> |
|
26859 |
|
26860 <li class="param"> |
|
26861 |
|
26862 <code class="param-name optional">[config]</code> |
|
26863 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
26864 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
26865 |
|
26866 |
|
26867 |
|
26868 |
|
26869 <div class="param-description"> |
|
26870 <p>Configuration to pass along</p> |
|
26871 </div> |
|
26872 |
|
26873 |
|
26874 </li> |
|
26875 |
|
26876 <li class="param"> |
|
26877 |
|
26878 <code class="param-name optional">[callback]</code> |
|
26879 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
26880 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
26881 |
|
26882 |
|
26883 |
|
26884 |
|
26885 <div class="param-description"> |
|
26886 <p>Callback function for Model's <code>save()</code></p> |
|
26887 </div> |
|
26888 |
|
26889 |
|
26890 <ul class="params-list"> |
|
26891 |
|
26892 <li class="param"> |
|
26893 |
|
26894 <code class="param-name">err</code> |
|
26895 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span> |
|
26896 |
|
26897 |
|
26898 <div class="param-description"> |
|
26899 <p>If an error occurred or validation |
|
26900 failed, this parameter will contain the error. If the sync operation |
|
26901 succeeded, <em>err</em> will be <code>null</code>.</p> |
|
26902 </div> |
|
26903 |
|
26904 |
|
26905 </li> |
|
26906 |
|
26907 <li class="param"> |
|
26908 |
|
26909 <code class="param-name">response</code> |
|
26910 <span class="type">Any</span> |
|
26911 |
|
26912 |
|
26913 <div class="param-description"> |
|
26914 <p>The server's response. This value will |
|
26915 be passed to the <code>parse()</code> method, which is expected to parse it and |
|
26916 return an attribute hash.</p> |
|
26917 </div> |
|
26918 |
|
26919 |
|
26920 </li> |
|
26921 |
|
26922 </ul> |
|
26923 |
|
26924 </li> |
|
26925 |
|
26926 </ul> |
|
26927 </div> |
|
26928 |
|
26929 |
|
26930 |
|
26931 <div class="returns"> |
|
26932 <h4>Returns:</h4> |
|
26933 |
|
26934 <div class="returns-description"> |
|
26935 |
|
26936 |
|
26937 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
26938 |
|
26939 |
|
26940 </div> |
|
26941 </div> |
|
26942 |
|
26943 |
|
26944 |
|
26945 </div> |
|
26946 |
|
26947 |
|
26948 <div id="method_removeTarget" class="method item inherited"> |
|
26949 <h3 class="name"><code>removeTarget</code></h3> |
|
26950 |
|
26951 |
|
26952 <div class="args"> |
|
26953 <span class="paren">(</span><ul class="args-list inline commas"> |
|
26954 |
|
26955 <li class="arg"> |
|
26956 |
|
26957 <code>o</code> |
|
26958 |
|
26959 </li> |
|
26960 |
|
26961 </ul><span class="paren">)</span> |
|
26962 </div> |
|
26963 |
|
26964 |
|
26965 |
|
26966 |
|
26967 |
|
26968 |
|
26969 |
|
26970 |
|
26971 |
|
26972 |
|
26973 |
|
26974 |
|
26975 |
|
26976 |
|
26977 |
|
26978 |
|
26979 <div class="meta"> |
|
26980 |
|
26981 |
|
26982 <p>Inherited from |
|
26983 <a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>: |
|
26984 |
|
26985 |
|
26986 |
|
26987 <a href="../files/event-custom_js_event-facade.js.html#l489"><code>event-custom/js/event-facade.js:489</code></a> |
|
26988 |
|
26989 </p> |
|
26990 |
|
26991 |
|
26992 |
|
26993 |
|
26994 |
|
26995 </div> |
|
26996 |
|
26997 <div class="description"> |
|
26998 <p>Removes a bubble target</p> |
|
26999 </div> |
|
27000 |
|
27001 |
|
27002 <div class="params"> |
|
27003 <h4>Parameters:</h4> |
|
27004 |
|
27005 <ul class="params-list"> |
|
27006 |
|
27007 <li class="param"> |
|
27008 |
|
27009 <code class="param-name">o</code> |
|
27010 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
27011 |
|
27012 |
|
27013 |
|
27014 |
|
27015 <div class="param-description"> |
|
27016 <p>the target to remove</p> |
|
27017 </div> |
|
27018 |
|
27019 |
|
27020 </li> |
|
27021 |
|
27022 </ul> |
|
27023 </div> |
|
27024 |
|
27025 |
|
27026 |
|
27027 |
|
27028 |
|
27029 </div> |
|
27030 |
|
27031 |
|
27032 <div id="method_render" class="method item inherited"> |
|
27033 <h3 class="name"><code>render</code></h3> |
|
27034 |
|
27035 |
|
27036 <div class="args"> |
|
27037 <span class="paren">(</span><ul class="args-list inline commas"> |
|
27038 |
|
27039 <li class="arg"> |
|
27040 |
|
27041 <code>parentNode</code> |
|
27042 |
|
27043 </li> |
|
27044 |
|
27045 </ul><span class="paren">)</span> |
|
27046 </div> |
|
27047 |
|
27048 |
|
27049 |
|
27050 |
|
27051 |
|
27052 |
|
27053 |
|
27054 |
|
27055 |
|
27056 <span class="flag final">final</span> |
|
27057 |
|
27058 |
|
27059 |
|
27060 |
|
27061 |
|
27062 <span class="flag chainable">chainable</span> |
|
27063 |
|
27064 |
|
27065 |
|
27066 |
|
27067 <div class="meta"> |
|
27068 |
|
27069 |
|
27070 <p>Inherited from |
|
27071 <a href="../classes/Widget.html#method_render">Widget</a>: |
|
27072 |
|
27073 |
|
27074 |
|
27075 <a href="../files/widget_js_Widget.js.html#l513"><code>widget/js/Widget.js:513</code></a> |
|
27076 |
|
27077 </p> |
|
27078 |
|
27079 |
|
27080 |
|
27081 |
|
27082 |
|
27083 </div> |
|
27084 |
|
27085 <div class="description"> |
|
27086 <p>Establishes the initial DOM for the widget. Invoking this |
|
27087 method will lead to the creating of all DOM elements for |
|
27088 the widget (or the manipulation of existing DOM elements |
|
27089 for the progressive enhancement use case).</p> |
|
27090 |
|
27091 <p> |
|
27092 This method should only be invoked once for an initialized |
|
27093 widget. |
|
27094 </p> |
|
27095 |
|
27096 <p> |
|
27097 It delegates to the widget specific renderer method to do |
|
27098 the actual work. |
|
27099 </p> |
|
27100 </div> |
|
27101 |
|
27102 |
|
27103 <div class="params"> |
|
27104 <h4>Parameters:</h4> |
|
27105 |
|
27106 <ul class="params-list"> |
|
27107 |
|
27108 <li class="param"> |
|
27109 |
|
27110 <code class="param-name">parentNode</code> |
|
27111 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
27112 |
|
27113 |
|
27114 |
|
27115 |
|
27116 <div class="param-description"> |
|
27117 <p>Optional. The Node under which the |
|
27118 Widget is to be rendered. This can be a Node instance or a CSS selector string.</p> |
|
27119 |
|
27120 <p> |
|
27121 If the selector string returns more than one Node, the first node will be used |
|
27122 as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox |
|
27123 are not currently in the document. If it's not provided, the Widget will be rendered |
|
27124 to the body of the current document in this case. |
|
27125 </p> |
|
27126 </div> |
|
27127 |
|
27128 |
|
27129 </li> |
|
27130 |
|
27131 </ul> |
|
27132 </div> |
|
27133 |
|
27134 |
|
27135 |
|
27136 |
|
27137 |
|
27138 </div> |
|
27139 |
|
27140 |
|
27141 <div id="method_renderer" class="method item protected inherited"> |
|
27142 <h3 class="name"><code>renderer</code></h3> |
|
27143 |
|
27144 |
|
27145 <span class="paren">()</span> |
|
27146 |
|
27147 |
|
27148 |
|
27149 |
|
27150 |
|
27151 |
|
27152 |
|
27153 <span class="flag protected">protected</span> |
|
27154 |
|
27155 |
|
27156 |
|
27157 |
|
27158 |
|
27159 |
|
27160 |
|
27161 |
|
27162 |
|
27163 |
|
27164 <div class="meta"> |
|
27165 |
|
27166 |
|
27167 <p>Inherited from |
|
27168 <a href="../classes/Widget.html#method_renderer">Widget</a>: |
|
27169 |
|
27170 |
|
27171 |
|
27172 <a href="../files/widget_js_Widget.js.html#l588"><code>widget/js/Widget.js:588</code></a> |
|
27173 |
|
27174 </p> |
|
27175 |
|
27176 |
|
27177 |
|
27178 |
|
27179 |
|
27180 </div> |
|
27181 |
|
27182 <div class="description"> |
|
27183 <p>Creates DOM (or manipulates DOM for progressive enhancement) |
|
27184 This method is invoked by render() and is not chained |
|
27185 automatically for the class hierarchy (unlike initializer, destructor) |
|
27186 so it should be chained manually for subclasses if required.</p> |
|
27187 </div> |
|
27188 |
|
27189 |
|
27190 |
|
27191 |
|
27192 |
|
27193 |
|
27194 </div> |
|
27195 |
|
27196 |
|
27197 <div id="method_renderUI" class="method item protected inherited"> |
|
27198 <h3 class="name"><code>renderUI</code></h3> |
|
27199 |
|
27200 |
|
27201 <span class="paren">()</span> |
|
27202 |
|
27203 |
|
27204 |
|
27205 |
|
27206 |
|
27207 |
|
27208 |
|
27209 <span class="flag protected">protected</span> |
|
27210 |
|
27211 |
|
27212 |
|
27213 |
|
27214 |
|
27215 |
|
27216 |
|
27217 |
|
27218 |
|
27219 |
|
27220 <div class="meta"> |
|
27221 |
|
27222 |
|
27223 <p>Inherited from |
|
27224 <a href="../classes/Widget.html#method_renderUI">Widget</a>: |
|
27225 |
|
27226 |
|
27227 |
|
27228 <a href="../files/widget_js_Widget.js.html#l622"><code>widget/js/Widget.js:622</code></a> |
|
27229 |
|
27230 </p> |
|
27231 |
|
27232 |
|
27233 |
|
27234 |
|
27235 |
|
27236 </div> |
|
27237 |
|
27238 <div class="description"> |
|
27239 <p>Adds nodes to the DOM</p> |
|
27240 |
|
27241 <p>This method is not called by framework and is not chained |
|
27242 automatically for the class hierarchy.</p> |
|
27243 </div> |
|
27244 |
|
27245 |
|
27246 |
|
27247 |
|
27248 |
|
27249 |
|
27250 </div> |
|
27251 |
|
27252 |
|
27253 <div id="method_reset" class="method item inherited"> |
|
27254 <h3 class="name"><code>reset</code></h3> |
|
27255 |
|
27256 |
|
27257 <div class="args"> |
|
27258 <span class="paren">(</span><ul class="args-list inline commas"> |
|
27259 |
|
27260 <li class="arg"> |
|
27261 |
|
27262 <code>name</code> |
|
27263 |
|
27264 </li> |
|
27265 |
|
27266 </ul><span class="paren">)</span> |
|
27267 </div> |
|
27268 |
|
27269 |
|
27270 |
|
27271 <span class="returns-inline"> |
|
27272 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
27273 </span> |
|
27274 |
|
27275 |
|
27276 |
|
27277 |
|
27278 |
|
27279 |
|
27280 |
|
27281 |
|
27282 |
|
27283 |
|
27284 |
|
27285 <span class="flag chainable">chainable</span> |
|
27286 |
|
27287 |
|
27288 |
|
27289 |
|
27290 <div class="meta"> |
|
27291 |
|
27292 |
|
27293 <p>Inherited from |
|
27294 <a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>: |
|
27295 |
|
27296 |
|
27297 |
|
27298 <a href="../files/attribute_js_AttributeExtras.js.html#l89"><code>attribute/js/AttributeExtras.js:89</code></a> |
|
27299 |
|
27300 </p> |
|
27301 |
|
27302 |
|
27303 |
|
27304 |
|
27305 |
|
27306 </div> |
|
27307 |
|
27308 <div class="description"> |
|
27309 <p>Resets the attribute (or all attributes) to its initial value, as long as |
|
27310 the attribute is not readOnly, or writeOnce.</p> |
|
27311 </div> |
|
27312 |
|
27313 |
|
27314 <div class="params"> |
|
27315 <h4>Parameters:</h4> |
|
27316 |
|
27317 <ul class="params-list"> |
|
27318 |
|
27319 <li class="param"> |
|
27320 |
|
27321 <code class="param-name">name</code> |
|
27322 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
27323 |
|
27324 |
|
27325 |
|
27326 |
|
27327 <div class="param-description"> |
|
27328 <p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p> |
|
27329 </div> |
|
27330 |
|
27331 |
|
27332 </li> |
|
27333 |
|
27334 </ul> |
|
27335 </div> |
|
27336 |
|
27337 |
|
27338 |
|
27339 <div class="returns"> |
|
27340 <h4>Returns:</h4> |
|
27341 |
|
27342 <div class="returns-description"> |
|
27343 |
|
27344 |
|
27345 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
27346 |
|
27347 A reference to the host object. |
|
27348 |
|
27349 </div> |
|
27350 </div> |
|
27351 |
|
27352 |
|
27353 |
|
27354 </div> |
|
27355 |
|
27356 |
|
27357 <div id="method_scrollTo" class="method item"> |
|
27358 <h3 class="name"><code>scrollTo</code></h3> |
|
27359 |
|
27360 |
|
27361 <div class="args"> |
|
27362 <span class="paren">(</span><ul class="args-list inline commas"> |
|
27363 |
|
27364 <li class="arg"> |
|
27365 |
|
27366 <code>id</code> |
|
27367 |
|
27368 </li> |
|
27369 |
|
27370 </ul><span class="paren">)</span> |
|
27371 </div> |
|
27372 |
|
27373 |
|
27374 |
|
27375 <span class="returns-inline"> |
|
27376 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
27377 </span> |
|
27378 |
|
27379 |
|
27380 |
|
27381 |
|
27382 |
|
27383 |
|
27384 |
|
27385 |
|
27386 |
|
27387 |
|
27388 |
|
27389 <span class="flag chainable">chainable</span> |
|
27390 |
|
27391 |
|
27392 |
|
27393 |
|
27394 <div class="meta"> |
|
27395 |
|
27396 |
|
27397 |
|
27398 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
27399 |
|
27400 <p> |
|
27401 |
|
27402 Defined in |
|
27403 |
|
27404 |
|
27405 |
|
27406 |
|
27407 <a href="../files/datatable_js_scroll.js.html#l79"><code>datatable/js/scroll.js:79</code></a> |
|
27408 |
|
27409 </p> |
|
27410 |
|
27411 |
|
27412 |
|
27413 |
|
27414 |
|
27415 <p>Available since 3.5.0</p> |
|
27416 |
|
27417 </div> |
|
27418 |
|
27419 <div class="description"> |
|
27420 <p>Scrolls a given row or cell into view if the table is scrolling. Pass the |
|
27421 <code>clientId</code> of a Model from the DataTable's <code>data</code> ModelList or its row |
|
27422 index to scroll to a row or a [row index, column index] array to scroll to |
|
27423 a cell. Alternately, to scroll to any element contained within the table's |
|
27424 scrolling areas, pass its ID, or the Node itself (though you could just as |
|
27425 well call <code>node.scrollIntoView()</code> yourself, but hey, whatever).</p> |
|
27426 </div> |
|
27427 |
|
27428 |
|
27429 <div class="params"> |
|
27430 <h4>Parameters:</h4> |
|
27431 |
|
27432 <ul class="params-list"> |
|
27433 |
|
27434 <li class="param"> |
|
27435 |
|
27436 <code class="param-name">id</code> |
|
27437 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
27438 |
|
27439 |
|
27440 |
|
27441 |
|
27442 <div class="param-description"> |
|
27443 <p>A row clientId, row index, cell |
|
27444 coordinate array, id string, or Node</p> |
|
27445 </div> |
|
27446 |
|
27447 |
|
27448 </li> |
|
27449 |
|
27450 </ul> |
|
27451 </div> |
|
27452 |
|
27453 |
|
27454 |
|
27455 <div class="returns"> |
|
27456 <h4>Returns:</h4> |
|
27457 |
|
27458 <div class="returns-description"> |
|
27459 |
|
27460 |
|
27461 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
27462 |
|
27463 |
|
27464 </div> |
|
27465 </div> |
|
27466 |
|
27467 |
|
27468 |
|
27469 </div> |
|
27470 |
|
27471 |
|
27472 <div id="method_set" class="method item inherited"> |
|
27473 <h3 class="name"><code>set</code></h3> |
|
27474 |
|
27475 |
|
27476 <div class="args"> |
|
27477 <span class="paren">(</span><ul class="args-list inline commas"> |
|
27478 |
|
27479 <li class="arg"> |
|
27480 |
|
27481 <code>name</code> |
|
27482 |
|
27483 </li> |
|
27484 |
|
27485 <li class="arg"> |
|
27486 |
|
27487 <code>value</code> |
|
27488 |
|
27489 </li> |
|
27490 |
|
27491 <li class="arg"> |
|
27492 |
|
27493 <code class="optional">[opts]</code> |
|
27494 |
|
27495 </li> |
|
27496 |
|
27497 </ul><span class="paren">)</span> |
|
27498 </div> |
|
27499 |
|
27500 |
|
27501 |
|
27502 <span class="returns-inline"> |
|
27503 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
27504 </span> |
|
27505 |
|
27506 |
|
27507 |
|
27508 |
|
27509 |
|
27510 |
|
27511 |
|
27512 |
|
27513 |
|
27514 |
|
27515 |
|
27516 <span class="flag chainable">chainable</span> |
|
27517 |
|
27518 |
|
27519 |
|
27520 |
|
27521 <div class="meta"> |
|
27522 |
|
27523 <p>Inherited from |
|
27524 <a href="../classes/AttributeObservable.html#method_set"> |
|
27525 AttributeObservable |
|
27526 </a> |
|
27527 |
|
27528 but overwritten in |
|
27529 |
|
27530 |
|
27531 |
|
27532 <a href="../files/attribute_js_AttributeCore.js.html#l410"><code>attribute/js/AttributeCore.js:410</code></a> |
|
27533 |
|
27534 </p> |
|
27535 |
|
27536 |
|
27537 |
|
27538 |
|
27539 |
|
27540 </div> |
|
27541 |
|
27542 <div class="description"> |
|
27543 <p>Sets the value of an attribute.</p> |
|
27544 </div> |
|
27545 |
|
27546 |
|
27547 <div class="params"> |
|
27548 <h4>Parameters:</h4> |
|
27549 |
|
27550 <ul class="params-list"> |
|
27551 |
|
27552 <li class="param"> |
|
27553 |
|
27554 <code class="param-name">name</code> |
|
27555 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
27556 |
|
27557 |
|
27558 |
|
27559 |
|
27560 <div class="param-description"> |
|
27561 <p>The name of the attribute. If the |
|
27562 current value of the attribute is an Object, dot notation can be used |
|
27563 to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p> |
|
27564 </div> |
|
27565 |
|
27566 |
|
27567 </li> |
|
27568 |
|
27569 <li class="param"> |
|
27570 |
|
27571 <code class="param-name">value</code> |
|
27572 <span class="type">Any</span> |
|
27573 |
|
27574 |
|
27575 |
|
27576 |
|
27577 <div class="param-description"> |
|
27578 <p>The value to set the attribute to.</p> |
|
27579 </div> |
|
27580 |
|
27581 |
|
27582 </li> |
|
27583 |
|
27584 <li class="param"> |
|
27585 |
|
27586 <code class="param-name optional">[opts]</code> |
|
27587 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
27588 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
27589 |
|
27590 |
|
27591 |
|
27592 |
|
27593 <div class="param-description"> |
|
27594 <p>Optional data providing the circumstances for the change.</p> |
|
27595 </div> |
|
27596 |
|
27597 |
|
27598 </li> |
|
27599 |
|
27600 </ul> |
|
27601 </div> |
|
27602 |
|
27603 |
|
27604 |
|
27605 <div class="returns"> |
|
27606 <h4>Returns:</h4> |
|
27607 |
|
27608 <div class="returns-description"> |
|
27609 |
|
27610 |
|
27611 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
27612 |
|
27613 A reference to the host object. |
|
27614 |
|
27615 </div> |
|
27616 </div> |
|
27617 |
|
27618 |
|
27619 |
|
27620 </div> |
|
27621 |
|
27622 |
|
27623 <div id="method_setAttrs" class="method item inherited"> |
|
27624 <h3 class="name"><code>setAttrs</code></h3> |
|
27625 |
|
27626 |
|
27627 <div class="args"> |
|
27628 <span class="paren">(</span><ul class="args-list inline commas"> |
|
27629 |
|
27630 <li class="arg"> |
|
27631 |
|
27632 <code>attrs</code> |
|
27633 |
|
27634 </li> |
|
27635 |
|
27636 <li class="arg"> |
|
27637 |
|
27638 <code class="optional">[opts]</code> |
|
27639 |
|
27640 </li> |
|
27641 |
|
27642 </ul><span class="paren">)</span> |
|
27643 </div> |
|
27644 |
|
27645 |
|
27646 |
|
27647 <span class="returns-inline"> |
|
27648 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
27649 </span> |
|
27650 |
|
27651 |
|
27652 |
|
27653 |
|
27654 |
|
27655 |
|
27656 |
|
27657 |
|
27658 |
|
27659 |
|
27660 |
|
27661 <span class="flag chainable">chainable</span> |
|
27662 |
|
27663 |
|
27664 |
|
27665 |
|
27666 <div class="meta"> |
|
27667 |
|
27668 <p>Inherited from |
|
27669 <a href="../classes/AttributeObservable.html#method_setAttrs"> |
|
27670 AttributeObservable |
|
27671 </a> |
|
27672 |
|
27673 but overwritten in |
|
27674 |
|
27675 |
|
27676 |
|
27677 <a href="../files/attribute_js_AttributeCore.js.html#l729"><code>attribute/js/AttributeCore.js:729</code></a> |
|
27678 |
|
27679 </p> |
|
27680 |
|
27681 |
|
27682 |
|
27683 |
|
27684 |
|
27685 </div> |
|
27686 |
|
27687 <div class="description"> |
|
27688 <p>Sets multiple attribute values.</p> |
|
27689 </div> |
|
27690 |
|
27691 |
|
27692 <div class="params"> |
|
27693 <h4>Parameters:</h4> |
|
27694 |
|
27695 <ul class="params-list"> |
|
27696 |
|
27697 <li class="param"> |
|
27698 |
|
27699 <code class="param-name">attrs</code> |
|
27700 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
27701 |
|
27702 |
|
27703 |
|
27704 |
|
27705 <div class="param-description"> |
|
27706 <p>An object with attributes name/value pairs.</p> |
|
27707 </div> |
|
27708 |
|
27709 |
|
27710 </li> |
|
27711 |
|
27712 <li class="param"> |
|
27713 |
|
27714 <code class="param-name optional">[opts]</code> |
|
27715 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
27716 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
27717 |
|
27718 |
|
27719 |
|
27720 |
|
27721 <div class="param-description"> |
|
27722 <p>Optional data providing the circumstances for the change.</p> |
|
27723 </div> |
|
27724 |
|
27725 |
|
27726 </li> |
|
27727 |
|
27728 </ul> |
|
27729 </div> |
|
27730 |
|
27731 |
|
27732 |
|
27733 <div class="returns"> |
|
27734 <h4>Returns:</h4> |
|
27735 |
|
27736 <div class="returns-description"> |
|
27737 |
|
27738 |
|
27739 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
27740 |
|
27741 A reference to the host object. |
|
27742 |
|
27743 </div> |
|
27744 </div> |
|
27745 |
|
27746 |
|
27747 |
|
27748 </div> |
|
27749 |
|
27750 |
|
27751 <div id="method_setColumnWidth" class="method item"> |
|
27752 <h3 class="name"><code>setColumnWidth</code></h3> |
|
27753 |
|
27754 |
|
27755 <div class="args"> |
|
27756 <span class="paren">(</span><ul class="args-list inline commas"> |
|
27757 |
|
27758 <li class="arg"> |
|
27759 |
|
27760 <code>id</code> |
|
27761 |
|
27762 </li> |
|
27763 |
|
27764 <li class="arg"> |
|
27765 |
|
27766 <code>width</code> |
|
27767 |
|
27768 </li> |
|
27769 |
|
27770 </ul><span class="paren">)</span> |
|
27771 </div> |
|
27772 |
|
27773 |
|
27774 |
|
27775 <span class="returns-inline"> |
|
27776 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
27777 </span> |
|
27778 |
|
27779 |
|
27780 |
|
27781 |
|
27782 |
|
27783 |
|
27784 |
|
27785 |
|
27786 |
|
27787 |
|
27788 |
|
27789 <span class="flag chainable">chainable</span> |
|
27790 |
|
27791 |
|
27792 |
|
27793 |
|
27794 <div class="meta"> |
|
27795 |
|
27796 |
|
27797 |
|
27798 <p>Provided by the <a href="../modules/datatable-column-widths.html">datatable-column-widths</a> module.</p> |
|
27799 |
|
27800 <p> |
|
27801 |
|
27802 Defined in |
|
27803 |
|
27804 |
|
27805 |
|
27806 |
|
27807 <a href="../files/datatable_js_colwidths.js.html#l138"><code>datatable/js/colwidths.js:138</code></a> |
|
27808 |
|
27809 </p> |
|
27810 |
|
27811 |
|
27812 |
|
27813 |
|
27814 |
|
27815 <p>Available since 3.5.0</p> |
|
27816 |
|
27817 </div> |
|
27818 |
|
27819 <div class="description"> |
|
27820 <p>Assigns the style width of the <code><col></code> representing the column identifed by |
|
27821 <code>id</code> and updates the column configuration.</p> |
|
27822 |
|
27823 <p>Pass the empty string for <code>width</code> to return a column to auto sizing.</p> |
|
27824 |
|
27825 <p>This does not trigger a <code>columnsChange</code> event today, but I can be convinced |
|
27826 that it should.</p> |
|
27827 </div> |
|
27828 |
|
27829 |
|
27830 <div class="params"> |
|
27831 <h4>Parameters:</h4> |
|
27832 |
|
27833 <ul class="params-list"> |
|
27834 |
|
27835 <li class="param"> |
|
27836 |
|
27837 <code class="param-name">id</code> |
|
27838 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
27839 |
|
27840 |
|
27841 |
|
27842 |
|
27843 <div class="param-description"> |
|
27844 <p>The column config object or key, name, or |
|
27845 index of a column in the host's <code>_displayColumns</code> array.</p> |
|
27846 </div> |
|
27847 |
|
27848 |
|
27849 </li> |
|
27850 |
|
27851 <li class="param"> |
|
27852 |
|
27853 <code class="param-name">width</code> |
|
27854 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
27855 |
|
27856 |
|
27857 |
|
27858 |
|
27859 <div class="param-description"> |
|
27860 <p>CSS width value. Numbers are treated as pixels</p> |
|
27861 </div> |
|
27862 |
|
27863 |
|
27864 </li> |
|
27865 |
|
27866 </ul> |
|
27867 </div> |
|
27868 |
|
27869 |
|
27870 |
|
27871 <div class="returns"> |
|
27872 <h4>Returns:</h4> |
|
27873 |
|
27874 <div class="returns-description"> |
|
27875 |
|
27876 |
|
27877 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
27878 |
|
27879 |
|
27880 </div> |
|
27881 </div> |
|
27882 |
|
27883 |
|
27884 |
|
27885 </div> |
|
27886 |
|
27887 |
|
27888 <div id="method_show" class="method item inherited"> |
|
27889 <h3 class="name"><code>show</code></h3> |
|
27890 |
|
27891 |
|
27892 <span class="paren">()</span> |
|
27893 |
|
27894 |
|
27895 |
|
27896 |
|
27897 |
|
27898 |
|
27899 |
|
27900 |
|
27901 |
|
27902 |
|
27903 |
|
27904 |
|
27905 |
|
27906 <span class="flag chainable">chainable</span> |
|
27907 |
|
27908 |
|
27909 |
|
27910 |
|
27911 <div class="meta"> |
|
27912 |
|
27913 |
|
27914 <p>Inherited from |
|
27915 <a href="../classes/Widget.html#method_show">Widget</a>: |
|
27916 |
|
27917 |
|
27918 |
|
27919 <a href="../files/widget_js_Widget.js.html#l654"><code>widget/js/Widget.js:654</code></a> |
|
27920 |
|
27921 </p> |
|
27922 |
|
27923 |
|
27924 |
|
27925 |
|
27926 |
|
27927 </div> |
|
27928 |
|
27929 <div class="description"> |
|
27930 <p>Shows the Widget by setting the "visible" attribute to "true".</p> |
|
27931 </div> |
|
27932 |
|
27933 |
|
27934 |
|
27935 |
|
27936 |
|
27937 |
|
27938 </div> |
|
27939 |
|
27940 |
|
27941 <div id="method_showMessage" class="method item"> |
|
27942 <h3 class="name"><code>showMessage</code></h3> |
|
27943 |
|
27944 |
|
27945 <div class="args"> |
|
27946 <span class="paren">(</span><ul class="args-list inline commas"> |
|
27947 |
|
27948 <li class="arg"> |
|
27949 |
|
27950 <code>message</code> |
|
27951 |
|
27952 </li> |
|
27953 |
|
27954 </ul><span class="paren">)</span> |
|
27955 </div> |
|
27956 |
|
27957 |
|
27958 |
|
27959 <span class="returns-inline"> |
|
27960 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
27961 </span> |
|
27962 |
|
27963 |
|
27964 |
|
27965 |
|
27966 |
|
27967 |
|
27968 |
|
27969 |
|
27970 |
|
27971 |
|
27972 |
|
27973 <span class="flag chainable">chainable</span> |
|
27974 |
|
27975 |
|
27976 |
|
27977 |
|
27978 <div class="meta"> |
|
27979 |
|
27980 |
|
27981 |
|
27982 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
27983 |
|
27984 <p> |
|
27985 |
|
27986 Defined in |
|
27987 |
|
27988 |
|
27989 |
|
27990 |
|
27991 <a href="../files/datatable_js_message.js.html#l71"><code>datatable/js/message.js:71</code></a> |
|
27992 |
|
27993 </p> |
|
27994 |
|
27995 |
|
27996 |
|
27997 |
|
27998 |
|
27999 <p>Available since 3.5.0</p> |
|
28000 |
|
28001 </div> |
|
28002 |
|
28003 <div class="description"> |
|
28004 <p>Display the message node and set its content to <code>message</code>. If there is a |
|
28005 localized <code>strings</code> entry for the value of <code>message</code>, that string will be |
|
28006 used.</p> |
|
28007 </div> |
|
28008 |
|
28009 |
|
28010 <div class="params"> |
|
28011 <h4>Parameters:</h4> |
|
28012 |
|
28013 <ul class="params-list"> |
|
28014 |
|
28015 <li class="param"> |
|
28016 |
|
28017 <code class="param-name">message</code> |
|
28018 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
28019 |
|
28020 |
|
28021 |
|
28022 |
|
28023 <div class="param-description"> |
|
28024 <p>The message name or message itself to display</p> |
|
28025 </div> |
|
28026 |
|
28027 |
|
28028 </li> |
|
28029 |
|
28030 </ul> |
|
28031 </div> |
|
28032 |
|
28033 |
|
28034 |
|
28035 <div class="returns"> |
|
28036 <h4>Returns:</h4> |
|
28037 |
|
28038 <div class="returns-description"> |
|
28039 |
|
28040 |
|
28041 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
28042 |
|
28043 |
|
28044 </div> |
|
28045 </div> |
|
28046 |
|
28047 |
|
28048 |
|
28049 </div> |
|
28050 |
|
28051 |
|
28052 <div id="method_sort" class="method item"> |
|
28053 <h3 class="name"><code>sort</code></h3> |
|
28054 |
|
28055 |
|
28056 <div class="args"> |
|
28057 <span class="paren">(</span><ul class="args-list inline commas"> |
|
28058 |
|
28059 <li class="arg"> |
|
28060 |
|
28061 <code>fields</code> |
|
28062 |
|
28063 </li> |
|
28064 |
|
28065 <li class="arg"> |
|
28066 |
|
28067 <code class="optional">[payload]</code> |
|
28068 |
|
28069 </li> |
|
28070 |
|
28071 </ul><span class="paren">)</span> |
|
28072 </div> |
|
28073 |
|
28074 |
|
28075 |
|
28076 <span class="returns-inline"> |
|
28077 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
28078 </span> |
|
28079 |
|
28080 |
|
28081 |
|
28082 |
|
28083 |
|
28084 |
|
28085 |
|
28086 |
|
28087 |
|
28088 |
|
28089 |
|
28090 <span class="flag chainable">chainable</span> |
|
28091 |
|
28092 |
|
28093 |
|
28094 |
|
28095 <div class="meta"> |
|
28096 |
|
28097 |
|
28098 |
|
28099 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
28100 |
|
28101 <p> |
|
28102 |
|
28103 Defined in |
|
28104 |
|
28105 |
|
28106 |
|
28107 |
|
28108 <a href="../files/datatable_js_sort.js.html#l173"><code>datatable/js/sort.js:173</code></a> |
|
28109 |
|
28110 </p> |
|
28111 |
|
28112 |
|
28113 |
|
28114 |
|
28115 |
|
28116 <p>Available since 3.5.0</p> |
|
28117 |
|
28118 </div> |
|
28119 |
|
28120 <div class="description"> |
|
28121 <p>Sort the data in the <code>data</code> ModelList and refresh the table with the new |
|
28122 order.</p> |
|
28123 |
|
28124 <p>Acceptable values for <code>fields</code> are <code>key</code> strings or objects with a single |
|
28125 property, the column <code>key</code>, with a value of 1, -1, "asc", or "desc". E.g. |
|
28126 <code>{ username: 'asc' }</code>. String values are assumed to be ascending.</p> |
|
28127 |
|
28128 <p>Example values would be:</p> |
|
28129 |
|
28130 <ul> |
|
28131 <li><code>"username"</code> - sort by the data's <code>username</code> field or the <code>key</code> |
|
28132 associated to a column with that <code>name</code>.</li> |
|
28133 <li><code>{ username: "desc" }</code> - sort by <code>username</code> in descending order. |
|
28134 Alternately, use values "asc", 1 (same as "asc"), or -1 (same as "desc").</li> |
|
28135 <li><code>["lastName", "firstName"]</code> - ascending sort by <code>lastName</code>, but for |
|
28136 records with the same <code>lastName</code>, ascending subsort by <code>firstName</code>. |
|
28137 Array can have as many items as you want.</li> |
|
28138 <li><code>[{ lastName: -1 }, "firstName"]</code> - descending sort by <code>lastName</code>, |
|
28139 ascending subsort by <code>firstName</code>. Mixed types are ok.</li> |
|
28140 </ul> |
|
28141 </div> |
|
28142 |
|
28143 |
|
28144 <div class="params"> |
|
28145 <h4>Parameters:</h4> |
|
28146 |
|
28147 <ul class="params-list"> |
|
28148 |
|
28149 <li class="param"> |
|
28150 |
|
28151 <code class="param-name">fields</code> |
|
28152 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
28153 |
|
28154 |
|
28155 |
|
28156 |
|
28157 <div class="param-description"> |
|
28158 <p>The field(s) to sort by</p> |
|
28159 </div> |
|
28160 |
|
28161 |
|
28162 </li> |
|
28163 |
|
28164 <li class="param"> |
|
28165 |
|
28166 <code class="param-name optional">[payload]</code> |
|
28167 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
28168 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
28169 |
|
28170 |
|
28171 |
|
28172 |
|
28173 <div class="param-description"> |
|
28174 <p>Extra <code>sort</code> event payload you want to send along</p> |
|
28175 </div> |
|
28176 |
|
28177 |
|
28178 </li> |
|
28179 |
|
28180 </ul> |
|
28181 </div> |
|
28182 |
|
28183 |
|
28184 |
|
28185 <div class="returns"> |
|
28186 <h4>Returns:</h4> |
|
28187 |
|
28188 <div class="returns-description"> |
|
28189 |
|
28190 |
|
28191 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
28192 |
|
28193 |
|
28194 </div> |
|
28195 </div> |
|
28196 |
|
28197 |
|
28198 |
|
28199 </div> |
|
28200 |
|
28201 |
|
28202 <div id="method_subscribe" class="method item deprecated inherited"> |
|
28203 <h3 class="name"><code>subscribe</code></h3> |
|
28204 |
|
28205 |
|
28206 <span class="paren">()</span> |
|
28207 |
|
28208 |
|
28209 |
|
28210 |
|
28211 |
|
28212 <span class="flag deprecated" title="use on">deprecated</span> |
|
28213 |
|
28214 |
|
28215 |
|
28216 |
|
28217 |
|
28218 |
|
28219 |
|
28220 |
|
28221 |
|
28222 |
|
28223 |
|
28224 |
|
28225 <div class="meta"> |
|
28226 |
|
28227 |
|
28228 <p>Inherited from |
|
28229 <a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>: |
|
28230 |
|
28231 |
|
28232 |
|
28233 <a href="../files/event-custom_js_event-target.js.html#l336"><code>event-custom/js/event-target.js:336</code></a> |
|
28234 |
|
28235 </p> |
|
28236 |
|
28237 |
|
28238 |
|
28239 <p>Deprecated: use on</p> |
|
28240 |
|
28241 |
|
28242 |
|
28243 </div> |
|
28244 |
|
28245 <div class="description"> |
|
28246 <p>subscribe to an event</p> |
|
28247 </div> |
|
28248 |
|
28249 |
|
28250 |
|
28251 |
|
28252 |
|
28253 |
|
28254 </div> |
|
28255 |
|
28256 |
|
28257 <div id="method_syncUI" class="method item inherited"> |
|
28258 <h3 class="name"><code>syncUI</code></h3> |
|
28259 |
|
28260 |
|
28261 <span class="paren">()</span> |
|
28262 |
|
28263 |
|
28264 |
|
28265 |
|
28266 |
|
28267 |
|
28268 |
|
28269 |
|
28270 |
|
28271 |
|
28272 |
|
28273 |
|
28274 |
|
28275 |
|
28276 |
|
28277 |
|
28278 <div class="meta"> |
|
28279 |
|
28280 <p>Inherited from |
|
28281 <a href="../classes/Widget.html#method_syncUI"> |
|
28282 Widget |
|
28283 </a> |
|
28284 |
|
28285 but overwritten in |
|
28286 |
|
28287 |
|
28288 |
|
28289 <a href="../files/datatable_js_base.js.html#l512"><code>datatable/js/base.js:512</code></a> |
|
28290 |
|
28291 </p> |
|
28292 |
|
28293 |
|
28294 |
|
28295 |
|
28296 |
|
28297 <p>Available since 3.5.0</p> |
|
28298 |
|
28299 </div> |
|
28300 |
|
28301 <div class="description"> |
|
28302 <p>Fires the <code>renderView</code> event, delegating UI updates to the configured View.</p> |
|
28303 </div> |
|
28304 |
|
28305 |
|
28306 |
|
28307 |
|
28308 |
|
28309 |
|
28310 </div> |
|
28311 |
|
28312 |
|
28313 <div id="method_toggleSort" class="method item"> |
|
28314 <h3 class="name"><code>toggleSort</code></h3> |
|
28315 |
|
28316 |
|
28317 <div class="args"> |
|
28318 <span class="paren">(</span><ul class="args-list inline commas"> |
|
28319 |
|
28320 <li class="arg"> |
|
28321 |
|
28322 <code>fields</code> |
|
28323 |
|
28324 </li> |
|
28325 |
|
28326 <li class="arg"> |
|
28327 |
|
28328 <code class="optional">[payload]</code> |
|
28329 |
|
28330 </li> |
|
28331 |
|
28332 </ul><span class="paren">)</span> |
|
28333 </div> |
|
28334 |
|
28335 |
|
28336 |
|
28337 <span class="returns-inline"> |
|
28338 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> |
|
28339 </span> |
|
28340 |
|
28341 |
|
28342 |
|
28343 |
|
28344 |
|
28345 |
|
28346 |
|
28347 |
|
28348 |
|
28349 |
|
28350 |
|
28351 <span class="flag chainable">chainable</span> |
|
28352 |
|
28353 |
|
28354 |
|
28355 |
|
28356 <div class="meta"> |
|
28357 |
|
28358 |
|
28359 |
|
28360 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
28361 |
|
28362 <p> |
|
28363 |
|
28364 Defined in |
|
28365 |
|
28366 |
|
28367 |
|
28368 |
|
28369 <a href="../files/datatable_js_sort.js.html#l229"><code>datatable/js/sort.js:229</code></a> |
|
28370 |
|
28371 </p> |
|
28372 |
|
28373 |
|
28374 |
|
28375 |
|
28376 |
|
28377 <p>Available since 3.5.0</p> |
|
28378 |
|
28379 </div> |
|
28380 |
|
28381 <div class="description"> |
|
28382 <p>Reverse the current sort direction of one or more fields currently being |
|
28383 sorted by.</p> |
|
28384 |
|
28385 <p>Pass the <code>key</code> of the column or columns you want the sort order reversed |
|
28386 for.</p> |
|
28387 </div> |
|
28388 |
|
28389 |
|
28390 <div class="params"> |
|
28391 <h4>Parameters:</h4> |
|
28392 |
|
28393 <ul class="params-list"> |
|
28394 |
|
28395 <li class="param"> |
|
28396 |
|
28397 <code class="param-name">fields</code> |
|
28398 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span> |
|
28399 |
|
28400 |
|
28401 |
|
28402 |
|
28403 <div class="param-description"> |
|
28404 <p>The field(s) to reverse sort order for</p> |
|
28405 </div> |
|
28406 |
|
28407 |
|
28408 </li> |
|
28409 |
|
28410 <li class="param"> |
|
28411 |
|
28412 <code class="param-name optional">[payload]</code> |
|
28413 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
28414 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
28415 |
|
28416 |
|
28417 |
|
28418 |
|
28419 <div class="param-description"> |
|
28420 <p>Extra <code>sort</code> event payload you want to send along</p> |
|
28421 </div> |
|
28422 |
|
28423 |
|
28424 </li> |
|
28425 |
|
28426 </ul> |
|
28427 </div> |
|
28428 |
|
28429 |
|
28430 |
|
28431 <div class="returns"> |
|
28432 <h4>Returns:</h4> |
|
28433 |
|
28434 <div class="returns-description"> |
|
28435 |
|
28436 |
|
28437 <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: |
|
28438 |
|
28439 |
|
28440 </div> |
|
28441 </div> |
|
28442 |
|
28443 |
|
28444 |
|
28445 </div> |
|
28446 |
|
28447 |
|
28448 <div id="method_toString" class="method item inherited"> |
|
28449 <h3 class="name"><code>toString</code></h3> |
|
28450 |
|
28451 |
|
28452 <span class="paren">()</span> |
|
28453 |
|
28454 |
|
28455 |
|
28456 <span class="returns-inline"> |
|
28457 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
28458 </span> |
|
28459 |
|
28460 |
|
28461 |
|
28462 |
|
28463 |
|
28464 |
|
28465 |
|
28466 |
|
28467 |
|
28468 |
|
28469 |
|
28470 |
|
28471 |
|
28472 |
|
28473 <div class="meta"> |
|
28474 |
|
28475 <p>Inherited from |
|
28476 <a href="../classes/BaseCore.html#method_toString"> |
|
28477 BaseCore |
|
28478 </a> |
|
28479 |
|
28480 but overwritten in |
|
28481 |
|
28482 |
|
28483 |
|
28484 <a href="../files/widget_js_Widget.js.html#l1107"><code>widget/js/Widget.js:1107</code></a> |
|
28485 |
|
28486 </p> |
|
28487 |
|
28488 |
|
28489 |
|
28490 |
|
28491 |
|
28492 </div> |
|
28493 |
|
28494 <div class="description"> |
|
28495 <p>Generic toString implementation for all widgets.</p> |
|
28496 </div> |
|
28497 |
|
28498 |
|
28499 |
|
28500 |
|
28501 <div class="returns"> |
|
28502 <h4>Returns:</h4> |
|
28503 |
|
28504 <div class="returns-description"> |
|
28505 |
|
28506 |
|
28507 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
28508 |
|
28509 The default string value for the widget [ displays the NAME of the instance, and the unique id ] |
|
28510 |
|
28511 </div> |
|
28512 </div> |
|
28513 |
|
28514 |
|
28515 |
|
28516 </div> |
|
28517 |
|
28518 |
|
28519 <div id="method_unsubscribe" class="method item deprecated inherited"> |
|
28520 <h3 class="name"><code>unsubscribe</code></h3> |
|
28521 |
|
28522 |
|
28523 <span class="paren">()</span> |
|
28524 |
|
28525 |
|
28526 |
|
28527 |
|
28528 |
|
28529 <span class="flag deprecated" title="use detach">deprecated</span> |
|
28530 |
|
28531 |
|
28532 |
|
28533 |
|
28534 |
|
28535 |
|
28536 |
|
28537 |
|
28538 |
|
28539 |
|
28540 |
|
28541 |
|
28542 <div class="meta"> |
|
28543 |
|
28544 |
|
28545 <p>Inherited from |
|
28546 <a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>: |
|
28547 |
|
28548 |
|
28549 |
|
28550 <a href="../files/event-custom_js_event-target.js.html#l459"><code>event-custom/js/event-target.js:459</code></a> |
|
28551 |
|
28552 </p> |
|
28553 |
|
28554 |
|
28555 |
|
28556 <p>Deprecated: use detach</p> |
|
28557 |
|
28558 |
|
28559 |
|
28560 </div> |
|
28561 |
|
28562 <div class="description"> |
|
28563 <p>detach a listener</p> |
|
28564 </div> |
|
28565 |
|
28566 |
|
28567 |
|
28568 |
|
28569 |
|
28570 |
|
28571 </div> |
|
28572 |
|
28573 |
|
28574 <div id="method_unsubscribeAll" class="method item deprecated inherited"> |
|
28575 <h3 class="name"><code>unsubscribeAll</code></h3> |
|
28576 |
|
28577 |
|
28578 <div class="args"> |
|
28579 <span class="paren">(</span><ul class="args-list inline commas"> |
|
28580 |
|
28581 <li class="arg"> |
|
28582 |
|
28583 <code>type</code> |
|
28584 |
|
28585 </li> |
|
28586 |
|
28587 </ul><span class="paren">)</span> |
|
28588 </div> |
|
28589 |
|
28590 |
|
28591 |
|
28592 |
|
28593 |
|
28594 <span class="flag deprecated" title="use detachAll">deprecated</span> |
|
28595 |
|
28596 |
|
28597 |
|
28598 |
|
28599 |
|
28600 |
|
28601 |
|
28602 |
|
28603 |
|
28604 |
|
28605 |
|
28606 |
|
28607 <div class="meta"> |
|
28608 |
|
28609 |
|
28610 <p>Inherited from |
|
28611 <a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>: |
|
28612 |
|
28613 |
|
28614 |
|
28615 <a href="../files/event-custom_js_event-target.js.html#l480"><code>event-custom/js/event-target.js:480</code></a> |
|
28616 |
|
28617 </p> |
|
28618 |
|
28619 |
|
28620 |
|
28621 <p>Deprecated: use detachAll</p> |
|
28622 |
|
28623 |
|
28624 |
|
28625 </div> |
|
28626 |
|
28627 <div class="description"> |
|
28628 <p>Removes all listeners from the specified event. If the event type |
|
28629 is not specified, all listeners from all hosted custom events will |
|
28630 be removed.</p> |
|
28631 </div> |
|
28632 |
|
28633 |
|
28634 <div class="params"> |
|
28635 <h4>Parameters:</h4> |
|
28636 |
|
28637 <ul class="params-list"> |
|
28638 |
|
28639 <li class="param"> |
|
28640 |
|
28641 <code class="param-name">type</code> |
|
28642 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
28643 |
|
28644 |
|
28645 |
|
28646 |
|
28647 <div class="param-description"> |
|
28648 <p>The type, or name of the event</p> |
|
28649 </div> |
|
28650 |
|
28651 |
|
28652 </li> |
|
28653 |
|
28654 </ul> |
|
28655 </div> |
|
28656 |
|
28657 |
|
28658 |
|
28659 |
|
28660 |
|
28661 </div> |
|
28662 |
|
28663 |
|
28664 </div> |
|
28665 |
|
28666 |
|
28667 |
|
28668 <div id="properties" class="api-class-tabpanel"> |
|
28669 <h2 class="off-left">Properties</h2> |
|
28670 |
|
28671 |
|
28672 <div id="property__allowAdHocAttrs" class="property item protected"> |
|
28673 <h3 class="name"><code>_allowAdHocAttrs</code></h3> |
|
28674 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
28675 |
|
28676 |
|
28677 |
|
28678 |
|
28679 <span class="flag protected">protected</span> |
|
28680 |
|
28681 |
|
28682 |
|
28683 |
|
28684 |
|
28685 |
|
28686 <div class="meta"> |
|
28687 |
|
28688 <p>Inherited from |
|
28689 <a href="../classes/BaseCore.html#property__allowAdHocAttrs"> |
|
28690 BaseCore |
|
28691 </a> |
|
28692 |
|
28693 but overwritten in |
|
28694 |
|
28695 |
|
28696 |
|
28697 <a href="../files/datatable_js_core.js.html#l295"><code>datatable/js/core.js:295</code></a> |
|
28698 |
|
28699 </p> |
|
28700 |
|
28701 |
|
28702 |
|
28703 |
|
28704 <p>Available since 3.6.0</p> |
|
28705 |
|
28706 </div> |
|
28707 |
|
28708 <div class="description"> |
|
28709 <p>This tells <code>Y.Base</code> that it should create ad-hoc attributes for config |
|
28710 properties passed to DataTable's constructor. This is useful for setting |
|
28711 configurations on the DataTable that are intended for the rendering View(s).</p> |
|
28712 </div> |
|
28713 |
|
28714 |
|
28715 <p><strong>Default:</strong> true</p> |
|
28716 |
|
28717 |
|
28718 |
|
28719 |
|
28720 |
|
28721 </div> |
|
28722 |
|
28723 |
|
28724 <div id="property__CAPTION_TABLE_TEMPLATE" class="property item protected"> |
|
28725 <h3 class="name"><code>_CAPTION_TABLE_TEMPLATE</code></h3> |
|
28726 <span class="type">HTML</span> |
|
28727 |
|
28728 |
|
28729 |
|
28730 |
|
28731 <span class="flag protected">protected</span> |
|
28732 |
|
28733 |
|
28734 |
|
28735 |
|
28736 |
|
28737 |
|
28738 <div class="meta"> |
|
28739 |
|
28740 |
|
28741 |
|
28742 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
28743 |
|
28744 <p> |
|
28745 |
|
28746 Defined in |
|
28747 |
|
28748 |
|
28749 |
|
28750 |
|
28751 <a href="../files/datatable_js_scroll.js.html#l122"><code>datatable/js/scroll.js:122</code></a> |
|
28752 |
|
28753 </p> |
|
28754 |
|
28755 |
|
28756 |
|
28757 |
|
28758 <p>Available since 3.5.0</p> |
|
28759 |
|
28760 </div> |
|
28761 |
|
28762 <div class="description"> |
|
28763 <p>Template for the <code><table></code> that is used to fix the caption in place when |
|
28764 the table is horizontally scrolling.</p> |
|
28765 </div> |
|
28766 |
|
28767 |
|
28768 |
|
28769 |
|
28770 |
|
28771 |
|
28772 </div> |
|
28773 |
|
28774 |
|
28775 <div id="property__columnMap" class="property item protected"> |
|
28776 <h3 class="name"><code>_columnMap</code></h3> |
|
28777 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
28778 |
|
28779 |
|
28780 |
|
28781 |
|
28782 <span class="flag protected">protected</span> |
|
28783 |
|
28784 |
|
28785 |
|
28786 |
|
28787 |
|
28788 |
|
28789 <div class="meta"> |
|
28790 |
|
28791 |
|
28792 |
|
28793 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
28794 |
|
28795 <p> |
|
28796 |
|
28797 Defined in |
|
28798 |
|
28799 |
|
28800 |
|
28801 |
|
28802 <a href="../files/datatable_js_core.js.html#l308"><code>datatable/js/core.js:308</code></a> |
|
28803 |
|
28804 </p> |
|
28805 |
|
28806 |
|
28807 |
|
28808 |
|
28809 <p>Available since 3.5.0</p> |
|
28810 |
|
28811 </div> |
|
28812 |
|
28813 <div class="description"> |
|
28814 <p>A map of column key to column configuration objects parsed from the |
|
28815 <code>columns</code> attribute.</p> |
|
28816 </div> |
|
28817 |
|
28818 |
|
28819 <p><strong>Default:</strong> undefined (initially unset)</p> |
|
28820 |
|
28821 |
|
28822 |
|
28823 |
|
28824 |
|
28825 </div> |
|
28826 |
|
28827 |
|
28828 <div id="property__displayColumns" class="property item inherited"> |
|
28829 <h3 class="name"><code>_displayColumns</code></h3> |
|
28830 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
28831 |
|
28832 |
|
28833 |
|
28834 |
|
28835 |
|
28836 |
|
28837 |
|
28838 |
|
28839 |
|
28840 <div class="meta"> |
|
28841 |
|
28842 |
|
28843 <p>Inherited from |
|
28844 <a href="../classes/DataTable.Base.html#property__displayColumns">DataTable.Base</a>: |
|
28845 |
|
28846 |
|
28847 |
|
28848 <a href="../files/datatable_js_base.js.html#l377"><code>datatable/js/base.js:377</code></a> |
|
28849 |
|
28850 </p> |
|
28851 |
|
28852 |
|
28853 |
|
28854 |
|
28855 <p>Available since 3.5.0</p> |
|
28856 |
|
28857 </div> |
|
28858 |
|
28859 <div class="description"> |
|
28860 <p>Array of the columns that correspond to those with value cells in the |
|
28861 data rows. Excludes colspan header columns (configured with <code>children</code>).</p> |
|
28862 </div> |
|
28863 |
|
28864 |
|
28865 |
|
28866 |
|
28867 |
|
28868 |
|
28869 </div> |
|
28870 |
|
28871 |
|
28872 <div id="property__messageNode" class="property item"> |
|
28873 <h3 class="name"><code>_messageNode</code></h3> |
|
28874 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
28875 |
|
28876 |
|
28877 |
|
28878 |
|
28879 |
|
28880 |
|
28881 |
|
28882 |
|
28883 |
|
28884 <div class="meta"> |
|
28885 |
|
28886 |
|
28887 |
|
28888 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
28889 |
|
28890 <p> |
|
28891 |
|
28892 Defined in |
|
28893 |
|
28894 |
|
28895 |
|
28896 |
|
28897 <a href="../files/datatable_js_message.js.html#l237"><code>datatable/js/message.js:237</code></a> |
|
28898 |
|
28899 </p> |
|
28900 |
|
28901 |
|
28902 |
|
28903 |
|
28904 <p>Available since 3.5.0</p> |
|
28905 |
|
28906 </div> |
|
28907 |
|
28908 <div class="description"> |
|
28909 <p>Node used to display messages from <code>showMessage</code>.</p> |
|
28910 </div> |
|
28911 |
|
28912 |
|
28913 |
|
28914 |
|
28915 |
|
28916 |
|
28917 </div> |
|
28918 |
|
28919 |
|
28920 <div id="property__SCROLL_LINER_TEMPLATE" class="property item protected"> |
|
28921 <h3 class="name"><code>_SCROLL_LINER_TEMPLATE</code></h3> |
|
28922 <span class="type">HTML</span> |
|
28923 |
|
28924 |
|
28925 |
|
28926 |
|
28927 <span class="flag protected">protected</span> |
|
28928 |
|
28929 |
|
28930 |
|
28931 |
|
28932 |
|
28933 |
|
28934 <div class="meta"> |
|
28935 |
|
28936 |
|
28937 |
|
28938 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
28939 |
|
28940 <p> |
|
28941 |
|
28942 Defined in |
|
28943 |
|
28944 |
|
28945 |
|
28946 |
|
28947 <a href="../files/datatable_js_scroll.js.html#l134"><code>datatable/js/scroll.js:134</code></a> |
|
28948 |
|
28949 </p> |
|
28950 |
|
28951 |
|
28952 |
|
28953 |
|
28954 <p>Available since 3.5.0</p> |
|
28955 |
|
28956 </div> |
|
28957 |
|
28958 <div class="description"> |
|
28959 <p>Template used to create sizable element liners around header content to |
|
28960 synchronize fixed header column widths.</p> |
|
28961 </div> |
|
28962 |
|
28963 |
|
28964 |
|
28965 |
|
28966 |
|
28967 |
|
28968 </div> |
|
28969 |
|
28970 |
|
28971 <div id="property__SCROLLBAR_TEMPLATE" class="property item protected"> |
|
28972 <h3 class="name"><code>_SCROLLBAR_TEMPLATE</code></h3> |
|
28973 <span class="type">HTML</span> |
|
28974 |
|
28975 |
|
28976 |
|
28977 |
|
28978 <span class="flag protected">protected</span> |
|
28979 |
|
28980 |
|
28981 |
|
28982 |
|
28983 |
|
28984 |
|
28985 <div class="meta"> |
|
28986 |
|
28987 |
|
28988 |
|
28989 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
28990 |
|
28991 <p> |
|
28992 |
|
28993 Defined in |
|
28994 |
|
28995 |
|
28996 |
|
28997 |
|
28998 <a href="../files/datatable_js_scroll.js.html#l146"><code>datatable/js/scroll.js:146</code></a> |
|
28999 |
|
29000 </p> |
|
29001 |
|
29002 |
|
29003 |
|
29004 |
|
29005 <p>Available since 3.5.0</p> |
|
29006 |
|
29007 </div> |
|
29008 |
|
29009 <div class="description"> |
|
29010 <p>Template for the virtual scrollbar needed in "y" and "xy" scrolling setups.</p> |
|
29011 </div> |
|
29012 |
|
29013 |
|
29014 |
|
29015 |
|
29016 |
|
29017 |
|
29018 </div> |
|
29019 |
|
29020 |
|
29021 <div id="property__sortable" class="property item protected"> |
|
29022 <h3 class="name"><code>_sortable</code></h3> |
|
29023 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
29024 |
|
29025 |
|
29026 |
|
29027 |
|
29028 <span class="flag protected">protected</span> |
|
29029 |
|
29030 |
|
29031 |
|
29032 |
|
29033 |
|
29034 |
|
29035 <div class="meta"> |
|
29036 |
|
29037 |
|
29038 |
|
29039 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
29040 |
|
29041 <p> |
|
29042 |
|
29043 Defined in |
|
29044 |
|
29045 |
|
29046 |
|
29047 |
|
29048 <a href="../files/datatable_js_sort.js.html#l718"><code>datatable/js/sort.js:718</code></a> |
|
29049 |
|
29050 </p> |
|
29051 |
|
29052 |
|
29053 |
|
29054 |
|
29055 <p>Available since 3.5.0</p> |
|
29056 |
|
29057 </div> |
|
29058 |
|
29059 <div class="description"> |
|
29060 <p>Array of column configuration objects of those columns that need UI setup |
|
29061 for user interaction.</p> |
|
29062 </div> |
|
29063 |
|
29064 |
|
29065 |
|
29066 |
|
29067 |
|
29068 |
|
29069 </div> |
|
29070 |
|
29071 |
|
29072 <div id="property__sortBy" class="property item protected"> |
|
29073 <h3 class="name"><code>_sortBy</code></h3> |
|
29074 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
29075 |
|
29076 |
|
29077 |
|
29078 |
|
29079 <span class="flag protected">protected</span> |
|
29080 |
|
29081 |
|
29082 |
|
29083 |
|
29084 |
|
29085 |
|
29086 <div class="meta"> |
|
29087 |
|
29088 |
|
29089 |
|
29090 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
29091 |
|
29092 <p> |
|
29093 |
|
29094 Defined in |
|
29095 |
|
29096 |
|
29097 |
|
29098 |
|
29099 <a href="../files/datatable_js_sort.js.html#l729"><code>datatable/js/sort.js:729</code></a> |
|
29100 |
|
29101 </p> |
|
29102 |
|
29103 |
|
29104 |
|
29105 |
|
29106 <p>Available since 3.5.0</p> |
|
29107 |
|
29108 </div> |
|
29109 |
|
29110 <div class="description"> |
|
29111 <p>Array of column configuration objects for those columns that are currently |
|
29112 being used to sort the data. Fake column objects are used for fields that |
|
29113 are not rendered as columns.</p> |
|
29114 </div> |
|
29115 |
|
29116 |
|
29117 |
|
29118 |
|
29119 |
|
29120 |
|
29121 </div> |
|
29122 |
|
29123 |
|
29124 <div id="property__tableNode" class="property item protected"> |
|
29125 <h3 class="name"><code>_tableNode</code></h3> |
|
29126 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
29127 |
|
29128 |
|
29129 |
|
29130 |
|
29131 <span class="flag protected">protected</span> |
|
29132 |
|
29133 |
|
29134 |
|
29135 |
|
29136 |
|
29137 |
|
29138 <div class="meta"> |
|
29139 |
|
29140 |
|
29141 |
|
29142 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
29143 |
|
29144 <p> |
|
29145 |
|
29146 Defined in |
|
29147 |
|
29148 |
|
29149 |
|
29150 |
|
29151 <a href="../files/datatable_js_core.js.html#l320"><code>datatable/js/core.js:320</code></a> |
|
29152 |
|
29153 </p> |
|
29154 |
|
29155 |
|
29156 |
|
29157 |
|
29158 <p>Available since 3.5.0</p> |
|
29159 |
|
29160 </div> |
|
29161 |
|
29162 <div class="description"> |
|
29163 <p>The Node instance of the table containing the data rows. This is set when |
|
29164 the table is rendered. It may also be set by progressive enhancement, |
|
29165 though this extension does not provide the logic to parse from source.</p> |
|
29166 </div> |
|
29167 |
|
29168 |
|
29169 <p><strong>Default:</strong> undefined (initially unset)</p> |
|
29170 |
|
29171 |
|
29172 |
|
29173 |
|
29174 |
|
29175 </div> |
|
29176 |
|
29177 |
|
29178 <div id="property__UI_ATTRS" class="property item private inherited"> |
|
29179 <h3 class="name"><code>_UI_ATTRS</code></h3> |
|
29180 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
29181 |
|
29182 |
|
29183 |
|
29184 |
|
29185 <span class="flag private">private</span> |
|
29186 |
|
29187 |
|
29188 |
|
29189 |
|
29190 |
|
29191 |
|
29192 <div class="meta"> |
|
29193 |
|
29194 |
|
29195 <p>Inherited from |
|
29196 <a href="../classes/Widget.html#property__UI_ATTRS">Widget</a>: |
|
29197 |
|
29198 |
|
29199 |
|
29200 <a href="../files/widget_js_Widget.js.html#l1249"><code>widget/js/Widget.js:1249</code></a> |
|
29201 |
|
29202 </p> |
|
29203 |
|
29204 |
|
29205 |
|
29206 |
|
29207 </div> |
|
29208 |
|
29209 <div class="description"> |
|
29210 <p>The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations</p> |
|
29211 </div> |
|
29212 |
|
29213 |
|
29214 |
|
29215 |
|
29216 |
|
29217 |
|
29218 </div> |
|
29219 |
|
29220 |
|
29221 <div id="property__X_SCROLLER_TEMPLATE" class="property item protected"> |
|
29222 <h3 class="name"><code>_X_SCROLLER_TEMPLATE</code></h3> |
|
29223 <span class="type">HTML</span> |
|
29224 |
|
29225 |
|
29226 |
|
29227 |
|
29228 <span class="flag protected">protected</span> |
|
29229 |
|
29230 |
|
29231 |
|
29232 |
|
29233 |
|
29234 |
|
29235 <div class="meta"> |
|
29236 |
|
29237 |
|
29238 |
|
29239 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
29240 |
|
29241 <p> |
|
29242 |
|
29243 Defined in |
|
29244 |
|
29245 |
|
29246 |
|
29247 |
|
29248 <a href="../files/datatable_js_scroll.js.html#l157"><code>datatable/js/scroll.js:157</code></a> |
|
29249 |
|
29250 </p> |
|
29251 |
|
29252 |
|
29253 |
|
29254 |
|
29255 <p>Available since 3.5.0</p> |
|
29256 |
|
29257 </div> |
|
29258 |
|
29259 <div class="description"> |
|
29260 <p>Template for the <code><div></code> that is used to contain the table when the table is |
|
29261 horizontally scrolling.</p> |
|
29262 </div> |
|
29263 |
|
29264 |
|
29265 |
|
29266 |
|
29267 |
|
29268 |
|
29269 </div> |
|
29270 |
|
29271 |
|
29272 <div id="property__xScroll" class="property item private"> |
|
29273 <h3 class="name"><code>_xScroll</code></h3> |
|
29274 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
29275 |
|
29276 |
|
29277 |
|
29278 |
|
29279 <span class="flag private">private</span> |
|
29280 |
|
29281 |
|
29282 |
|
29283 |
|
29284 |
|
29285 |
|
29286 <div class="meta"> |
|
29287 |
|
29288 |
|
29289 |
|
29290 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
29291 |
|
29292 <p> |
|
29293 |
|
29294 Defined in |
|
29295 |
|
29296 |
|
29297 |
|
29298 |
|
29299 <a href="../files/datatable_js_scroll.js.html#l1324"><code>datatable/js/scroll.js:1324</code></a> |
|
29300 |
|
29301 </p> |
|
29302 |
|
29303 |
|
29304 |
|
29305 |
|
29306 <p>Available since 3.5.0</p> |
|
29307 |
|
29308 </div> |
|
29309 |
|
29310 <div class="description"> |
|
29311 <p>Indicates horizontal table scrolling is enabled.</p> |
|
29312 </div> |
|
29313 |
|
29314 |
|
29315 <p><strong>Default:</strong> undefined (not initially set)</p> |
|
29316 |
|
29317 |
|
29318 |
|
29319 |
|
29320 |
|
29321 </div> |
|
29322 |
|
29323 |
|
29324 <div id="property__xScrollNode" class="property item protected"> |
|
29325 <h3 class="name"><code>_xScrollNode</code></h3> |
|
29326 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
29327 |
|
29328 |
|
29329 |
|
29330 |
|
29331 <span class="flag protected">protected</span> |
|
29332 |
|
29333 |
|
29334 |
|
29335 |
|
29336 |
|
29337 |
|
29338 <div class="meta"> |
|
29339 |
|
29340 |
|
29341 |
|
29342 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
29343 |
|
29344 <p> |
|
29345 |
|
29346 Defined in |
|
29347 |
|
29348 |
|
29349 |
|
29350 |
|
29351 <a href="../files/datatable_js_scroll.js.html#l1368"><code>datatable/js/scroll.js:1368</code></a> |
|
29352 |
|
29353 </p> |
|
29354 |
|
29355 |
|
29356 |
|
29357 |
|
29358 <p>Available since 3.5.0</p> |
|
29359 |
|
29360 </div> |
|
29361 |
|
29362 <div class="description"> |
|
29363 <p>Overflow Node used to contain the table headers and data in a horizontally |
|
29364 scrolling table.</p> |
|
29365 </div> |
|
29366 |
|
29367 |
|
29368 <p><strong>Default:</strong> undefined (not initially set)</p> |
|
29369 |
|
29370 |
|
29371 |
|
29372 |
|
29373 |
|
29374 </div> |
|
29375 |
|
29376 |
|
29377 <div id="property__Y_SCROLL_HEADER_TEMPLATE" class="property item protected"> |
|
29378 <h3 class="name"><code>_Y_SCROLL_HEADER_TEMPLATE</code></h3> |
|
29379 <span class="type">HTML</span> |
|
29380 |
|
29381 |
|
29382 |
|
29383 |
|
29384 <span class="flag protected">protected</span> |
|
29385 |
|
29386 |
|
29387 |
|
29388 |
|
29389 |
|
29390 |
|
29391 <div class="meta"> |
|
29392 |
|
29393 |
|
29394 |
|
29395 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
29396 |
|
29397 <p> |
|
29398 |
|
29399 Defined in |
|
29400 |
|
29401 |
|
29402 |
|
29403 |
|
29404 <a href="../files/datatable_js_scroll.js.html#l169"><code>datatable/js/scroll.js:169</code></a> |
|
29405 |
|
29406 </p> |
|
29407 |
|
29408 |
|
29409 |
|
29410 |
|
29411 <p>Available since 3.5.0</p> |
|
29412 |
|
29413 </div> |
|
29414 |
|
29415 <div class="description"> |
|
29416 <p>Template for the <code><table></code> used to contain the fixed column headers for |
|
29417 vertically scrolling tables.</p> |
|
29418 </div> |
|
29419 |
|
29420 |
|
29421 |
|
29422 |
|
29423 |
|
29424 |
|
29425 </div> |
|
29426 |
|
29427 |
|
29428 <div id="property__Y_SCROLLER_TEMPLATE" class="property item protected"> |
|
29429 <h3 class="name"><code>_Y_SCROLLER_TEMPLATE</code></h3> |
|
29430 <span class="type">HTML</span> |
|
29431 |
|
29432 |
|
29433 |
|
29434 |
|
29435 <span class="flag protected">protected</span> |
|
29436 |
|
29437 |
|
29438 |
|
29439 |
|
29440 |
|
29441 |
|
29442 <div class="meta"> |
|
29443 |
|
29444 |
|
29445 |
|
29446 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
29447 |
|
29448 <p> |
|
29449 |
|
29450 Defined in |
|
29451 |
|
29452 |
|
29453 |
|
29454 |
|
29455 <a href="../files/datatable_js_scroll.js.html#l181"><code>datatable/js/scroll.js:181</code></a> |
|
29456 |
|
29457 </p> |
|
29458 |
|
29459 |
|
29460 |
|
29461 |
|
29462 <p>Available since 3.5.0</p> |
|
29463 |
|
29464 </div> |
|
29465 |
|
29466 <div class="description"> |
|
29467 <p>Template for the <code><div></code> that is used to contain the rows when the table is |
|
29468 vertically scrolling.</p> |
|
29469 </div> |
|
29470 |
|
29471 |
|
29472 |
|
29473 |
|
29474 |
|
29475 |
|
29476 </div> |
|
29477 |
|
29478 |
|
29479 <div id="property__yScroll" class="property item private"> |
|
29480 <h3 class="name"><code>_yScroll</code></h3> |
|
29481 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
29482 |
|
29483 |
|
29484 |
|
29485 |
|
29486 <span class="flag private">private</span> |
|
29487 |
|
29488 |
|
29489 |
|
29490 |
|
29491 |
|
29492 |
|
29493 <div class="meta"> |
|
29494 |
|
29495 |
|
29496 |
|
29497 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
29498 |
|
29499 <p> |
|
29500 |
|
29501 Defined in |
|
29502 |
|
29503 |
|
29504 |
|
29505 |
|
29506 <a href="../files/datatable_js_scroll.js.html#l1335"><code>datatable/js/scroll.js:1335</code></a> |
|
29507 |
|
29508 </p> |
|
29509 |
|
29510 |
|
29511 |
|
29512 |
|
29513 <p>Available since 3.5.0</p> |
|
29514 |
|
29515 </div> |
|
29516 |
|
29517 <div class="description"> |
|
29518 <p>Indicates vertical table scrolling is enabled.</p> |
|
29519 </div> |
|
29520 |
|
29521 |
|
29522 <p><strong>Default:</strong> undefined (not initially set)</p> |
|
29523 |
|
29524 |
|
29525 |
|
29526 |
|
29527 |
|
29528 </div> |
|
29529 |
|
29530 |
|
29531 <div id="property__yScrollHeader" class="property item protected"> |
|
29532 <h3 class="name"><code>_yScrollHeader</code></h3> |
|
29533 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
29534 |
|
29535 |
|
29536 |
|
29537 |
|
29538 <span class="flag protected">protected</span> |
|
29539 |
|
29540 |
|
29541 |
|
29542 |
|
29543 |
|
29544 |
|
29545 <div class="meta"> |
|
29546 |
|
29547 |
|
29548 |
|
29549 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
29550 |
|
29551 <p> |
|
29552 |
|
29553 Defined in |
|
29554 |
|
29555 |
|
29556 |
|
29557 |
|
29558 <a href="../files/datatable_js_scroll.js.html#l1346"><code>datatable/js/scroll.js:1346</code></a> |
|
29559 |
|
29560 </p> |
|
29561 |
|
29562 |
|
29563 |
|
29564 |
|
29565 <p>Available since 3.5.0</p> |
|
29566 |
|
29567 </div> |
|
29568 |
|
29569 <div class="description"> |
|
29570 <p>Fixed column header <code><table></code> Node for vertical scrolling tables.</p> |
|
29571 </div> |
|
29572 |
|
29573 |
|
29574 <p><strong>Default:</strong> undefined (not initially set)</p> |
|
29575 |
|
29576 |
|
29577 |
|
29578 |
|
29579 |
|
29580 </div> |
|
29581 |
|
29582 |
|
29583 <div id="property__yScrollNode" class="property item protected"> |
|
29584 <h3 class="name"><code>_yScrollNode</code></h3> |
|
29585 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
29586 |
|
29587 |
|
29588 |
|
29589 |
|
29590 <span class="flag protected">protected</span> |
|
29591 |
|
29592 |
|
29593 |
|
29594 |
|
29595 |
|
29596 |
|
29597 <div class="meta"> |
|
29598 |
|
29599 |
|
29600 |
|
29601 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
29602 |
|
29603 <p> |
|
29604 |
|
29605 Defined in |
|
29606 |
|
29607 |
|
29608 |
|
29609 |
|
29610 <a href="../files/datatable_js_scroll.js.html#l1357"><code>datatable/js/scroll.js:1357</code></a> |
|
29611 |
|
29612 </p> |
|
29613 |
|
29614 |
|
29615 |
|
29616 |
|
29617 <p>Available since 3.5.0</p> |
|
29618 |
|
29619 </div> |
|
29620 |
|
29621 <div class="description"> |
|
29622 <p>Overflow Node used to contain the data rows in a vertically scrolling table.</p> |
|
29623 </div> |
|
29624 |
|
29625 |
|
29626 <p><strong>Default:</strong> undefined (not initially set)</p> |
|
29627 |
|
29628 |
|
29629 |
|
29630 |
|
29631 |
|
29632 </div> |
|
29633 |
|
29634 |
|
29635 <div id="property_BOUNDING_TEMPLATE" class="property item inherited"> |
|
29636 <h3 class="name"><code>BOUNDING_TEMPLATE</code></h3> |
|
29637 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
29638 |
|
29639 |
|
29640 |
|
29641 |
|
29642 |
|
29643 |
|
29644 |
|
29645 |
|
29646 |
|
29647 <div class="meta"> |
|
29648 |
|
29649 |
|
29650 <p>Inherited from |
|
29651 <a href="../classes/Widget.html#property_BOUNDING_TEMPLATE">Widget</a>: |
|
29652 |
|
29653 |
|
29654 |
|
29655 <a href="../files/widget_js_Widget.js.html#l1145"><code>widget/js/Widget.js:1145</code></a> |
|
29656 |
|
29657 </p> |
|
29658 |
|
29659 |
|
29660 |
|
29661 |
|
29662 </div> |
|
29663 |
|
29664 <div class="description"> |
|
29665 <p>Property defining the markup template for bounding box.</p> |
|
29666 </div> |
|
29667 |
|
29668 |
|
29669 |
|
29670 |
|
29671 |
|
29672 |
|
29673 </div> |
|
29674 |
|
29675 |
|
29676 <div id="property_COL_TEMPLATE" class="property item"> |
|
29677 <h3 class="name"><code>COL_TEMPLATE</code></h3> |
|
29678 <span class="type">HTML</span> |
|
29679 |
|
29680 |
|
29681 |
|
29682 |
|
29683 |
|
29684 |
|
29685 |
|
29686 |
|
29687 |
|
29688 <div class="meta"> |
|
29689 |
|
29690 |
|
29691 |
|
29692 <p>Provided by the <a href="../modules/datatable-column-widths.html">datatable-column-widths</a> module.</p> |
|
29693 |
|
29694 <p> |
|
29695 |
|
29696 Defined in |
|
29697 |
|
29698 |
|
29699 |
|
29700 |
|
29701 <a href="../files/datatable_js_colwidths.js.html#l118"><code>datatable/js/colwidths.js:118</code></a> |
|
29702 |
|
29703 </p> |
|
29704 |
|
29705 |
|
29706 |
|
29707 |
|
29708 <p>Available since 3.5.0</p> |
|
29709 |
|
29710 </div> |
|
29711 |
|
29712 <div class="description"> |
|
29713 <p>The HTML template used to create the table's <code><col></code>s.</p> |
|
29714 </div> |
|
29715 |
|
29716 |
|
29717 <p><strong>Default:</strong> '<col/>'</p> |
|
29718 |
|
29719 |
|
29720 |
|
29721 |
|
29722 |
|
29723 </div> |
|
29724 |
|
29725 |
|
29726 <div id="property_COLGROUP_TEMPLATE" class="property item"> |
|
29727 <h3 class="name"><code>COLGROUP_TEMPLATE</code></h3> |
|
29728 <span class="type">HTML</span> |
|
29729 |
|
29730 |
|
29731 |
|
29732 |
|
29733 |
|
29734 |
|
29735 |
|
29736 |
|
29737 |
|
29738 <div class="meta"> |
|
29739 |
|
29740 |
|
29741 |
|
29742 <p>Provided by the <a href="../modules/datatable-column-widths.html">datatable-column-widths</a> module.</p> |
|
29743 |
|
29744 <p> |
|
29745 |
|
29746 Defined in |
|
29747 |
|
29748 |
|
29749 |
|
29750 |
|
29751 <a href="../files/datatable_js_colwidths.js.html#l128"><code>datatable/js/colwidths.js:128</code></a> |
|
29752 |
|
29753 </p> |
|
29754 |
|
29755 |
|
29756 |
|
29757 |
|
29758 <p>Available since 3.5.0</p> |
|
29759 |
|
29760 </div> |
|
29761 |
|
29762 <div class="description"> |
|
29763 <p>The HTML template used to create the table's <code><colgroup></code>.</p> |
|
29764 </div> |
|
29765 |
|
29766 |
|
29767 <p><strong>Default:</strong> '<colgroup/>'</p> |
|
29768 |
|
29769 |
|
29770 |
|
29771 |
|
29772 |
|
29773 </div> |
|
29774 |
|
29775 |
|
29776 <div id="property_CONTENT_TEMPLATE" class="property item inherited"> |
|
29777 <h3 class="name"><code>CONTENT_TEMPLATE</code></h3> |
|
29778 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
29779 |
|
29780 |
|
29781 |
|
29782 |
|
29783 |
|
29784 |
|
29785 |
|
29786 |
|
29787 |
|
29788 <div class="meta"> |
|
29789 |
|
29790 |
|
29791 <p>Inherited from |
|
29792 <a href="../classes/Widget.html#property_CONTENT_TEMPLATE">Widget</a>: |
|
29793 |
|
29794 |
|
29795 |
|
29796 <a href="../files/widget_js_Widget.js.html#l1135"><code>widget/js/Widget.js:1135</code></a> |
|
29797 |
|
29798 </p> |
|
29799 |
|
29800 |
|
29801 |
|
29802 |
|
29803 </div> |
|
29804 |
|
29805 <div class="description"> |
|
29806 <p>Property defining the markup template for content box. If your Widget doesn't |
|
29807 need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null, |
|
29808 and contentBox and boundingBox will both point to the same Node.</p> |
|
29809 </div> |
|
29810 |
|
29811 |
|
29812 |
|
29813 |
|
29814 |
|
29815 |
|
29816 </div> |
|
29817 |
|
29818 |
|
29819 <div id="property_data" class="property item"> |
|
29820 <h3 class="name"><code>data</code></h3> |
|
29821 <span class="type"><a href="../classes/ModelList.html" class="crosslink">ModelList</a></span> |
|
29822 |
|
29823 |
|
29824 |
|
29825 |
|
29826 |
|
29827 |
|
29828 |
|
29829 |
|
29830 |
|
29831 <div class="meta"> |
|
29832 |
|
29833 |
|
29834 |
|
29835 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
29836 |
|
29837 <p> |
|
29838 |
|
29839 Defined in |
|
29840 |
|
29841 |
|
29842 |
|
29843 |
|
29844 <a href="../files/datatable_js_core.js.html#l201"><code>datatable/js/core.js:201</code></a> |
|
29845 |
|
29846 </p> |
|
29847 |
|
29848 |
|
29849 |
|
29850 |
|
29851 <p>Available since 3.5.0</p> |
|
29852 |
|
29853 </div> |
|
29854 |
|
29855 <div class="description"> |
|
29856 <p>The ModelList that manages the table's data.</p> |
|
29857 </div> |
|
29858 |
|
29859 |
|
29860 <p><strong>Default:</strong> undefined (initially unset)</p> |
|
29861 |
|
29862 |
|
29863 |
|
29864 |
|
29865 |
|
29866 </div> |
|
29867 |
|
29868 |
|
29869 <div id="property_DEF_PARENT_NODE" class="property item inherited"> |
|
29870 <h3 class="name"><code>DEF_PARENT_NODE</code></h3> |
|
29871 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
29872 |
|
29873 |
|
29874 |
|
29875 |
|
29876 |
|
29877 |
|
29878 |
|
29879 |
|
29880 |
|
29881 <div class="meta"> |
|
29882 |
|
29883 |
|
29884 <p>Inherited from |
|
29885 <a href="../classes/Widget.html#property_DEF_PARENT_NODE">Widget</a>: |
|
29886 |
|
29887 |
|
29888 |
|
29889 <a href="../files/widget_js_Widget.js.html#l1126"><code>widget/js/Widget.js:1126</code></a> |
|
29890 |
|
29891 </p> |
|
29892 |
|
29893 |
|
29894 |
|
29895 |
|
29896 </div> |
|
29897 |
|
29898 <div class="description"> |
|
29899 <p>Default node to render the bounding box to. If not set, |
|
29900 will default to the current document body.</p> |
|
29901 </div> |
|
29902 |
|
29903 |
|
29904 |
|
29905 |
|
29906 |
|
29907 |
|
29908 </div> |
|
29909 |
|
29910 |
|
29911 <div id="property_DEF_UNIT" class="property item inherited"> |
|
29912 <h3 class="name"><code>DEF_UNIT</code></h3> |
|
29913 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
29914 |
|
29915 |
|
29916 |
|
29917 |
|
29918 |
|
29919 |
|
29920 |
|
29921 |
|
29922 |
|
29923 <div class="meta"> |
|
29924 |
|
29925 |
|
29926 <p>Inherited from |
|
29927 <a href="../classes/Widget.html#property_DEF_UNIT">Widget</a>: |
|
29928 |
|
29929 |
|
29930 |
|
29931 <a href="../files/widget_js_Widget.js.html#l1118"><code>widget/js/Widget.js:1118</code></a> |
|
29932 |
|
29933 </p> |
|
29934 |
|
29935 |
|
29936 |
|
29937 |
|
29938 </div> |
|
29939 |
|
29940 <div class="description"> |
|
29941 <p>Default unit to use for dimension values</p> |
|
29942 </div> |
|
29943 |
|
29944 |
|
29945 |
|
29946 |
|
29947 |
|
29948 |
|
29949 </div> |
|
29950 |
|
29951 |
|
29952 <div id="property_MESSAGE_TEMPLATE" class="property item"> |
|
29953 <h3 class="name"><code>MESSAGE_TEMPLATE</code></h3> |
|
29954 <span class="type">HTML</span> |
|
29955 |
|
29956 |
|
29957 |
|
29958 |
|
29959 |
|
29960 |
|
29961 |
|
29962 |
|
29963 |
|
29964 <div class="meta"> |
|
29965 |
|
29966 |
|
29967 |
|
29968 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
29969 |
|
29970 <p> |
|
29971 |
|
29972 Defined in |
|
29973 |
|
29974 |
|
29975 |
|
29976 |
|
29977 <a href="../files/datatable_js_message.js.html#l46"><code>datatable/js/message.js:46</code></a> |
|
29978 |
|
29979 </p> |
|
29980 |
|
29981 |
|
29982 |
|
29983 |
|
29984 <p>Available since 3.5.0</p> |
|
29985 |
|
29986 </div> |
|
29987 |
|
29988 <div class="description"> |
|
29989 <p>Template used to generate the node that will be used to report messages.</p> |
|
29990 </div> |
|
29991 |
|
29992 |
|
29993 <p><strong>Default:</strong> <tbody class="{className}"><td class="{contentClass}" colspan="{colspan}"></td></tbody></p> |
|
29994 |
|
29995 |
|
29996 |
|
29997 |
|
29998 |
|
29999 </div> |
|
30000 |
|
30001 |
|
30002 <div id="property_name" class="property item deprecated inherited"> |
|
30003 <h3 class="name"><code>name</code></h3> |
|
30004 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30005 |
|
30006 |
|
30007 <span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span> |
|
30008 |
|
30009 |
|
30010 |
|
30011 |
|
30012 |
|
30013 |
|
30014 |
|
30015 |
|
30016 <div class="meta"> |
|
30017 |
|
30018 |
|
30019 <p>Inherited from |
|
30020 <a href="../classes/BaseCore.html#property_name">BaseCore</a>: |
|
30021 |
|
30022 |
|
30023 |
|
30024 <a href="../files/base_js_BaseCore.js.html#l242"><code>base/js/BaseCore.js:242</code></a> |
|
30025 |
|
30026 </p> |
|
30027 |
|
30028 |
|
30029 <p>Deprecated: Use this.constructor.NAME</p> |
|
30030 |
|
30031 |
|
30032 |
|
30033 </div> |
|
30034 |
|
30035 <div class="description"> |
|
30036 <p>The string used to identify the class of this object.</p> |
|
30037 </div> |
|
30038 |
|
30039 |
|
30040 |
|
30041 |
|
30042 |
|
30043 |
|
30044 </div> |
|
30045 |
|
30046 |
|
30047 <div id="property_SORTABLE_HEADER_TEMPLATE" class="property item"> |
|
30048 <h3 class="name"><code>SORTABLE_HEADER_TEMPLATE</code></h3> |
|
30049 <span class="type">HTML</span> |
|
30050 |
|
30051 |
|
30052 |
|
30053 |
|
30054 |
|
30055 |
|
30056 |
|
30057 |
|
30058 |
|
30059 <div class="meta"> |
|
30060 |
|
30061 |
|
30062 |
|
30063 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
30064 |
|
30065 <p> |
|
30066 |
|
30067 Defined in |
|
30068 |
|
30069 |
|
30070 |
|
30071 |
|
30072 <a href="../files/datatable_js_sort.js.html#l218"><code>datatable/js/sort.js:218</code></a> |
|
30073 |
|
30074 </p> |
|
30075 |
|
30076 |
|
30077 |
|
30078 |
|
30079 <p>Available since 3.5.0</p> |
|
30080 |
|
30081 </div> |
|
30082 |
|
30083 <div class="description"> |
|
30084 <p>Template for the node that will wrap the header content for sortable |
|
30085 columns.</p> |
|
30086 </div> |
|
30087 |
|
30088 |
|
30089 |
|
30090 |
|
30091 |
|
30092 |
|
30093 </div> |
|
30094 |
|
30095 |
|
30096 <div id="property_UI_EVENTS" class="property item inherited"> |
|
30097 <h3 class="name"><code>UI_EVENTS</code></h3> |
|
30098 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
30099 |
|
30100 |
|
30101 |
|
30102 |
|
30103 |
|
30104 |
|
30105 |
|
30106 |
|
30107 |
|
30108 <div class="meta"> |
|
30109 |
|
30110 |
|
30111 <p>Inherited from |
|
30112 <a href="../classes/Widget.html#property_UI_EVENTS">Widget</a>: |
|
30113 |
|
30114 |
|
30115 |
|
30116 <a href="../files/widget_js_WidgetUIEvents.js.html#l52"><code>widget/js/WidgetUIEvents.js:52</code></a> |
|
30117 |
|
30118 </p> |
|
30119 |
|
30120 |
|
30121 |
|
30122 |
|
30123 </div> |
|
30124 |
|
30125 <div class="description"> |
|
30126 <p>Map of DOM events that should be fired as Custom Events by the |
|
30127 Widget instance.</p> |
|
30128 </div> |
|
30129 |
|
30130 |
|
30131 |
|
30132 |
|
30133 |
|
30134 |
|
30135 </div> |
|
30136 |
|
30137 |
|
30138 </div> |
|
30139 |
|
30140 |
|
30141 |
|
30142 <div id="attrs" class="api-class-tabpanel"> |
|
30143 <h2 class="off-left">Attributes</h2> |
|
30144 |
|
30145 |
|
30146 <div id="attr_autoSync" class="attr item"> |
|
30147 <a name="config_autoSync"></a> |
|
30148 <h3 class="name"><code>autoSync</code></h3> |
|
30149 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
30150 |
|
30151 |
|
30152 |
|
30153 |
|
30154 |
|
30155 |
|
30156 |
|
30157 |
|
30158 |
|
30159 |
|
30160 |
|
30161 |
|
30162 |
|
30163 |
|
30164 |
|
30165 <div class="meta"> |
|
30166 |
|
30167 |
|
30168 |
|
30169 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
30170 |
|
30171 <p> |
|
30172 |
|
30173 Defined in |
|
30174 |
|
30175 |
|
30176 |
|
30177 |
|
30178 <a href="../files/datatable_js_mutable.js.html#l40"><code>datatable/js/mutable.js:40</code></a> |
|
30179 |
|
30180 </p> |
|
30181 |
|
30182 |
|
30183 |
|
30184 |
|
30185 <p>Available since 3.5.0</p> |
|
30186 |
|
30187 </div> |
|
30188 |
|
30189 <div class="description"> |
|
30190 <p>Controls whether <code>addRow</code>, <code>removeRow</code>, and <code>modifyRow</code> should trigger the |
|
30191 underlying Model's sync layer by default.</p> |
|
30192 |
|
30193 <p>When <code>true</code>, it is unnecessary to pass the "sync" configuration property to |
|
30194 those methods to trigger per-operation sync.</p> |
|
30195 </div> |
|
30196 |
|
30197 |
|
30198 <p><strong>Default:</strong> `false`</p> |
|
30199 |
|
30200 |
|
30201 |
|
30202 <div class="emits box"> |
|
30203 <h4>Fires event <code>autoSyncChange</code></h4> |
|
30204 |
|
30205 <p> |
|
30206 Fires when the value for the configuration attribute <code>autoSync</code> is |
|
30207 changed. You can listen for the event using the <code>on</code> method if you |
|
30208 wish to be notified before the attribute's value has changed, or |
|
30209 using the <code>after</code> method if you wish to be notified after the |
|
30210 attribute's value has changed. |
|
30211 </p> |
|
30212 |
|
30213 <div class="params"> |
|
30214 <h4>Parameters:</h4> |
|
30215 |
|
30216 <ul class="params-list"> |
|
30217 <li class="param"> |
|
30218 <code class="param-name">e</code> |
|
30219 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
30220 |
|
30221 <div class="param-description"> |
|
30222 An Event Facade object with the following |
|
30223 attribute-specific properties added: |
|
30224 </div> |
|
30225 |
|
30226 <ul class="params-list"> |
|
30227 <li class="param"> |
|
30228 <code class="param-name">prevVal</code> |
|
30229 <span class="type">Any</span> |
|
30230 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
30231 </li> |
|
30232 <li class="param"> |
|
30233 <code class="param-name">newVal</code> |
|
30234 <span class="type">Any</span> |
|
30235 <div class="param-description">The value the attribute is to be set to.</div> |
|
30236 </li> |
|
30237 <li class="param"> |
|
30238 <code class="param-name">attrName</code> |
|
30239 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30240 <div class="param-description">The name of the attribute being set.</div> |
|
30241 </li> |
|
30242 <li class="param"> |
|
30243 <code class="param-name">subAttrName</code> |
|
30244 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30245 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
30246 </li> |
|
30247 </ul> |
|
30248 </li> |
|
30249 </ul> |
|
30250 </div> |
|
30251 </div> |
|
30252 |
|
30253 |
|
30254 |
|
30255 </div> |
|
30256 |
|
30257 |
|
30258 <div id="attr_bodyConfig" class="attr item protected inherited"> |
|
30259 <a name="config_bodyConfig"></a> |
|
30260 <h3 class="name"><code>bodyConfig</code></h3> |
|
30261 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
30262 |
|
30263 |
|
30264 |
|
30265 |
|
30266 <span class="flag protected">protected</span> |
|
30267 |
|
30268 |
|
30269 |
|
30270 |
|
30271 |
|
30272 |
|
30273 |
|
30274 |
|
30275 |
|
30276 |
|
30277 |
|
30278 |
|
30279 <div class="meta"> |
|
30280 |
|
30281 |
|
30282 <p>Inherited from |
|
30283 <a href="../classes/DataTable.Base.html#attr_bodyConfig">DataTable.Base</a>: |
|
30284 |
|
30285 |
|
30286 |
|
30287 <a href="../files/datatable_js_base.js.html#l662"><code>datatable/js/base.js:662</code></a> |
|
30288 |
|
30289 </p> |
|
30290 |
|
30291 |
|
30292 |
|
30293 |
|
30294 <p>Available since 3.6.0</p> |
|
30295 |
|
30296 </div> |
|
30297 |
|
30298 <div class="description"> |
|
30299 <p>Configuration object passed to the class constructor in <code>bodyView</code> |
|
30300 during render.</p> |
|
30301 </div> |
|
30302 |
|
30303 |
|
30304 <p><strong>Default:</strong> undefined (initially unset)</p> |
|
30305 |
|
30306 |
|
30307 |
|
30308 <div class="emits box"> |
|
30309 <h4>Fires event <code>bodyConfigChange</code></h4> |
|
30310 |
|
30311 <p> |
|
30312 Fires when the value for the configuration attribute <code>bodyConfig</code> is |
|
30313 changed. You can listen for the event using the <code>on</code> method if you |
|
30314 wish to be notified before the attribute's value has changed, or |
|
30315 using the <code>after</code> method if you wish to be notified after the |
|
30316 attribute's value has changed. |
|
30317 </p> |
|
30318 |
|
30319 <div class="params"> |
|
30320 <h4>Parameters:</h4> |
|
30321 |
|
30322 <ul class="params-list"> |
|
30323 <li class="param"> |
|
30324 <code class="param-name">e</code> |
|
30325 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
30326 |
|
30327 <div class="param-description"> |
|
30328 An Event Facade object with the following |
|
30329 attribute-specific properties added: |
|
30330 </div> |
|
30331 |
|
30332 <ul class="params-list"> |
|
30333 <li class="param"> |
|
30334 <code class="param-name">prevVal</code> |
|
30335 <span class="type">Any</span> |
|
30336 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
30337 </li> |
|
30338 <li class="param"> |
|
30339 <code class="param-name">newVal</code> |
|
30340 <span class="type">Any</span> |
|
30341 <div class="param-description">The value the attribute is to be set to.</div> |
|
30342 </li> |
|
30343 <li class="param"> |
|
30344 <code class="param-name">attrName</code> |
|
30345 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30346 <div class="param-description">The name of the attribute being set.</div> |
|
30347 </li> |
|
30348 <li class="param"> |
|
30349 <code class="param-name">subAttrName</code> |
|
30350 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30351 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
30352 </li> |
|
30353 </ul> |
|
30354 </li> |
|
30355 </ul> |
|
30356 </div> |
|
30357 </div> |
|
30358 |
|
30359 |
|
30360 |
|
30361 </div> |
|
30362 |
|
30363 |
|
30364 <div id="attr_bodyView" class="attr item inherited"> |
|
30365 <a name="config_bodyView"></a> |
|
30366 <h3 class="name"><code>bodyView</code></h3> |
|
30367 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
30368 |
|
30369 |
|
30370 |
|
30371 |
|
30372 |
|
30373 |
|
30374 |
|
30375 |
|
30376 |
|
30377 |
|
30378 |
|
30379 |
|
30380 |
|
30381 |
|
30382 |
|
30383 <div class="meta"> |
|
30384 |
|
30385 |
|
30386 <p>Inherited from |
|
30387 <a href="../classes/DataTable.Base.html#attr_bodyView">DataTable.Base</a>: |
|
30388 |
|
30389 |
|
30390 |
|
30391 <a href="../files/datatable_js_base.js.html#l639"><code>datatable/js/base.js:639</code></a> |
|
30392 |
|
30393 </p> |
|
30394 |
|
30395 |
|
30396 |
|
30397 |
|
30398 <p>Available since 3.5.0</p> |
|
30399 |
|
30400 </div> |
|
30401 |
|
30402 <div class="description"> |
|
30403 <p>If the View class assigned to the DataTable's <code>view</code> attribute supports |
|
30404 it, this class will be used for rendering the contents of the <code><tbody></code> |
|
30405 including all data rows.</p> |
|
30406 |
|
30407 <p>Similar to <code>view</code>, the instance of this View will be assigned to the |
|
30408 DataTable instance's <code>body</code> property.</p> |
|
30409 |
|
30410 <p>It is not strictly necessary that the class function assigned here be |
|
30411 a View subclass. It must however have a <code>render()</code> method.</p> |
|
30412 </div> |
|
30413 |
|
30414 |
|
30415 <p><strong>Default:</strong> Y.DataTable.BodyView</p> |
|
30416 |
|
30417 |
|
30418 |
|
30419 <div class="emits box"> |
|
30420 <h4>Fires event <code>bodyViewChange</code></h4> |
|
30421 |
|
30422 <p> |
|
30423 Fires when the value for the configuration attribute <code>bodyView</code> is |
|
30424 changed. You can listen for the event using the <code>on</code> method if you |
|
30425 wish to be notified before the attribute's value has changed, or |
|
30426 using the <code>after</code> method if you wish to be notified after the |
|
30427 attribute's value has changed. |
|
30428 </p> |
|
30429 |
|
30430 <div class="params"> |
|
30431 <h4>Parameters:</h4> |
|
30432 |
|
30433 <ul class="params-list"> |
|
30434 <li class="param"> |
|
30435 <code class="param-name">e</code> |
|
30436 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
30437 |
|
30438 <div class="param-description"> |
|
30439 An Event Facade object with the following |
|
30440 attribute-specific properties added: |
|
30441 </div> |
|
30442 |
|
30443 <ul class="params-list"> |
|
30444 <li class="param"> |
|
30445 <code class="param-name">prevVal</code> |
|
30446 <span class="type">Any</span> |
|
30447 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
30448 </li> |
|
30449 <li class="param"> |
|
30450 <code class="param-name">newVal</code> |
|
30451 <span class="type">Any</span> |
|
30452 <div class="param-description">The value the attribute is to be set to.</div> |
|
30453 </li> |
|
30454 <li class="param"> |
|
30455 <code class="param-name">attrName</code> |
|
30456 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30457 <div class="param-description">The name of the attribute being set.</div> |
|
30458 </li> |
|
30459 <li class="param"> |
|
30460 <code class="param-name">subAttrName</code> |
|
30461 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30462 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
30463 </li> |
|
30464 </ul> |
|
30465 </li> |
|
30466 </ul> |
|
30467 </div> |
|
30468 </div> |
|
30469 |
|
30470 |
|
30471 |
|
30472 </div> |
|
30473 |
|
30474 |
|
30475 <div id="attr_boundingBox" class="attr item inherited"> |
|
30476 <a name="config_boundingBox"></a> |
|
30477 <h3 class="name"><code>boundingBox</code></h3> |
|
30478 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
30479 |
|
30480 |
|
30481 |
|
30482 |
|
30483 |
|
30484 |
|
30485 |
|
30486 |
|
30487 |
|
30488 |
|
30489 |
|
30490 |
|
30491 |
|
30492 |
|
30493 |
|
30494 <div class="meta"> |
|
30495 |
|
30496 |
|
30497 <p>Inherited from |
|
30498 <a href="../classes/Widget.html#attr_boundingBox">Widget</a>: |
|
30499 |
|
30500 |
|
30501 |
|
30502 <a href="../files/widget_js_Widget.js.html#l175"><code>widget/js/Widget.js:175</code></a> |
|
30503 |
|
30504 </p> |
|
30505 |
|
30506 |
|
30507 |
|
30508 |
|
30509 </div> |
|
30510 |
|
30511 <div class="description"> |
|
30512 <p>The outermost DOM node for the Widget, used for sizing and positioning |
|
30513 of a Widget as well as a containing element for any decorator elements used |
|
30514 for skinning.</p> |
|
30515 </div> |
|
30516 |
|
30517 |
|
30518 |
|
30519 |
|
30520 <div class="emits box"> |
|
30521 <h4>Fires event <code>boundingBoxChange</code></h4> |
|
30522 |
|
30523 <p> |
|
30524 Fires when the value for the configuration attribute <code>boundingBox</code> is |
|
30525 changed. You can listen for the event using the <code>on</code> method if you |
|
30526 wish to be notified before the attribute's value has changed, or |
|
30527 using the <code>after</code> method if you wish to be notified after the |
|
30528 attribute's value has changed. |
|
30529 </p> |
|
30530 |
|
30531 <div class="params"> |
|
30532 <h4>Parameters:</h4> |
|
30533 |
|
30534 <ul class="params-list"> |
|
30535 <li class="param"> |
|
30536 <code class="param-name">e</code> |
|
30537 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
30538 |
|
30539 <div class="param-description"> |
|
30540 An Event Facade object with the following |
|
30541 attribute-specific properties added: |
|
30542 </div> |
|
30543 |
|
30544 <ul class="params-list"> |
|
30545 <li class="param"> |
|
30546 <code class="param-name">prevVal</code> |
|
30547 <span class="type">Any</span> |
|
30548 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
30549 </li> |
|
30550 <li class="param"> |
|
30551 <code class="param-name">newVal</code> |
|
30552 <span class="type">Any</span> |
|
30553 <div class="param-description">The value the attribute is to be set to.</div> |
|
30554 </li> |
|
30555 <li class="param"> |
|
30556 <code class="param-name">attrName</code> |
|
30557 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30558 <div class="param-description">The name of the attribute being set.</div> |
|
30559 </li> |
|
30560 <li class="param"> |
|
30561 <code class="param-name">subAttrName</code> |
|
30562 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30563 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
30564 </li> |
|
30565 </ul> |
|
30566 </li> |
|
30567 </ul> |
|
30568 </div> |
|
30569 </div> |
|
30570 |
|
30571 |
|
30572 |
|
30573 </div> |
|
30574 |
|
30575 |
|
30576 <div id="attr_caption" class="attr item"> |
|
30577 <a name="config_caption"></a> |
|
30578 <h3 class="name"><code>caption</code></h3> |
|
30579 <span class="type">HTML</span> |
|
30580 |
|
30581 |
|
30582 |
|
30583 |
|
30584 |
|
30585 |
|
30586 |
|
30587 |
|
30588 |
|
30589 |
|
30590 |
|
30591 |
|
30592 |
|
30593 |
|
30594 |
|
30595 <div class="meta"> |
|
30596 |
|
30597 |
|
30598 |
|
30599 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
30600 |
|
30601 <p> |
|
30602 |
|
30603 Defined in |
|
30604 |
|
30605 |
|
30606 |
|
30607 |
|
30608 <a href="../files/datatable_js_core.js.html#l153"><code>datatable/js/core.js:153</code></a> |
|
30609 |
|
30610 </p> |
|
30611 |
|
30612 |
|
30613 |
|
30614 |
|
30615 <p>Available since 3.5.0</p> |
|
30616 |
|
30617 </div> |
|
30618 |
|
30619 <div class="description"> |
|
30620 <p>HTML content of an optional <code><caption></code> element to appear above the table. |
|
30621 Leave this config unset or set to a falsy value to remove the caption.</p> |
|
30622 </div> |
|
30623 |
|
30624 |
|
30625 <p><strong>Default:</strong> '' (empty string)</p> |
|
30626 |
|
30627 |
|
30628 |
|
30629 <div class="emits box"> |
|
30630 <h4>Fires event <code>captionChange</code></h4> |
|
30631 |
|
30632 <p> |
|
30633 Fires when the value for the configuration attribute <code>caption</code> is |
|
30634 changed. You can listen for the event using the <code>on</code> method if you |
|
30635 wish to be notified before the attribute's value has changed, or |
|
30636 using the <code>after</code> method if you wish to be notified after the |
|
30637 attribute's value has changed. |
|
30638 </p> |
|
30639 |
|
30640 <div class="params"> |
|
30641 <h4>Parameters:</h4> |
|
30642 |
|
30643 <ul class="params-list"> |
|
30644 <li class="param"> |
|
30645 <code class="param-name">e</code> |
|
30646 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
30647 |
|
30648 <div class="param-description"> |
|
30649 An Event Facade object with the following |
|
30650 attribute-specific properties added: |
|
30651 </div> |
|
30652 |
|
30653 <ul class="params-list"> |
|
30654 <li class="param"> |
|
30655 <code class="param-name">prevVal</code> |
|
30656 <span class="type">Any</span> |
|
30657 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
30658 </li> |
|
30659 <li class="param"> |
|
30660 <code class="param-name">newVal</code> |
|
30661 <span class="type">Any</span> |
|
30662 <div class="param-description">The value the attribute is to be set to.</div> |
|
30663 </li> |
|
30664 <li class="param"> |
|
30665 <code class="param-name">attrName</code> |
|
30666 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30667 <div class="param-description">The name of the attribute being set.</div> |
|
30668 </li> |
|
30669 <li class="param"> |
|
30670 <code class="param-name">subAttrName</code> |
|
30671 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30672 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
30673 </li> |
|
30674 </ul> |
|
30675 </li> |
|
30676 </ul> |
|
30677 </div> |
|
30678 </div> |
|
30679 |
|
30680 |
|
30681 |
|
30682 </div> |
|
30683 |
|
30684 |
|
30685 <div id="attr_columns" class="attr item"> |
|
30686 <a name="config_columns"></a> |
|
30687 <h3 class="name"><code>columns</code></h3> |
|
30688 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span> |
|
30689 |
|
30690 |
|
30691 |
|
30692 |
|
30693 |
|
30694 |
|
30695 |
|
30696 |
|
30697 |
|
30698 |
|
30699 |
|
30700 |
|
30701 |
|
30702 |
|
30703 |
|
30704 <div class="meta"> |
|
30705 |
|
30706 |
|
30707 |
|
30708 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
30709 |
|
30710 <p> |
|
30711 |
|
30712 Defined in |
|
30713 |
|
30714 |
|
30715 |
|
30716 |
|
30717 <a href="../files/datatable_js_core.js.html#l39"><code>datatable/js/core.js:39</code></a> |
|
30718 |
|
30719 </p> |
|
30720 |
|
30721 |
|
30722 |
|
30723 |
|
30724 <p>Available since 3.5.0</p> |
|
30725 |
|
30726 </div> |
|
30727 |
|
30728 <div class="description"> |
|
30729 <p>Columns to include in the rendered table.</p> |
|
30730 |
|
30731 <p>If omitted, the attributes on the configured <code>recordType</code> or the first item |
|
30732 in the <code>data</code> collection will be used as a source.</p> |
|
30733 |
|
30734 <p>This attribute takes an array of strings or objects (mixing the two is |
|
30735 fine). Each string or object is considered a column to be rendered. |
|
30736 Strings are converted to objects, so <code>columns: ['first', 'last']</code> becomes |
|
30737 <code>columns: [{ key: 'first' }, { key: 'last' }]</code>.</p> |
|
30738 |
|
30739 <p>DataTable.Core only concerns itself with a few properties of columns. |
|
30740 These properties are:</p> |
|
30741 |
|
30742 <ul> |
|
30743 <li><code>key</code> - Used to identify the record field/attribute containing content for |
|
30744 this column. Also used to create a default Model if no <code>recordType</code> or |
|
30745 <code>data</code> are provided during construction. If <code>name</code> is not specified, this |
|
30746 is assigned to the <code>_id</code> property (with added incrementer if the key is |
|
30747 used by multiple columns).</li> |
|
30748 <li><code>children</code> - Traversed to initialize nested column objects</li> |
|
30749 <li><code>name</code> - Used in place of, or in addition to, the <code>key</code>. Useful for |
|
30750 columns that aren't bound to a field/attribute in the record data. This |
|
30751 is assigned to the <code>_id</code> property.</li> |
|
30752 <li><code>id</code> - For backward compatibility. Implementers can specify the id of |
|
30753 the header cell. This should be avoided, if possible, to avoid the |
|
30754 potential for creating DOM elements with duplicate IDs.</li> |
|
30755 <li><code>field</code> - For backward compatibility. Implementers should use <code>name</code>.</li> |
|
30756 <li><code>_id</code> - Assigned unique-within-this-instance id for a column. By order |
|
30757 of preference, assumes the value of <code>name</code>, <code>key</code>, <code>id</code>, or <code>_yuid</code>. |
|
30758 This is used by the rendering views as well as feature module |
|
30759 as a means to identify a specific column without ambiguity (such as |
|
30760 multiple columns using the same <code>key</code>.</li> |
|
30761 <li><code>_yuid</code> - Guid stamp assigned to the column object.</li> |
|
30762 <li><code>_parent</code> - Assigned to all child columns, referencing their parent |
|
30763 column.</li> |
|
30764 </ul> |
|
30765 </div> |
|
30766 |
|
30767 |
|
30768 <p><strong>Default:</strong> (from `recordType` ATTRS or first item in the `data`)</p> |
|
30769 |
|
30770 |
|
30771 |
|
30772 <div class="emits box"> |
|
30773 <h4>Fires event <code>columnsChange</code></h4> |
|
30774 |
|
30775 <p> |
|
30776 Fires when the value for the configuration attribute <code>columns</code> is |
|
30777 changed. You can listen for the event using the <code>on</code> method if you |
|
30778 wish to be notified before the attribute's value has changed, or |
|
30779 using the <code>after</code> method if you wish to be notified after the |
|
30780 attribute's value has changed. |
|
30781 </p> |
|
30782 |
|
30783 <div class="params"> |
|
30784 <h4>Parameters:</h4> |
|
30785 |
|
30786 <ul class="params-list"> |
|
30787 <li class="param"> |
|
30788 <code class="param-name">e</code> |
|
30789 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
30790 |
|
30791 <div class="param-description"> |
|
30792 An Event Facade object with the following |
|
30793 attribute-specific properties added: |
|
30794 </div> |
|
30795 |
|
30796 <ul class="params-list"> |
|
30797 <li class="param"> |
|
30798 <code class="param-name">prevVal</code> |
|
30799 <span class="type">Any</span> |
|
30800 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
30801 </li> |
|
30802 <li class="param"> |
|
30803 <code class="param-name">newVal</code> |
|
30804 <span class="type">Any</span> |
|
30805 <div class="param-description">The value the attribute is to be set to.</div> |
|
30806 </li> |
|
30807 <li class="param"> |
|
30808 <code class="param-name">attrName</code> |
|
30809 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30810 <div class="param-description">The name of the attribute being set.</div> |
|
30811 </li> |
|
30812 <li class="param"> |
|
30813 <code class="param-name">subAttrName</code> |
|
30814 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30815 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
30816 </li> |
|
30817 </ul> |
|
30818 </li> |
|
30819 </ul> |
|
30820 </div> |
|
30821 </div> |
|
30822 |
|
30823 |
|
30824 |
|
30825 </div> |
|
30826 |
|
30827 |
|
30828 <div id="attr_columnset" class="attr item deprecated"> |
|
30829 <a name="config_columnset"></a> |
|
30830 <h3 class="name"><code>columnset</code></h3> |
|
30831 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
30832 |
|
30833 |
|
30834 <span class="flag deprecated" title="Use the `columns` attribute">deprecated</span> |
|
30835 |
|
30836 |
|
30837 |
|
30838 |
|
30839 |
|
30840 |
|
30841 |
|
30842 |
|
30843 |
|
30844 |
|
30845 |
|
30846 |
|
30847 |
|
30848 |
|
30849 <div class="meta"> |
|
30850 |
|
30851 |
|
30852 |
|
30853 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
30854 |
|
30855 <p> |
|
30856 |
|
30857 Defined in |
|
30858 |
|
30859 |
|
30860 |
|
30861 |
|
30862 <a href="../files/datatable_js_core.js.html#l181"><code>datatable/js/core.js:181</code></a> |
|
30863 |
|
30864 </p> |
|
30865 |
|
30866 |
|
30867 <p>Deprecated: Use the `columns` attribute</p> |
|
30868 |
|
30869 |
|
30870 |
|
30871 <p>Available since 3.5.0</p> |
|
30872 |
|
30873 </div> |
|
30874 |
|
30875 <div class="description"> |
|
30876 <p>Deprecated as of 3.5.0. Passes through to the <code>columns</code> attribute.</p> |
|
30877 |
|
30878 <p>WARNING: <code>get('columnset')</code> will NOT return a Columnset instance as of |
|
30879 3.5.0. This is a break in backward compatibility.</p> |
|
30880 </div> |
|
30881 |
|
30882 |
|
30883 |
|
30884 |
|
30885 <div class="emits box"> |
|
30886 <h4>Fires event <code>columnsetChange</code></h4> |
|
30887 |
|
30888 <p> |
|
30889 Fires when the value for the configuration attribute <code>columnset</code> is |
|
30890 changed. You can listen for the event using the <code>on</code> method if you |
|
30891 wish to be notified before the attribute's value has changed, or |
|
30892 using the <code>after</code> method if you wish to be notified after the |
|
30893 attribute's value has changed. |
|
30894 </p> |
|
30895 |
|
30896 <div class="params"> |
|
30897 <h4>Parameters:</h4> |
|
30898 |
|
30899 <ul class="params-list"> |
|
30900 <li class="param"> |
|
30901 <code class="param-name">e</code> |
|
30902 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
30903 |
|
30904 <div class="param-description"> |
|
30905 An Event Facade object with the following |
|
30906 attribute-specific properties added: |
|
30907 </div> |
|
30908 |
|
30909 <ul class="params-list"> |
|
30910 <li class="param"> |
|
30911 <code class="param-name">prevVal</code> |
|
30912 <span class="type">Any</span> |
|
30913 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
30914 </li> |
|
30915 <li class="param"> |
|
30916 <code class="param-name">newVal</code> |
|
30917 <span class="type">Any</span> |
|
30918 <div class="param-description">The value the attribute is to be set to.</div> |
|
30919 </li> |
|
30920 <li class="param"> |
|
30921 <code class="param-name">attrName</code> |
|
30922 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30923 <div class="param-description">The name of the attribute being set.</div> |
|
30924 </li> |
|
30925 <li class="param"> |
|
30926 <code class="param-name">subAttrName</code> |
|
30927 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
30928 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
30929 </li> |
|
30930 </ul> |
|
30931 </li> |
|
30932 </ul> |
|
30933 </div> |
|
30934 </div> |
|
30935 |
|
30936 |
|
30937 |
|
30938 </div> |
|
30939 |
|
30940 |
|
30941 <div id="attr_contentBox" class="attr item inherited"> |
|
30942 <a name="config_contentBox"></a> |
|
30943 <h3 class="name"><code>contentBox</code></h3> |
|
30944 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
30945 |
|
30946 |
|
30947 |
|
30948 |
|
30949 |
|
30950 |
|
30951 |
|
30952 |
|
30953 |
|
30954 |
|
30955 |
|
30956 |
|
30957 |
|
30958 |
|
30959 |
|
30960 <div class="meta"> |
|
30961 |
|
30962 |
|
30963 <p>Inherited from |
|
30964 <a href="../classes/Widget.html#attr_contentBox">Widget</a>: |
|
30965 |
|
30966 |
|
30967 |
|
30968 <a href="../files/widget_js_Widget.js.html#l189"><code>widget/js/Widget.js:189</code></a> |
|
30969 |
|
30970 </p> |
|
30971 |
|
30972 |
|
30973 |
|
30974 |
|
30975 </div> |
|
30976 |
|
30977 <div class="description"> |
|
30978 <p>A DOM node that is a direct descendant of a Widget's bounding box that |
|
30979 houses its content.</p> |
|
30980 </div> |
|
30981 |
|
30982 |
|
30983 |
|
30984 |
|
30985 <div class="emits box"> |
|
30986 <h4>Fires event <code>contentBoxChange</code></h4> |
|
30987 |
|
30988 <p> |
|
30989 Fires when the value for the configuration attribute <code>contentBox</code> is |
|
30990 changed. You can listen for the event using the <code>on</code> method if you |
|
30991 wish to be notified before the attribute's value has changed, or |
|
30992 using the <code>after</code> method if you wish to be notified after the |
|
30993 attribute's value has changed. |
|
30994 </p> |
|
30995 |
|
30996 <div class="params"> |
|
30997 <h4>Parameters:</h4> |
|
30998 |
|
30999 <ul class="params-list"> |
|
31000 <li class="param"> |
|
31001 <code class="param-name">e</code> |
|
31002 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
31003 |
|
31004 <div class="param-description"> |
|
31005 An Event Facade object with the following |
|
31006 attribute-specific properties added: |
|
31007 </div> |
|
31008 |
|
31009 <ul class="params-list"> |
|
31010 <li class="param"> |
|
31011 <code class="param-name">prevVal</code> |
|
31012 <span class="type">Any</span> |
|
31013 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
31014 </li> |
|
31015 <li class="param"> |
|
31016 <code class="param-name">newVal</code> |
|
31017 <span class="type">Any</span> |
|
31018 <div class="param-description">The value the attribute is to be set to.</div> |
|
31019 </li> |
|
31020 <li class="param"> |
|
31021 <code class="param-name">attrName</code> |
|
31022 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31023 <div class="param-description">The name of the attribute being set.</div> |
|
31024 </li> |
|
31025 <li class="param"> |
|
31026 <code class="param-name">subAttrName</code> |
|
31027 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31028 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
31029 </li> |
|
31030 </ul> |
|
31031 </li> |
|
31032 </ul> |
|
31033 </div> |
|
31034 </div> |
|
31035 |
|
31036 |
|
31037 |
|
31038 </div> |
|
31039 |
|
31040 |
|
31041 <div id="attr_data" class="attr item"> |
|
31042 <a name="config_data"></a> |
|
31043 <h3 class="name"><code>data</code></h3> |
|
31044 <span class="type"><a href="../classes/ModelList.html" class="crosslink">ModelList</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
31045 |
|
31046 |
|
31047 |
|
31048 |
|
31049 |
|
31050 |
|
31051 |
|
31052 |
|
31053 |
|
31054 |
|
31055 |
|
31056 |
|
31057 |
|
31058 |
|
31059 |
|
31060 <div class="meta"> |
|
31061 |
|
31062 |
|
31063 |
|
31064 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
31065 |
|
31066 <p> |
|
31067 |
|
31068 Defined in |
|
31069 |
|
31070 |
|
31071 |
|
31072 |
|
31073 <a href="../files/datatable_js_core.js.html#l119"><code>datatable/js/core.js:119</code></a> |
|
31074 |
|
31075 </p> |
|
31076 |
|
31077 |
|
31078 |
|
31079 |
|
31080 <p>Available since 3.5.0</p> |
|
31081 |
|
31082 </div> |
|
31083 |
|
31084 <div class="description"> |
|
31085 <p>The collection of data records to display. This attribute is a pass |
|
31086 through to a <code>data</code> property, which is a ModelList instance.</p> |
|
31087 |
|
31088 <p>If this attribute is passed a ModelList or subclass, it will be assigned to |
|
31089 the property directly. If an array of objects is passed, a new ModelList |
|
31090 will be created using the configured <code>recordType</code> as its <code>model</code> property |
|
31091 and seeded with the array.</p> |
|
31092 |
|
31093 <p>Retrieving this attribute will return the ModelList stored in the <code>data</code> |
|
31094 property.</p> |
|
31095 </div> |
|
31096 |
|
31097 |
|
31098 <p><strong>Default:</strong> `new ModelList()`</p> |
|
31099 |
|
31100 |
|
31101 |
|
31102 <div class="emits box"> |
|
31103 <h4>Fires event <code>dataChange</code></h4> |
|
31104 |
|
31105 <p> |
|
31106 Fires when the value for the configuration attribute <code>data</code> is |
|
31107 changed. You can listen for the event using the <code>on</code> method if you |
|
31108 wish to be notified before the attribute's value has changed, or |
|
31109 using the <code>after</code> method if you wish to be notified after the |
|
31110 attribute's value has changed. |
|
31111 </p> |
|
31112 |
|
31113 <div class="params"> |
|
31114 <h4>Parameters:</h4> |
|
31115 |
|
31116 <ul class="params-list"> |
|
31117 <li class="param"> |
|
31118 <code class="param-name">e</code> |
|
31119 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
31120 |
|
31121 <div class="param-description"> |
|
31122 An Event Facade object with the following |
|
31123 attribute-specific properties added: |
|
31124 </div> |
|
31125 |
|
31126 <ul class="params-list"> |
|
31127 <li class="param"> |
|
31128 <code class="param-name">prevVal</code> |
|
31129 <span class="type">Any</span> |
|
31130 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
31131 </li> |
|
31132 <li class="param"> |
|
31133 <code class="param-name">newVal</code> |
|
31134 <span class="type">Any</span> |
|
31135 <div class="param-description">The value the attribute is to be set to.</div> |
|
31136 </li> |
|
31137 <li class="param"> |
|
31138 <code class="param-name">attrName</code> |
|
31139 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31140 <div class="param-description">The name of the attribute being set.</div> |
|
31141 </li> |
|
31142 <li class="param"> |
|
31143 <code class="param-name">subAttrName</code> |
|
31144 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31145 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
31146 </li> |
|
31147 </ul> |
|
31148 </li> |
|
31149 </ul> |
|
31150 </div> |
|
31151 </div> |
|
31152 |
|
31153 |
|
31154 |
|
31155 </div> |
|
31156 |
|
31157 |
|
31158 <div id="attr_destroyed" class="attr item inherited"> |
|
31159 <a name="config_destroyed"></a> |
|
31160 <h3 class="name"><code>destroyed</code></h3> |
|
31161 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
31162 |
|
31163 |
|
31164 |
|
31165 |
|
31166 |
|
31167 |
|
31168 |
|
31169 |
|
31170 |
|
31171 |
|
31172 |
|
31173 |
|
31174 |
|
31175 |
|
31176 <span class="flag readonly">readonly</span> |
|
31177 |
|
31178 |
|
31179 <div class="meta"> |
|
31180 |
|
31181 |
|
31182 <p>Inherited from |
|
31183 <a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>: |
|
31184 |
|
31185 |
|
31186 |
|
31187 <a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a> |
|
31188 |
|
31189 </p> |
|
31190 |
|
31191 |
|
31192 |
|
31193 |
|
31194 </div> |
|
31195 |
|
31196 <div class="description"> |
|
31197 <p>Flag indicating whether or not this object |
|
31198 has been through the destroy lifecycle phase.</p> |
|
31199 </div> |
|
31200 |
|
31201 |
|
31202 <p><strong>Default:</strong> false</p> |
|
31203 |
|
31204 |
|
31205 |
|
31206 <div class="emits box"> |
|
31207 <h4>Fires event <code>destroyedChange</code></h4> |
|
31208 |
|
31209 <p> |
|
31210 Fires when the value for the configuration attribute <code>destroyed</code> is |
|
31211 changed. You can listen for the event using the <code>on</code> method if you |
|
31212 wish to be notified before the attribute's value has changed, or |
|
31213 using the <code>after</code> method if you wish to be notified after the |
|
31214 attribute's value has changed. |
|
31215 </p> |
|
31216 |
|
31217 <div class="params"> |
|
31218 <h4>Parameters:</h4> |
|
31219 |
|
31220 <ul class="params-list"> |
|
31221 <li class="param"> |
|
31222 <code class="param-name">e</code> |
|
31223 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
31224 |
|
31225 <div class="param-description"> |
|
31226 An Event Facade object with the following |
|
31227 attribute-specific properties added: |
|
31228 </div> |
|
31229 |
|
31230 <ul class="params-list"> |
|
31231 <li class="param"> |
|
31232 <code class="param-name">prevVal</code> |
|
31233 <span class="type">Any</span> |
|
31234 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
31235 </li> |
|
31236 <li class="param"> |
|
31237 <code class="param-name">newVal</code> |
|
31238 <span class="type">Any</span> |
|
31239 <div class="param-description">The value the attribute is to be set to.</div> |
|
31240 </li> |
|
31241 <li class="param"> |
|
31242 <code class="param-name">attrName</code> |
|
31243 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31244 <div class="param-description">The name of the attribute being set.</div> |
|
31245 </li> |
|
31246 <li class="param"> |
|
31247 <code class="param-name">subAttrName</code> |
|
31248 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31249 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
31250 </li> |
|
31251 </ul> |
|
31252 </li> |
|
31253 </ul> |
|
31254 </div> |
|
31255 </div> |
|
31256 |
|
31257 |
|
31258 |
|
31259 </div> |
|
31260 |
|
31261 |
|
31262 <div id="attr_disabled" class="attr item inherited"> |
|
31263 <a name="config_disabled"></a> |
|
31264 <h3 class="name"><code>disabled</code></h3> |
|
31265 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
31266 |
|
31267 |
|
31268 |
|
31269 |
|
31270 |
|
31271 |
|
31272 |
|
31273 |
|
31274 |
|
31275 |
|
31276 |
|
31277 |
|
31278 |
|
31279 |
|
31280 |
|
31281 <div class="meta"> |
|
31282 |
|
31283 |
|
31284 <p>Inherited from |
|
31285 <a href="../classes/Widget.html#attr_disabled">Widget</a>: |
|
31286 |
|
31287 |
|
31288 |
|
31289 <a href="../files/widget_js_Widget.js.html#l231"><code>widget/js/Widget.js:231</code></a> |
|
31290 |
|
31291 </p> |
|
31292 |
|
31293 |
|
31294 |
|
31295 |
|
31296 </div> |
|
31297 |
|
31298 <div class="description"> |
|
31299 <p>Boolean indicating if the Widget should be disabled. The disabled implementation |
|
31300 is left to the specific classes extending widget.</p> |
|
31301 </div> |
|
31302 |
|
31303 |
|
31304 <p><strong>Default:</strong> false</p> |
|
31305 |
|
31306 |
|
31307 |
|
31308 <div class="emits box"> |
|
31309 <h4>Fires event <code>disabledChange</code></h4> |
|
31310 |
|
31311 <p> |
|
31312 Fires when the value for the configuration attribute <code>disabled</code> is |
|
31313 changed. You can listen for the event using the <code>on</code> method if you |
|
31314 wish to be notified before the attribute's value has changed, or |
|
31315 using the <code>after</code> method if you wish to be notified after the |
|
31316 attribute's value has changed. |
|
31317 </p> |
|
31318 |
|
31319 <div class="params"> |
|
31320 <h4>Parameters:</h4> |
|
31321 |
|
31322 <ul class="params-list"> |
|
31323 <li class="param"> |
|
31324 <code class="param-name">e</code> |
|
31325 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
31326 |
|
31327 <div class="param-description"> |
|
31328 An Event Facade object with the following |
|
31329 attribute-specific properties added: |
|
31330 </div> |
|
31331 |
|
31332 <ul class="params-list"> |
|
31333 <li class="param"> |
|
31334 <code class="param-name">prevVal</code> |
|
31335 <span class="type">Any</span> |
|
31336 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
31337 </li> |
|
31338 <li class="param"> |
|
31339 <code class="param-name">newVal</code> |
|
31340 <span class="type">Any</span> |
|
31341 <div class="param-description">The value the attribute is to be set to.</div> |
|
31342 </li> |
|
31343 <li class="param"> |
|
31344 <code class="param-name">attrName</code> |
|
31345 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31346 <div class="param-description">The name of the attribute being set.</div> |
|
31347 </li> |
|
31348 <li class="param"> |
|
31349 <code class="param-name">subAttrName</code> |
|
31350 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31351 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
31352 </li> |
|
31353 </ul> |
|
31354 </li> |
|
31355 </ul> |
|
31356 </div> |
|
31357 </div> |
|
31358 |
|
31359 |
|
31360 |
|
31361 </div> |
|
31362 |
|
31363 |
|
31364 <div id="attr_focused" class="attr item inherited"> |
|
31365 <a name="config_focused"></a> |
|
31366 <h3 class="name"><code>focused</code></h3> |
|
31367 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
31368 |
|
31369 |
|
31370 |
|
31371 |
|
31372 |
|
31373 |
|
31374 |
|
31375 |
|
31376 |
|
31377 |
|
31378 |
|
31379 |
|
31380 |
|
31381 |
|
31382 <span class="flag readonly">readonly</span> |
|
31383 |
|
31384 |
|
31385 <div class="meta"> |
|
31386 |
|
31387 |
|
31388 <p>Inherited from |
|
31389 <a href="../classes/Widget.html#attr_focused">Widget</a>: |
|
31390 |
|
31391 |
|
31392 |
|
31393 <a href="../files/widget_js_Widget.js.html#l218"><code>widget/js/Widget.js:218</code></a> |
|
31394 |
|
31395 </p> |
|
31396 |
|
31397 |
|
31398 |
|
31399 |
|
31400 </div> |
|
31401 |
|
31402 <div class="description"> |
|
31403 <p>Boolean indicating if the Widget, or one of its descendants, |
|
31404 has focus.</p> |
|
31405 </div> |
|
31406 |
|
31407 |
|
31408 <p><strong>Default:</strong> false</p> |
|
31409 |
|
31410 |
|
31411 |
|
31412 <div class="emits box"> |
|
31413 <h4>Fires event <code>focusedChange</code></h4> |
|
31414 |
|
31415 <p> |
|
31416 Fires when the value for the configuration attribute <code>focused</code> is |
|
31417 changed. You can listen for the event using the <code>on</code> method if you |
|
31418 wish to be notified before the attribute's value has changed, or |
|
31419 using the <code>after</code> method if you wish to be notified after the |
|
31420 attribute's value has changed. |
|
31421 </p> |
|
31422 |
|
31423 <div class="params"> |
|
31424 <h4>Parameters:</h4> |
|
31425 |
|
31426 <ul class="params-list"> |
|
31427 <li class="param"> |
|
31428 <code class="param-name">e</code> |
|
31429 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
31430 |
|
31431 <div class="param-description"> |
|
31432 An Event Facade object with the following |
|
31433 attribute-specific properties added: |
|
31434 </div> |
|
31435 |
|
31436 <ul class="params-list"> |
|
31437 <li class="param"> |
|
31438 <code class="param-name">prevVal</code> |
|
31439 <span class="type">Any</span> |
|
31440 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
31441 </li> |
|
31442 <li class="param"> |
|
31443 <code class="param-name">newVal</code> |
|
31444 <span class="type">Any</span> |
|
31445 <div class="param-description">The value the attribute is to be set to.</div> |
|
31446 </li> |
|
31447 <li class="param"> |
|
31448 <code class="param-name">attrName</code> |
|
31449 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31450 <div class="param-description">The name of the attribute being set.</div> |
|
31451 </li> |
|
31452 <li class="param"> |
|
31453 <code class="param-name">subAttrName</code> |
|
31454 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31455 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
31456 </li> |
|
31457 </ul> |
|
31458 </li> |
|
31459 </ul> |
|
31460 </div> |
|
31461 </div> |
|
31462 |
|
31463 |
|
31464 |
|
31465 </div> |
|
31466 |
|
31467 |
|
31468 <div id="attr_footerConfig" class="attr item protected inherited"> |
|
31469 <a name="config_footerConfig"></a> |
|
31470 <h3 class="name"><code>footerConfig</code></h3> |
|
31471 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
31472 |
|
31473 |
|
31474 |
|
31475 |
|
31476 <span class="flag protected">protected</span> |
|
31477 |
|
31478 |
|
31479 |
|
31480 |
|
31481 |
|
31482 |
|
31483 |
|
31484 |
|
31485 |
|
31486 |
|
31487 |
|
31488 |
|
31489 <div class="meta"> |
|
31490 |
|
31491 |
|
31492 <p>Inherited from |
|
31493 <a href="../classes/DataTable.Base.html#attr_footerConfig">DataTable.Base</a>: |
|
31494 |
|
31495 |
|
31496 |
|
31497 <a href="../files/datatable_js_base.js.html#l627"><code>datatable/js/base.js:627</code></a> |
|
31498 |
|
31499 </p> |
|
31500 |
|
31501 |
|
31502 |
|
31503 |
|
31504 <p>Available since 3.6.0</p> |
|
31505 |
|
31506 </div> |
|
31507 |
|
31508 <div class="description"> |
|
31509 <p>Configuration object passed to the class constructor in <code>footerView</code> |
|
31510 during render.</p> |
|
31511 </div> |
|
31512 |
|
31513 |
|
31514 <p><strong>Default:</strong> undefined (initially unset)</p> |
|
31515 |
|
31516 |
|
31517 |
|
31518 <div class="emits box"> |
|
31519 <h4>Fires event <code>footerConfigChange</code></h4> |
|
31520 |
|
31521 <p> |
|
31522 Fires when the value for the configuration attribute <code>footerConfig</code> is |
|
31523 changed. You can listen for the event using the <code>on</code> method if you |
|
31524 wish to be notified before the attribute's value has changed, or |
|
31525 using the <code>after</code> method if you wish to be notified after the |
|
31526 attribute's value has changed. |
|
31527 </p> |
|
31528 |
|
31529 <div class="params"> |
|
31530 <h4>Parameters:</h4> |
|
31531 |
|
31532 <ul class="params-list"> |
|
31533 <li class="param"> |
|
31534 <code class="param-name">e</code> |
|
31535 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
31536 |
|
31537 <div class="param-description"> |
|
31538 An Event Facade object with the following |
|
31539 attribute-specific properties added: |
|
31540 </div> |
|
31541 |
|
31542 <ul class="params-list"> |
|
31543 <li class="param"> |
|
31544 <code class="param-name">prevVal</code> |
|
31545 <span class="type">Any</span> |
|
31546 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
31547 </li> |
|
31548 <li class="param"> |
|
31549 <code class="param-name">newVal</code> |
|
31550 <span class="type">Any</span> |
|
31551 <div class="param-description">The value the attribute is to be set to.</div> |
|
31552 </li> |
|
31553 <li class="param"> |
|
31554 <code class="param-name">attrName</code> |
|
31555 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31556 <div class="param-description">The name of the attribute being set.</div> |
|
31557 </li> |
|
31558 <li class="param"> |
|
31559 <code class="param-name">subAttrName</code> |
|
31560 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31561 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
31562 </li> |
|
31563 </ul> |
|
31564 </li> |
|
31565 </ul> |
|
31566 </div> |
|
31567 </div> |
|
31568 |
|
31569 |
|
31570 |
|
31571 </div> |
|
31572 |
|
31573 |
|
31574 <div id="attr_footerView" class="attr item inherited"> |
|
31575 <a name="config_footerView"></a> |
|
31576 <h3 class="name"><code>footerView</code></h3> |
|
31577 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
31578 |
|
31579 |
|
31580 |
|
31581 |
|
31582 |
|
31583 |
|
31584 |
|
31585 |
|
31586 |
|
31587 |
|
31588 |
|
31589 |
|
31590 |
|
31591 |
|
31592 |
|
31593 <div class="meta"> |
|
31594 |
|
31595 |
|
31596 <p>Inherited from |
|
31597 <a href="../classes/DataTable.Base.html#attr_footerView">DataTable.Base</a>: |
|
31598 |
|
31599 |
|
31600 |
|
31601 <a href="../files/datatable_js_base.js.html#l607"><code>datatable/js/base.js:607</code></a> |
|
31602 |
|
31603 </p> |
|
31604 |
|
31605 |
|
31606 |
|
31607 |
|
31608 <p>Available since 3.5.0</p> |
|
31609 |
|
31610 </div> |
|
31611 |
|
31612 <div class="description"> |
|
31613 <p>If the View class assigned to the DataTable's <code>view</code> attribute supports |
|
31614 it, this class will be used for rendering the contents of the <code><tfoot></code>.</p> |
|
31615 |
|
31616 <p>Similar to <code>view</code>, the instance of this View will be assigned to the |
|
31617 DataTable instance's <code>foot</code> property.</p> |
|
31618 |
|
31619 <p>It is not strictly necessary that the class function assigned here be |
|
31620 a View subclass. It must however have a <code>render()</code> method.</p> |
|
31621 </div> |
|
31622 |
|
31623 |
|
31624 |
|
31625 |
|
31626 <div class="emits box"> |
|
31627 <h4>Fires event <code>footerViewChange</code></h4> |
|
31628 |
|
31629 <p> |
|
31630 Fires when the value for the configuration attribute <code>footerView</code> is |
|
31631 changed. You can listen for the event using the <code>on</code> method if you |
|
31632 wish to be notified before the attribute's value has changed, or |
|
31633 using the <code>after</code> method if you wish to be notified after the |
|
31634 attribute's value has changed. |
|
31635 </p> |
|
31636 |
|
31637 <div class="params"> |
|
31638 <h4>Parameters:</h4> |
|
31639 |
|
31640 <ul class="params-list"> |
|
31641 <li class="param"> |
|
31642 <code class="param-name">e</code> |
|
31643 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
31644 |
|
31645 <div class="param-description"> |
|
31646 An Event Facade object with the following |
|
31647 attribute-specific properties added: |
|
31648 </div> |
|
31649 |
|
31650 <ul class="params-list"> |
|
31651 <li class="param"> |
|
31652 <code class="param-name">prevVal</code> |
|
31653 <span class="type">Any</span> |
|
31654 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
31655 </li> |
|
31656 <li class="param"> |
|
31657 <code class="param-name">newVal</code> |
|
31658 <span class="type">Any</span> |
|
31659 <div class="param-description">The value the attribute is to be set to.</div> |
|
31660 </li> |
|
31661 <li class="param"> |
|
31662 <code class="param-name">attrName</code> |
|
31663 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31664 <div class="param-description">The name of the attribute being set.</div> |
|
31665 </li> |
|
31666 <li class="param"> |
|
31667 <code class="param-name">subAttrName</code> |
|
31668 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31669 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
31670 </li> |
|
31671 </ul> |
|
31672 </li> |
|
31673 </ul> |
|
31674 </div> |
|
31675 </div> |
|
31676 |
|
31677 |
|
31678 |
|
31679 </div> |
|
31680 |
|
31681 |
|
31682 <div id="attr_headerConfig" class="attr item protected inherited"> |
|
31683 <a name="config_headerConfig"></a> |
|
31684 <h3 class="name"><code>headerConfig</code></h3> |
|
31685 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
31686 |
|
31687 |
|
31688 |
|
31689 |
|
31690 <span class="flag protected">protected</span> |
|
31691 |
|
31692 |
|
31693 |
|
31694 |
|
31695 |
|
31696 |
|
31697 |
|
31698 |
|
31699 |
|
31700 |
|
31701 |
|
31702 |
|
31703 <div class="meta"> |
|
31704 |
|
31705 |
|
31706 <p>Inherited from |
|
31707 <a href="../classes/DataTable.Base.html#attr_headerConfig">DataTable.Base</a>: |
|
31708 |
|
31709 |
|
31710 |
|
31711 <a href="../files/datatable_js_base.js.html#l595"><code>datatable/js/base.js:595</code></a> |
|
31712 |
|
31713 </p> |
|
31714 |
|
31715 |
|
31716 |
|
31717 |
|
31718 <p>Available since 3.6.0</p> |
|
31719 |
|
31720 </div> |
|
31721 |
|
31722 <div class="description"> |
|
31723 <p>Configuration object passed to the class constructor in <code>headerView</code> |
|
31724 during render.</p> |
|
31725 </div> |
|
31726 |
|
31727 |
|
31728 <p><strong>Default:</strong> undefined (initially unset)</p> |
|
31729 |
|
31730 |
|
31731 |
|
31732 <div class="emits box"> |
|
31733 <h4>Fires event <code>headerConfigChange</code></h4> |
|
31734 |
|
31735 <p> |
|
31736 Fires when the value for the configuration attribute <code>headerConfig</code> is |
|
31737 changed. You can listen for the event using the <code>on</code> method if you |
|
31738 wish to be notified before the attribute's value has changed, or |
|
31739 using the <code>after</code> method if you wish to be notified after the |
|
31740 attribute's value has changed. |
|
31741 </p> |
|
31742 |
|
31743 <div class="params"> |
|
31744 <h4>Parameters:</h4> |
|
31745 |
|
31746 <ul class="params-list"> |
|
31747 <li class="param"> |
|
31748 <code class="param-name">e</code> |
|
31749 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
31750 |
|
31751 <div class="param-description"> |
|
31752 An Event Facade object with the following |
|
31753 attribute-specific properties added: |
|
31754 </div> |
|
31755 |
|
31756 <ul class="params-list"> |
|
31757 <li class="param"> |
|
31758 <code class="param-name">prevVal</code> |
|
31759 <span class="type">Any</span> |
|
31760 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
31761 </li> |
|
31762 <li class="param"> |
|
31763 <code class="param-name">newVal</code> |
|
31764 <span class="type">Any</span> |
|
31765 <div class="param-description">The value the attribute is to be set to.</div> |
|
31766 </li> |
|
31767 <li class="param"> |
|
31768 <code class="param-name">attrName</code> |
|
31769 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31770 <div class="param-description">The name of the attribute being set.</div> |
|
31771 </li> |
|
31772 <li class="param"> |
|
31773 <code class="param-name">subAttrName</code> |
|
31774 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31775 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
31776 </li> |
|
31777 </ul> |
|
31778 </li> |
|
31779 </ul> |
|
31780 </div> |
|
31781 </div> |
|
31782 |
|
31783 |
|
31784 |
|
31785 </div> |
|
31786 |
|
31787 |
|
31788 <div id="attr_headerView" class="attr item inherited"> |
|
31789 <a name="config_headerView"></a> |
|
31790 <h3 class="name"><code>headerView</code></h3> |
|
31791 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
31792 |
|
31793 |
|
31794 |
|
31795 |
|
31796 |
|
31797 |
|
31798 |
|
31799 |
|
31800 |
|
31801 |
|
31802 |
|
31803 |
|
31804 |
|
31805 |
|
31806 |
|
31807 <div class="meta"> |
|
31808 |
|
31809 |
|
31810 <p>Inherited from |
|
31811 <a href="../classes/DataTable.Base.html#attr_headerView">DataTable.Base</a>: |
|
31812 |
|
31813 |
|
31814 |
|
31815 <a href="../files/datatable_js_base.js.html#l572"><code>datatable/js/base.js:572</code></a> |
|
31816 |
|
31817 </p> |
|
31818 |
|
31819 |
|
31820 |
|
31821 |
|
31822 <p>Available since 3.5.0</p> |
|
31823 |
|
31824 </div> |
|
31825 |
|
31826 <div class="description"> |
|
31827 <p>If the View class assigned to the DataTable's <code>view</code> attribute supports |
|
31828 it, this class will be used for rendering the contents of the |
|
31829 <code><thead></code>—the column headers for the table.</p> |
|
31830 |
|
31831 <p>Similar to <code>view</code>, the instance of this View will be assigned to the |
|
31832 DataTable instance's <code>head</code> property.</p> |
|
31833 |
|
31834 <p>It is not strictly necessary that the class function assigned here be |
|
31835 a View subclass. It must however have a <code>render()</code> method.</p> |
|
31836 </div> |
|
31837 |
|
31838 |
|
31839 <p><strong>Default:</strong> Y.DataTable.HeaderView</p> |
|
31840 |
|
31841 |
|
31842 |
|
31843 <div class="emits box"> |
|
31844 <h4>Fires event <code>headerViewChange</code></h4> |
|
31845 |
|
31846 <p> |
|
31847 Fires when the value for the configuration attribute <code>headerView</code> is |
|
31848 changed. You can listen for the event using the <code>on</code> method if you |
|
31849 wish to be notified before the attribute's value has changed, or |
|
31850 using the <code>after</code> method if you wish to be notified after the |
|
31851 attribute's value has changed. |
|
31852 </p> |
|
31853 |
|
31854 <div class="params"> |
|
31855 <h4>Parameters:</h4> |
|
31856 |
|
31857 <ul class="params-list"> |
|
31858 <li class="param"> |
|
31859 <code class="param-name">e</code> |
|
31860 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
31861 |
|
31862 <div class="param-description"> |
|
31863 An Event Facade object with the following |
|
31864 attribute-specific properties added: |
|
31865 </div> |
|
31866 |
|
31867 <ul class="params-list"> |
|
31868 <li class="param"> |
|
31869 <code class="param-name">prevVal</code> |
|
31870 <span class="type">Any</span> |
|
31871 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
31872 </li> |
|
31873 <li class="param"> |
|
31874 <code class="param-name">newVal</code> |
|
31875 <span class="type">Any</span> |
|
31876 <div class="param-description">The value the attribute is to be set to.</div> |
|
31877 </li> |
|
31878 <li class="param"> |
|
31879 <code class="param-name">attrName</code> |
|
31880 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31881 <div class="param-description">The name of the attribute being set.</div> |
|
31882 </li> |
|
31883 <li class="param"> |
|
31884 <code class="param-name">subAttrName</code> |
|
31885 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31886 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
31887 </li> |
|
31888 </ul> |
|
31889 </li> |
|
31890 </ul> |
|
31891 </div> |
|
31892 </div> |
|
31893 |
|
31894 |
|
31895 |
|
31896 </div> |
|
31897 |
|
31898 |
|
31899 <div id="attr_height" class="attr item inherited"> |
|
31900 <a name="config_height"></a> |
|
31901 <h3 class="name"><code>height</code></h3> |
|
31902 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
31903 |
|
31904 |
|
31905 |
|
31906 |
|
31907 |
|
31908 |
|
31909 |
|
31910 |
|
31911 |
|
31912 |
|
31913 |
|
31914 |
|
31915 |
|
31916 |
|
31917 |
|
31918 <div class="meta"> |
|
31919 |
|
31920 |
|
31921 <p>Inherited from |
|
31922 <a href="../classes/Widget.html#attr_height">Widget</a>: |
|
31923 |
|
31924 |
|
31925 |
|
31926 <a href="../files/widget_js_Widget.js.html#l252"><code>widget/js/Widget.js:252</code></a> |
|
31927 |
|
31928 </p> |
|
31929 |
|
31930 |
|
31931 |
|
31932 |
|
31933 </div> |
|
31934 |
|
31935 <div class="description"> |
|
31936 <p>String with units, or number, representing the height of the Widget. If a number is provided, |
|
31937 the default unit, defined by the Widgets DEF_UNIT, property is used.</p> |
|
31938 </div> |
|
31939 |
|
31940 |
|
31941 <p><strong>Default:</strong> EMPTY_STR</p> |
|
31942 |
|
31943 |
|
31944 |
|
31945 <div class="emits box"> |
|
31946 <h4>Fires event <code>heightChange</code></h4> |
|
31947 |
|
31948 <p> |
|
31949 Fires when the value for the configuration attribute <code>height</code> is |
|
31950 changed. You can listen for the event using the <code>on</code> method if you |
|
31951 wish to be notified before the attribute's value has changed, or |
|
31952 using the <code>after</code> method if you wish to be notified after the |
|
31953 attribute's value has changed. |
|
31954 </p> |
|
31955 |
|
31956 <div class="params"> |
|
31957 <h4>Parameters:</h4> |
|
31958 |
|
31959 <ul class="params-list"> |
|
31960 <li class="param"> |
|
31961 <code class="param-name">e</code> |
|
31962 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
31963 |
|
31964 <div class="param-description"> |
|
31965 An Event Facade object with the following |
|
31966 attribute-specific properties added: |
|
31967 </div> |
|
31968 |
|
31969 <ul class="params-list"> |
|
31970 <li class="param"> |
|
31971 <code class="param-name">prevVal</code> |
|
31972 <span class="type">Any</span> |
|
31973 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
31974 </li> |
|
31975 <li class="param"> |
|
31976 <code class="param-name">newVal</code> |
|
31977 <span class="type">Any</span> |
|
31978 <div class="param-description">The value the attribute is to be set to.</div> |
|
31979 </li> |
|
31980 <li class="param"> |
|
31981 <code class="param-name">attrName</code> |
|
31982 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31983 <div class="param-description">The name of the attribute being set.</div> |
|
31984 </li> |
|
31985 <li class="param"> |
|
31986 <code class="param-name">subAttrName</code> |
|
31987 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
31988 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
31989 </li> |
|
31990 </ul> |
|
31991 </li> |
|
31992 </ul> |
|
31993 </div> |
|
31994 </div> |
|
31995 |
|
31996 |
|
31997 |
|
31998 </div> |
|
31999 |
|
32000 |
|
32001 <div id="attr_id" class="attr item inherited"> |
|
32002 <a name="config_id"></a> |
|
32003 <h3 class="name"><code>id</code></h3> |
|
32004 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32005 |
|
32006 |
|
32007 |
|
32008 |
|
32009 |
|
32010 |
|
32011 |
|
32012 |
|
32013 |
|
32014 |
|
32015 |
|
32016 |
|
32017 |
|
32018 |
|
32019 |
|
32020 <div class="meta"> |
|
32021 |
|
32022 |
|
32023 <p>Inherited from |
|
32024 <a href="../classes/Widget.html#attr_id">Widget</a>: |
|
32025 |
|
32026 |
|
32027 |
|
32028 <a href="../files/widget_js_Widget.js.html#l149"><code>widget/js/Widget.js:149</code></a> |
|
32029 |
|
32030 </p> |
|
32031 |
|
32032 |
|
32033 |
|
32034 |
|
32035 </div> |
|
32036 |
|
32037 <div class="description"> |
|
32038 |
|
32039 </div> |
|
32040 |
|
32041 |
|
32042 <p><strong>Default:</strong> Generated using guid()</p> |
|
32043 |
|
32044 |
|
32045 |
|
32046 <div class="emits box"> |
|
32047 <h4>Fires event <code>idChange</code></h4> |
|
32048 |
|
32049 <p> |
|
32050 Fires when the value for the configuration attribute <code>id</code> is |
|
32051 changed. You can listen for the event using the <code>on</code> method if you |
|
32052 wish to be notified before the attribute's value has changed, or |
|
32053 using the <code>after</code> method if you wish to be notified after the |
|
32054 attribute's value has changed. |
|
32055 </p> |
|
32056 |
|
32057 <div class="params"> |
|
32058 <h4>Parameters:</h4> |
|
32059 |
|
32060 <ul class="params-list"> |
|
32061 <li class="param"> |
|
32062 <code class="param-name">e</code> |
|
32063 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
32064 |
|
32065 <div class="param-description"> |
|
32066 An Event Facade object with the following |
|
32067 attribute-specific properties added: |
|
32068 </div> |
|
32069 |
|
32070 <ul class="params-list"> |
|
32071 <li class="param"> |
|
32072 <code class="param-name">prevVal</code> |
|
32073 <span class="type">Any</span> |
|
32074 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
32075 </li> |
|
32076 <li class="param"> |
|
32077 <code class="param-name">newVal</code> |
|
32078 <span class="type">Any</span> |
|
32079 <div class="param-description">The value the attribute is to be set to.</div> |
|
32080 </li> |
|
32081 <li class="param"> |
|
32082 <code class="param-name">attrName</code> |
|
32083 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32084 <div class="param-description">The name of the attribute being set.</div> |
|
32085 </li> |
|
32086 <li class="param"> |
|
32087 <code class="param-name">subAttrName</code> |
|
32088 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32089 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
32090 </li> |
|
32091 </ul> |
|
32092 </li> |
|
32093 </ul> |
|
32094 </div> |
|
32095 </div> |
|
32096 |
|
32097 |
|
32098 |
|
32099 </div> |
|
32100 |
|
32101 |
|
32102 <div id="attr_initialized" class="attr item inherited"> |
|
32103 <a name="config_initialized"></a> |
|
32104 <h3 class="name"><code>initialized</code></h3> |
|
32105 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
32106 |
|
32107 |
|
32108 |
|
32109 |
|
32110 |
|
32111 |
|
32112 |
|
32113 |
|
32114 |
|
32115 |
|
32116 |
|
32117 |
|
32118 |
|
32119 |
|
32120 <span class="flag readonly">readonly</span> |
|
32121 |
|
32122 |
|
32123 <div class="meta"> |
|
32124 |
|
32125 |
|
32126 <p>Inherited from |
|
32127 <a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>: |
|
32128 |
|
32129 |
|
32130 |
|
32131 <a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a> |
|
32132 |
|
32133 </p> |
|
32134 |
|
32135 |
|
32136 |
|
32137 |
|
32138 </div> |
|
32139 |
|
32140 <div class="description"> |
|
32141 <p>Flag indicating whether or not this object |
|
32142 has been through the init lifecycle phase.</p> |
|
32143 </div> |
|
32144 |
|
32145 |
|
32146 <p><strong>Default:</strong> false</p> |
|
32147 |
|
32148 |
|
32149 |
|
32150 <div class="emits box"> |
|
32151 <h4>Fires event <code>initializedChange</code></h4> |
|
32152 |
|
32153 <p> |
|
32154 Fires when the value for the configuration attribute <code>initialized</code> is |
|
32155 changed. You can listen for the event using the <code>on</code> method if you |
|
32156 wish to be notified before the attribute's value has changed, or |
|
32157 using the <code>after</code> method if you wish to be notified after the |
|
32158 attribute's value has changed. |
|
32159 </p> |
|
32160 |
|
32161 <div class="params"> |
|
32162 <h4>Parameters:</h4> |
|
32163 |
|
32164 <ul class="params-list"> |
|
32165 <li class="param"> |
|
32166 <code class="param-name">e</code> |
|
32167 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
32168 |
|
32169 <div class="param-description"> |
|
32170 An Event Facade object with the following |
|
32171 attribute-specific properties added: |
|
32172 </div> |
|
32173 |
|
32174 <ul class="params-list"> |
|
32175 <li class="param"> |
|
32176 <code class="param-name">prevVal</code> |
|
32177 <span class="type">Any</span> |
|
32178 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
32179 </li> |
|
32180 <li class="param"> |
|
32181 <code class="param-name">newVal</code> |
|
32182 <span class="type">Any</span> |
|
32183 <div class="param-description">The value the attribute is to be set to.</div> |
|
32184 </li> |
|
32185 <li class="param"> |
|
32186 <code class="param-name">attrName</code> |
|
32187 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32188 <div class="param-description">The name of the attribute being set.</div> |
|
32189 </li> |
|
32190 <li class="param"> |
|
32191 <code class="param-name">subAttrName</code> |
|
32192 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32193 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
32194 </li> |
|
32195 </ul> |
|
32196 </li> |
|
32197 </ul> |
|
32198 </div> |
|
32199 </div> |
|
32200 |
|
32201 |
|
32202 |
|
32203 </div> |
|
32204 |
|
32205 |
|
32206 <div id="attr_locale" class="attr item deprecated inherited"> |
|
32207 <a name="config_locale"></a> |
|
32208 <h3 class="name"><code>locale</code></h3> |
|
32209 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32210 |
|
32211 |
|
32212 <span class="flag deprecated" title="Use Y.config.lang and Y.Intl externalization support">deprecated</span> |
|
32213 |
|
32214 |
|
32215 |
|
32216 |
|
32217 |
|
32218 |
|
32219 |
|
32220 |
|
32221 |
|
32222 |
|
32223 |
|
32224 |
|
32225 |
|
32226 |
|
32227 <div class="meta"> |
|
32228 |
|
32229 |
|
32230 <p>Inherited from |
|
32231 <a href="../classes/Widget.html#attr_locale">Widget</a>: |
|
32232 |
|
32233 |
|
32234 |
|
32235 <a href="../files/widget_js_WidgetLocale.js.html#l17"><code>widget/js/WidgetLocale.js:17</code></a> |
|
32236 |
|
32237 </p> |
|
32238 |
|
32239 |
|
32240 <p>Deprecated: Use Y.config.lang and Y.Intl externalization support</p> |
|
32241 |
|
32242 |
|
32243 |
|
32244 </div> |
|
32245 |
|
32246 <div class="description"> |
|
32247 <p>The default locale for the widget. NOTE: Using get/set on the "strings" attribute will |
|
32248 return/set strings for this locale.</p> |
|
32249 </div> |
|
32250 |
|
32251 |
|
32252 <p><strong>Default:</strong> "en"</p> |
|
32253 |
|
32254 |
|
32255 |
|
32256 <div class="emits box"> |
|
32257 <h4>Fires event <code>localeChange</code></h4> |
|
32258 |
|
32259 <p> |
|
32260 Fires when the value for the configuration attribute <code>locale</code> is |
|
32261 changed. You can listen for the event using the <code>on</code> method if you |
|
32262 wish to be notified before the attribute's value has changed, or |
|
32263 using the <code>after</code> method if you wish to be notified after the |
|
32264 attribute's value has changed. |
|
32265 </p> |
|
32266 |
|
32267 <div class="params"> |
|
32268 <h4>Parameters:</h4> |
|
32269 |
|
32270 <ul class="params-list"> |
|
32271 <li class="param"> |
|
32272 <code class="param-name">e</code> |
|
32273 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
32274 |
|
32275 <div class="param-description"> |
|
32276 An Event Facade object with the following |
|
32277 attribute-specific properties added: |
|
32278 </div> |
|
32279 |
|
32280 <ul class="params-list"> |
|
32281 <li class="param"> |
|
32282 <code class="param-name">prevVal</code> |
|
32283 <span class="type">Any</span> |
|
32284 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
32285 </li> |
|
32286 <li class="param"> |
|
32287 <code class="param-name">newVal</code> |
|
32288 <span class="type">Any</span> |
|
32289 <div class="param-description">The value the attribute is to be set to.</div> |
|
32290 </li> |
|
32291 <li class="param"> |
|
32292 <code class="param-name">attrName</code> |
|
32293 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32294 <div class="param-description">The name of the attribute being set.</div> |
|
32295 </li> |
|
32296 <li class="param"> |
|
32297 <code class="param-name">subAttrName</code> |
|
32298 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32299 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
32300 </li> |
|
32301 </ul> |
|
32302 </li> |
|
32303 </ul> |
|
32304 </div> |
|
32305 </div> |
|
32306 |
|
32307 |
|
32308 |
|
32309 </div> |
|
32310 |
|
32311 |
|
32312 <div id="attr_recordset" class="attr item deprecated"> |
|
32313 <a name="config_recordset"></a> |
|
32314 <h3 class="name"><code>recordset</code></h3> |
|
32315 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a> | <a href="../classes/Recordset.html" class="crosslink">Recordset</a></span> |
|
32316 |
|
32317 |
|
32318 <span class="flag deprecated" title="Use the `data` attribute">deprecated</span> |
|
32319 |
|
32320 |
|
32321 |
|
32322 |
|
32323 |
|
32324 |
|
32325 |
|
32326 |
|
32327 |
|
32328 |
|
32329 |
|
32330 |
|
32331 |
|
32332 |
|
32333 <div class="meta"> |
|
32334 |
|
32335 |
|
32336 |
|
32337 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
32338 |
|
32339 <p> |
|
32340 |
|
32341 Defined in |
|
32342 |
|
32343 |
|
32344 |
|
32345 |
|
32346 <a href="../files/datatable_js_core.js.html#l164"><code>datatable/js/core.js:164</code></a> |
|
32347 |
|
32348 </p> |
|
32349 |
|
32350 |
|
32351 <p>Deprecated: Use the `data` attribute</p> |
|
32352 |
|
32353 |
|
32354 |
|
32355 <p>Available since 3.5.0</p> |
|
32356 |
|
32357 </div> |
|
32358 |
|
32359 <div class="description"> |
|
32360 <p>Deprecated as of 3.5.0. Passes through to the <code>data</code> attribute.</p> |
|
32361 |
|
32362 <p>WARNING: <code>get('recordset')</code> will NOT return a Recordset instance as of |
|
32363 3.5.0. This is a break in backward compatibility.</p> |
|
32364 </div> |
|
32365 |
|
32366 |
|
32367 |
|
32368 |
|
32369 <div class="emits box"> |
|
32370 <h4>Fires event <code>recordsetChange</code></h4> |
|
32371 |
|
32372 <p> |
|
32373 Fires when the value for the configuration attribute <code>recordset</code> is |
|
32374 changed. You can listen for the event using the <code>on</code> method if you |
|
32375 wish to be notified before the attribute's value has changed, or |
|
32376 using the <code>after</code> method if you wish to be notified after the |
|
32377 attribute's value has changed. |
|
32378 </p> |
|
32379 |
|
32380 <div class="params"> |
|
32381 <h4>Parameters:</h4> |
|
32382 |
|
32383 <ul class="params-list"> |
|
32384 <li class="param"> |
|
32385 <code class="param-name">e</code> |
|
32386 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
32387 |
|
32388 <div class="param-description"> |
|
32389 An Event Facade object with the following |
|
32390 attribute-specific properties added: |
|
32391 </div> |
|
32392 |
|
32393 <ul class="params-list"> |
|
32394 <li class="param"> |
|
32395 <code class="param-name">prevVal</code> |
|
32396 <span class="type">Any</span> |
|
32397 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
32398 </li> |
|
32399 <li class="param"> |
|
32400 <code class="param-name">newVal</code> |
|
32401 <span class="type">Any</span> |
|
32402 <div class="param-description">The value the attribute is to be set to.</div> |
|
32403 </li> |
|
32404 <li class="param"> |
|
32405 <code class="param-name">attrName</code> |
|
32406 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32407 <div class="param-description">The name of the attribute being set.</div> |
|
32408 </li> |
|
32409 <li class="param"> |
|
32410 <code class="param-name">subAttrName</code> |
|
32411 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32412 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
32413 </li> |
|
32414 </ul> |
|
32415 </li> |
|
32416 </ul> |
|
32417 </div> |
|
32418 </div> |
|
32419 |
|
32420 |
|
32421 |
|
32422 </div> |
|
32423 |
|
32424 |
|
32425 <div id="attr_recordType" class="attr item"> |
|
32426 <a name="config_recordType"></a> |
|
32427 <h3 class="name"><code>recordType</code></h3> |
|
32428 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
32429 |
|
32430 |
|
32431 |
|
32432 |
|
32433 |
|
32434 |
|
32435 |
|
32436 |
|
32437 |
|
32438 |
|
32439 |
|
32440 |
|
32441 |
|
32442 |
|
32443 |
|
32444 <div class="meta"> |
|
32445 |
|
32446 |
|
32447 |
|
32448 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
32449 |
|
32450 <p> |
|
32451 |
|
32452 Defined in |
|
32453 |
|
32454 |
|
32455 |
|
32456 |
|
32457 <a href="../files/datatable_js_core.js.html#l87"><code>datatable/js/core.js:87</code></a> |
|
32458 |
|
32459 </p> |
|
32460 |
|
32461 |
|
32462 |
|
32463 |
|
32464 <p>Available since 3.5.0</p> |
|
32465 |
|
32466 </div> |
|
32467 |
|
32468 <div class="description"> |
|
32469 <p>Model subclass to use as the <code>model</code> for the ModelList stored in the <code>data</code> |
|
32470 attribute.</p> |
|
32471 |
|
32472 <p>If not provided, it will try really hard to figure out what to use. The |
|
32473 following attempts will be made to set a default value:</p> |
|
32474 |
|
32475 <ol> |
|
32476 <li>If the <code>data</code> attribute is set with a ModelList instance and its <code>model</code> |
|
32477 property is set, that will be used.</li> |
|
32478 <li>If the <code>data</code> attribute is set with a ModelList instance, and its |
|
32479 <code>model</code> property is unset, but it is populated, the <code>ATTRS</code> of the |
|
32480 `constructor of the first item will be used.</li> |
|
32481 <li>If the <code>data</code> attribute is set with a non-empty array, a Model subclass |
|
32482 will be generated using the keys of the first item as its <code>ATTRS</code> (see |
|
32483 the <code>_createRecordClass</code> method).</li> |
|
32484 <li>If the <code>columns</code> attribute is set, a Model subclass will be generated |
|
32485 using the columns defined with a <code>key</code>. This is least desirable because |
|
32486 columns can be duplicated or nested in a way that's not parsable.</li> |
|
32487 <li>If neither <code>data</code> nor <code>columns</code> is set or populated, a change event |
|
32488 subscriber will listen for the first to be changed and try all over |
|
32489 again.</li> |
|
32490 </ol> |
|
32491 </div> |
|
32492 |
|
32493 |
|
32494 <p><strong>Default:</strong> (see description)</p> |
|
32495 |
|
32496 |
|
32497 |
|
32498 <div class="emits box"> |
|
32499 <h4>Fires event <code>recordTypeChange</code></h4> |
|
32500 |
|
32501 <p> |
|
32502 Fires when the value for the configuration attribute <code>recordType</code> is |
|
32503 changed. You can listen for the event using the <code>on</code> method if you |
|
32504 wish to be notified before the attribute's value has changed, or |
|
32505 using the <code>after</code> method if you wish to be notified after the |
|
32506 attribute's value has changed. |
|
32507 </p> |
|
32508 |
|
32509 <div class="params"> |
|
32510 <h4>Parameters:</h4> |
|
32511 |
|
32512 <ul class="params-list"> |
|
32513 <li class="param"> |
|
32514 <code class="param-name">e</code> |
|
32515 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
32516 |
|
32517 <div class="param-description"> |
|
32518 An Event Facade object with the following |
|
32519 attribute-specific properties added: |
|
32520 </div> |
|
32521 |
|
32522 <ul class="params-list"> |
|
32523 <li class="param"> |
|
32524 <code class="param-name">prevVal</code> |
|
32525 <span class="type">Any</span> |
|
32526 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
32527 </li> |
|
32528 <li class="param"> |
|
32529 <code class="param-name">newVal</code> |
|
32530 <span class="type">Any</span> |
|
32531 <div class="param-description">The value the attribute is to be set to.</div> |
|
32532 </li> |
|
32533 <li class="param"> |
|
32534 <code class="param-name">attrName</code> |
|
32535 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32536 <div class="param-description">The name of the attribute being set.</div> |
|
32537 </li> |
|
32538 <li class="param"> |
|
32539 <code class="param-name">subAttrName</code> |
|
32540 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32541 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
32542 </li> |
|
32543 </ul> |
|
32544 </li> |
|
32545 </ul> |
|
32546 </div> |
|
32547 </div> |
|
32548 |
|
32549 |
|
32550 |
|
32551 </div> |
|
32552 |
|
32553 |
|
32554 <div id="attr_render" class="attr item inherited"> |
|
32555 <a name="config_render"></a> |
|
32556 <h3 class="name"><code>render</code></h3> |
|
32557 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
32558 |
|
32559 |
|
32560 |
|
32561 |
|
32562 |
|
32563 |
|
32564 |
|
32565 |
|
32566 |
|
32567 |
|
32568 |
|
32569 |
|
32570 |
|
32571 |
|
32572 |
|
32573 <div class="meta"> |
|
32574 |
|
32575 |
|
32576 <p>Inherited from |
|
32577 <a href="../classes/Widget.html#attr_render">Widget</a>: |
|
32578 |
|
32579 |
|
32580 |
|
32581 <a href="../files/widget_js_Widget.js.html#l286"><code>widget/js/Widget.js:286</code></a> |
|
32582 |
|
32583 </p> |
|
32584 |
|
32585 |
|
32586 |
|
32587 |
|
32588 </div> |
|
32589 |
|
32590 <div class="description"> |
|
32591 <p>Whether or not to render the widget automatically after init, and optionally, to which parent node.</p> |
|
32592 </div> |
|
32593 |
|
32594 |
|
32595 |
|
32596 |
|
32597 <div class="emits box"> |
|
32598 <h4>Fires event <code>renderChange</code></h4> |
|
32599 |
|
32600 <p> |
|
32601 Fires when the value for the configuration attribute <code>render</code> is |
|
32602 changed. You can listen for the event using the <code>on</code> method if you |
|
32603 wish to be notified before the attribute's value has changed, or |
|
32604 using the <code>after</code> method if you wish to be notified after the |
|
32605 attribute's value has changed. |
|
32606 </p> |
|
32607 |
|
32608 <div class="params"> |
|
32609 <h4>Parameters:</h4> |
|
32610 |
|
32611 <ul class="params-list"> |
|
32612 <li class="param"> |
|
32613 <code class="param-name">e</code> |
|
32614 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
32615 |
|
32616 <div class="param-description"> |
|
32617 An Event Facade object with the following |
|
32618 attribute-specific properties added: |
|
32619 </div> |
|
32620 |
|
32621 <ul class="params-list"> |
|
32622 <li class="param"> |
|
32623 <code class="param-name">prevVal</code> |
|
32624 <span class="type">Any</span> |
|
32625 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
32626 </li> |
|
32627 <li class="param"> |
|
32628 <code class="param-name">newVal</code> |
|
32629 <span class="type">Any</span> |
|
32630 <div class="param-description">The value the attribute is to be set to.</div> |
|
32631 </li> |
|
32632 <li class="param"> |
|
32633 <code class="param-name">attrName</code> |
|
32634 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32635 <div class="param-description">The name of the attribute being set.</div> |
|
32636 </li> |
|
32637 <li class="param"> |
|
32638 <code class="param-name">subAttrName</code> |
|
32639 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32640 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
32641 </li> |
|
32642 </ul> |
|
32643 </li> |
|
32644 </ul> |
|
32645 </div> |
|
32646 </div> |
|
32647 |
|
32648 |
|
32649 |
|
32650 </div> |
|
32651 |
|
32652 |
|
32653 <div id="attr_rendered" class="attr item inherited"> |
|
32654 <a name="config_rendered"></a> |
|
32655 <h3 class="name"><code>rendered</code></h3> |
|
32656 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
32657 |
|
32658 |
|
32659 |
|
32660 |
|
32661 |
|
32662 |
|
32663 |
|
32664 |
|
32665 |
|
32666 |
|
32667 |
|
32668 |
|
32669 |
|
32670 |
|
32671 <span class="flag readonly">readonly</span> |
|
32672 |
|
32673 |
|
32674 <div class="meta"> |
|
32675 |
|
32676 |
|
32677 <p>Inherited from |
|
32678 <a href="../classes/Widget.html#attr_rendered">Widget</a>: |
|
32679 |
|
32680 |
|
32681 |
|
32682 <a href="../files/widget_js_Widget.js.html#l161"><code>widget/js/Widget.js:161</code></a> |
|
32683 |
|
32684 </p> |
|
32685 |
|
32686 |
|
32687 |
|
32688 |
|
32689 </div> |
|
32690 |
|
32691 <div class="description"> |
|
32692 <p>Flag indicating whether or not this Widget |
|
32693 has been through the render lifecycle phase.</p> |
|
32694 </div> |
|
32695 |
|
32696 |
|
32697 <p><strong>Default:</strong> false</p> |
|
32698 |
|
32699 |
|
32700 |
|
32701 <div class="emits box"> |
|
32702 <h4>Fires event <code>renderedChange</code></h4> |
|
32703 |
|
32704 <p> |
|
32705 Fires when the value for the configuration attribute <code>rendered</code> is |
|
32706 changed. You can listen for the event using the <code>on</code> method if you |
|
32707 wish to be notified before the attribute's value has changed, or |
|
32708 using the <code>after</code> method if you wish to be notified after the |
|
32709 attribute's value has changed. |
|
32710 </p> |
|
32711 |
|
32712 <div class="params"> |
|
32713 <h4>Parameters:</h4> |
|
32714 |
|
32715 <ul class="params-list"> |
|
32716 <li class="param"> |
|
32717 <code class="param-name">e</code> |
|
32718 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
32719 |
|
32720 <div class="param-description"> |
|
32721 An Event Facade object with the following |
|
32722 attribute-specific properties added: |
|
32723 </div> |
|
32724 |
|
32725 <ul class="params-list"> |
|
32726 <li class="param"> |
|
32727 <code class="param-name">prevVal</code> |
|
32728 <span class="type">Any</span> |
|
32729 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
32730 </li> |
|
32731 <li class="param"> |
|
32732 <code class="param-name">newVal</code> |
|
32733 <span class="type">Any</span> |
|
32734 <div class="param-description">The value the attribute is to be set to.</div> |
|
32735 </li> |
|
32736 <li class="param"> |
|
32737 <code class="param-name">attrName</code> |
|
32738 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32739 <div class="param-description">The name of the attribute being set.</div> |
|
32740 </li> |
|
32741 <li class="param"> |
|
32742 <code class="param-name">subAttrName</code> |
|
32743 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32744 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
32745 </li> |
|
32746 </ul> |
|
32747 </li> |
|
32748 </ul> |
|
32749 </div> |
|
32750 </div> |
|
32751 |
|
32752 |
|
32753 |
|
32754 </div> |
|
32755 |
|
32756 |
|
32757 <div id="attr_scrollable" class="attr item"> |
|
32758 <a name="config_scrollable"></a> |
|
32759 <h3 class="name"><code>scrollable</code></h3> |
|
32760 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
32761 |
|
32762 |
|
32763 |
|
32764 |
|
32765 |
|
32766 |
|
32767 |
|
32768 |
|
32769 |
|
32770 |
|
32771 |
|
32772 |
|
32773 |
|
32774 |
|
32775 |
|
32776 <div class="meta"> |
|
32777 |
|
32778 |
|
32779 |
|
32780 <p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p> |
|
32781 |
|
32782 <p> |
|
32783 |
|
32784 Defined in |
|
32785 |
|
32786 |
|
32787 |
|
32788 |
|
32789 <a href="../files/datatable_js_scroll.js.html#l55"><code>datatable/js/scroll.js:55</code></a> |
|
32790 |
|
32791 </p> |
|
32792 |
|
32793 |
|
32794 |
|
32795 |
|
32796 <p>Available since 3.5.0</p> |
|
32797 |
|
32798 </div> |
|
32799 |
|
32800 <div class="description"> |
|
32801 <p>Activates or deactivates scrolling in the table. Acceptable values are:</p> |
|
32802 |
|
32803 <ul> |
|
32804 <li><code>false</code> - (default) Scrolling is disabled.</li> |
|
32805 <li><code>true</code> or 'xy' - If <code>height</code> is set, vertical scrolling will be |
|
32806 activated, if <code>width</code> is set, horizontal scrolling will be activated.</li> |
|
32807 <li>'x' - Activate horizontal scrolling only. Requires the <code>width</code> attribute |
|
32808 is also set.</li> |
|
32809 <li>'y' - Activate vertical scrolling only. Requires the <code>height</code> attribute |
|
32810 is also set.</li> |
|
32811 </ul> |
|
32812 </div> |
|
32813 |
|
32814 |
|
32815 |
|
32816 |
|
32817 <div class="emits box"> |
|
32818 <h4>Fires event <code>scrollableChange</code></h4> |
|
32819 |
|
32820 <p> |
|
32821 Fires when the value for the configuration attribute <code>scrollable</code> is |
|
32822 changed. You can listen for the event using the <code>on</code> method if you |
|
32823 wish to be notified before the attribute's value has changed, or |
|
32824 using the <code>after</code> method if you wish to be notified after the |
|
32825 attribute's value has changed. |
|
32826 </p> |
|
32827 |
|
32828 <div class="params"> |
|
32829 <h4>Parameters:</h4> |
|
32830 |
|
32831 <ul class="params-list"> |
|
32832 <li class="param"> |
|
32833 <code class="param-name">e</code> |
|
32834 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
32835 |
|
32836 <div class="param-description"> |
|
32837 An Event Facade object with the following |
|
32838 attribute-specific properties added: |
|
32839 </div> |
|
32840 |
|
32841 <ul class="params-list"> |
|
32842 <li class="param"> |
|
32843 <code class="param-name">prevVal</code> |
|
32844 <span class="type">Any</span> |
|
32845 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
32846 </li> |
|
32847 <li class="param"> |
|
32848 <code class="param-name">newVal</code> |
|
32849 <span class="type">Any</span> |
|
32850 <div class="param-description">The value the attribute is to be set to.</div> |
|
32851 </li> |
|
32852 <li class="param"> |
|
32853 <code class="param-name">attrName</code> |
|
32854 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32855 <div class="param-description">The name of the attribute being set.</div> |
|
32856 </li> |
|
32857 <li class="param"> |
|
32858 <code class="param-name">subAttrName</code> |
|
32859 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32860 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
32861 </li> |
|
32862 </ul> |
|
32863 </li> |
|
32864 </ul> |
|
32865 </div> |
|
32866 </div> |
|
32867 |
|
32868 |
|
32869 |
|
32870 </div> |
|
32871 |
|
32872 |
|
32873 <div id="attr_showMessages" class="attr item"> |
|
32874 <a name="config_showMessages"></a> |
|
32875 <h3 class="name"><code>showMessages</code></h3> |
|
32876 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
32877 |
|
32878 |
|
32879 |
|
32880 |
|
32881 |
|
32882 |
|
32883 |
|
32884 |
|
32885 |
|
32886 |
|
32887 |
|
32888 |
|
32889 |
|
32890 |
|
32891 |
|
32892 <div class="meta"> |
|
32893 |
|
32894 |
|
32895 |
|
32896 <p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p> |
|
32897 |
|
32898 <p> |
|
32899 |
|
32900 Defined in |
|
32901 |
|
32902 |
|
32903 |
|
32904 |
|
32905 <a href="../files/datatable_js_message.js.html#l29"><code>datatable/js/message.js:29</code></a> |
|
32906 |
|
32907 </p> |
|
32908 |
|
32909 |
|
32910 |
|
32911 |
|
32912 <p>Available since 3.5.0</p> |
|
32913 |
|
32914 </div> |
|
32915 |
|
32916 <div class="description"> |
|
32917 <p>Enables the display of messages in the table. Setting this to false will |
|
32918 prevent the message Node from being created and <code>showMessage</code> from doing |
|
32919 anything.</p> |
|
32920 </div> |
|
32921 |
|
32922 |
|
32923 <p><strong>Default:</strong> true</p> |
|
32924 |
|
32925 |
|
32926 |
|
32927 <div class="emits box"> |
|
32928 <h4>Fires event <code>showMessagesChange</code></h4> |
|
32929 |
|
32930 <p> |
|
32931 Fires when the value for the configuration attribute <code>showMessages</code> is |
|
32932 changed. You can listen for the event using the <code>on</code> method if you |
|
32933 wish to be notified before the attribute's value has changed, or |
|
32934 using the <code>after</code> method if you wish to be notified after the |
|
32935 attribute's value has changed. |
|
32936 </p> |
|
32937 |
|
32938 <div class="params"> |
|
32939 <h4>Parameters:</h4> |
|
32940 |
|
32941 <ul class="params-list"> |
|
32942 <li class="param"> |
|
32943 <code class="param-name">e</code> |
|
32944 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
32945 |
|
32946 <div class="param-description"> |
|
32947 An Event Facade object with the following |
|
32948 attribute-specific properties added: |
|
32949 </div> |
|
32950 |
|
32951 <ul class="params-list"> |
|
32952 <li class="param"> |
|
32953 <code class="param-name">prevVal</code> |
|
32954 <span class="type">Any</span> |
|
32955 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
32956 </li> |
|
32957 <li class="param"> |
|
32958 <code class="param-name">newVal</code> |
|
32959 <span class="type">Any</span> |
|
32960 <div class="param-description">The value the attribute is to be set to.</div> |
|
32961 </li> |
|
32962 <li class="param"> |
|
32963 <code class="param-name">attrName</code> |
|
32964 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32965 <div class="param-description">The name of the attribute being set.</div> |
|
32966 </li> |
|
32967 <li class="param"> |
|
32968 <code class="param-name">subAttrName</code> |
|
32969 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
32970 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
32971 </li> |
|
32972 </ul> |
|
32973 </li> |
|
32974 </ul> |
|
32975 </div> |
|
32976 </div> |
|
32977 |
|
32978 |
|
32979 |
|
32980 </div> |
|
32981 |
|
32982 |
|
32983 <div id="attr_sortable" class="attr item"> |
|
32984 <a name="config_sortable"></a> |
|
32985 <h3 class="name"><code>sortable</code></h3> |
|
32986 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
32987 |
|
32988 |
|
32989 |
|
32990 |
|
32991 |
|
32992 |
|
32993 |
|
32994 |
|
32995 |
|
32996 |
|
32997 |
|
32998 |
|
32999 |
|
33000 |
|
33001 |
|
33002 <div class="meta"> |
|
33003 |
|
33004 |
|
33005 |
|
33006 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
33007 |
|
33008 <p> |
|
33009 |
|
33010 Defined in |
|
33011 |
|
33012 |
|
33013 |
|
33014 |
|
33015 <a href="../files/datatable_js_sort.js.html#l112"><code>datatable/js/sort.js:112</code></a> |
|
33016 |
|
33017 </p> |
|
33018 |
|
33019 |
|
33020 |
|
33021 |
|
33022 <p>Available since 3.5.0</p> |
|
33023 |
|
33024 </div> |
|
33025 |
|
33026 <div class="description"> |
|
33027 <p>Controls which column headers can trigger sorting by user clicks.</p> |
|
33028 |
|
33029 <p>Acceptable values are:</p> |
|
33030 |
|
33031 <ul> |
|
33032 <li>"auto" - (default) looks for <code>sortable: true</code> in the column configurations</li> |
|
33033 <li><code>true</code> - all columns are enabled</li> |
|
33034 <li>`false - no UI sortable is enabled</li> |
|
33035 <li>{String[]} - array of key names to give sortable headers</li> |
|
33036 </ul> |
|
33037 </div> |
|
33038 |
|
33039 |
|
33040 <p><strong>Default:</strong> "auto"</p> |
|
33041 |
|
33042 |
|
33043 |
|
33044 <div class="emits box"> |
|
33045 <h4>Fires event <code>sortableChange</code></h4> |
|
33046 |
|
33047 <p> |
|
33048 Fires when the value for the configuration attribute <code>sortable</code> is |
|
33049 changed. You can listen for the event using the <code>on</code> method if you |
|
33050 wish to be notified before the attribute's value has changed, or |
|
33051 using the <code>after</code> method if you wish to be notified after the |
|
33052 attribute's value has changed. |
|
33053 </p> |
|
33054 |
|
33055 <div class="params"> |
|
33056 <h4>Parameters:</h4> |
|
33057 |
|
33058 <ul class="params-list"> |
|
33059 <li class="param"> |
|
33060 <code class="param-name">e</code> |
|
33061 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
33062 |
|
33063 <div class="param-description"> |
|
33064 An Event Facade object with the following |
|
33065 attribute-specific properties added: |
|
33066 </div> |
|
33067 |
|
33068 <ul class="params-list"> |
|
33069 <li class="param"> |
|
33070 <code class="param-name">prevVal</code> |
|
33071 <span class="type">Any</span> |
|
33072 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
33073 </li> |
|
33074 <li class="param"> |
|
33075 <code class="param-name">newVal</code> |
|
33076 <span class="type">Any</span> |
|
33077 <div class="param-description">The value the attribute is to be set to.</div> |
|
33078 </li> |
|
33079 <li class="param"> |
|
33080 <code class="param-name">attrName</code> |
|
33081 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33082 <div class="param-description">The name of the attribute being set.</div> |
|
33083 </li> |
|
33084 <li class="param"> |
|
33085 <code class="param-name">subAttrName</code> |
|
33086 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33087 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
33088 </li> |
|
33089 </ul> |
|
33090 </li> |
|
33091 </ul> |
|
33092 </div> |
|
33093 </div> |
|
33094 |
|
33095 |
|
33096 |
|
33097 </div> |
|
33098 |
|
33099 |
|
33100 <div id="attr_sortBy" class="attr item"> |
|
33101 <a name="config_sortBy"></a> |
|
33102 <h3 class="name"><code>sortBy</code></h3> |
|
33103 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
33104 |
|
33105 |
|
33106 |
|
33107 |
|
33108 |
|
33109 |
|
33110 |
|
33111 |
|
33112 |
|
33113 |
|
33114 |
|
33115 |
|
33116 |
|
33117 |
|
33118 |
|
33119 <div class="meta"> |
|
33120 |
|
33121 |
|
33122 |
|
33123 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
33124 |
|
33125 <p> |
|
33126 |
|
33127 Defined in |
|
33128 |
|
33129 |
|
33130 |
|
33131 |
|
33132 <a href="../files/datatable_js_sort.js.html#l132"><code>datatable/js/sort.js:132</code></a> |
|
33133 |
|
33134 </p> |
|
33135 |
|
33136 |
|
33137 |
|
33138 |
|
33139 <p>Available since 3.5.0</p> |
|
33140 |
|
33141 </div> |
|
33142 |
|
33143 <div class="description"> |
|
33144 <p>The current sort configuration to maintain in the data.</p> |
|
33145 |
|
33146 <p>Accepts column <code>key</code> strings or objects with a single property, the column |
|
33147 <code>key</code>, with a value of 1, -1, "asc", or "desc". E.g. <code>{ username: 'asc' |
|
33148 }</code>. String values are assumed to be ascending.</p> |
|
33149 |
|
33150 <p>Example values would be:</p> |
|
33151 |
|
33152 <ul> |
|
33153 <li><code>"username"</code> - sort by the data's <code>username</code> field or the <code>key</code> |
|
33154 associated to a column with that <code>name</code>.</li> |
|
33155 <li><code>{ username: "desc" }</code> - sort by <code>username</code> in descending order. |
|
33156 Alternately, use values "asc", 1 (same as "asc"), or -1 (same as "desc").</li> |
|
33157 <li><code>["lastName", "firstName"]</code> - ascending sort by <code>lastName</code>, but for |
|
33158 records with the same <code>lastName</code>, ascending subsort by <code>firstName</code>. |
|
33159 Array can have as many items as you want.</li> |
|
33160 <li><code>[{ lastName: -1 }, "firstName"]</code> - descending sort by <code>lastName</code>, |
|
33161 ascending subsort by <code>firstName</code>. Mixed types are ok.</li> |
|
33162 </ul> |
|
33163 </div> |
|
33164 |
|
33165 |
|
33166 |
|
33167 |
|
33168 <div class="emits box"> |
|
33169 <h4>Fires event <code>sortByChange</code></h4> |
|
33170 |
|
33171 <p> |
|
33172 Fires when the value for the configuration attribute <code>sortBy</code> is |
|
33173 changed. You can listen for the event using the <code>on</code> method if you |
|
33174 wish to be notified before the attribute's value has changed, or |
|
33175 using the <code>after</code> method if you wish to be notified after the |
|
33176 attribute's value has changed. |
|
33177 </p> |
|
33178 |
|
33179 <div class="params"> |
|
33180 <h4>Parameters:</h4> |
|
33181 |
|
33182 <ul class="params-list"> |
|
33183 <li class="param"> |
|
33184 <code class="param-name">e</code> |
|
33185 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
33186 |
|
33187 <div class="param-description"> |
|
33188 An Event Facade object with the following |
|
33189 attribute-specific properties added: |
|
33190 </div> |
|
33191 |
|
33192 <ul class="params-list"> |
|
33193 <li class="param"> |
|
33194 <code class="param-name">prevVal</code> |
|
33195 <span class="type">Any</span> |
|
33196 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
33197 </li> |
|
33198 <li class="param"> |
|
33199 <code class="param-name">newVal</code> |
|
33200 <span class="type">Any</span> |
|
33201 <div class="param-description">The value the attribute is to be set to.</div> |
|
33202 </li> |
|
33203 <li class="param"> |
|
33204 <code class="param-name">attrName</code> |
|
33205 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33206 <div class="param-description">The name of the attribute being set.</div> |
|
33207 </li> |
|
33208 <li class="param"> |
|
33209 <code class="param-name">subAttrName</code> |
|
33210 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33211 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
33212 </li> |
|
33213 </ul> |
|
33214 </li> |
|
33215 </ul> |
|
33216 </div> |
|
33217 </div> |
|
33218 |
|
33219 |
|
33220 |
|
33221 </div> |
|
33222 |
|
33223 |
|
33224 <div id="attr_srcNode" class="attr item inherited"> |
|
33225 <a name="config_srcNode"></a> |
|
33226 <h3 class="name"><code>srcNode</code></h3> |
|
33227 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
33228 |
|
33229 |
|
33230 |
|
33231 |
|
33232 |
|
33233 |
|
33234 |
|
33235 |
|
33236 |
|
33237 |
|
33238 |
|
33239 |
|
33240 |
|
33241 |
|
33242 |
|
33243 <div class="meta"> |
|
33244 |
|
33245 |
|
33246 <p>Inherited from |
|
33247 <a href="../classes/Widget.html#attr_srcNode">Widget</a>: |
|
33248 |
|
33249 |
|
33250 |
|
33251 <a href="../files/widget_js_WidgetHTMLParser.js.html#l58"><code>widget/js/WidgetHTMLParser.js:58</code></a> |
|
33252 |
|
33253 </p> |
|
33254 |
|
33255 |
|
33256 |
|
33257 |
|
33258 </div> |
|
33259 |
|
33260 <div class="description"> |
|
33261 <p>The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition</p> |
|
33262 </div> |
|
33263 |
|
33264 |
|
33265 |
|
33266 |
|
33267 <div class="emits box"> |
|
33268 <h4>Fires event <code>srcNodeChange</code></h4> |
|
33269 |
|
33270 <p> |
|
33271 Fires when the value for the configuration attribute <code>srcNode</code> is |
|
33272 changed. You can listen for the event using the <code>on</code> method if you |
|
33273 wish to be notified before the attribute's value has changed, or |
|
33274 using the <code>after</code> method if you wish to be notified after the |
|
33275 attribute's value has changed. |
|
33276 </p> |
|
33277 |
|
33278 <div class="params"> |
|
33279 <h4>Parameters:</h4> |
|
33280 |
|
33281 <ul class="params-list"> |
|
33282 <li class="param"> |
|
33283 <code class="param-name">e</code> |
|
33284 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
33285 |
|
33286 <div class="param-description"> |
|
33287 An Event Facade object with the following |
|
33288 attribute-specific properties added: |
|
33289 </div> |
|
33290 |
|
33291 <ul class="params-list"> |
|
33292 <li class="param"> |
|
33293 <code class="param-name">prevVal</code> |
|
33294 <span class="type">Any</span> |
|
33295 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
33296 </li> |
|
33297 <li class="param"> |
|
33298 <code class="param-name">newVal</code> |
|
33299 <span class="type">Any</span> |
|
33300 <div class="param-description">The value the attribute is to be set to.</div> |
|
33301 </li> |
|
33302 <li class="param"> |
|
33303 <code class="param-name">attrName</code> |
|
33304 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33305 <div class="param-description">The name of the attribute being set.</div> |
|
33306 </li> |
|
33307 <li class="param"> |
|
33308 <code class="param-name">subAttrName</code> |
|
33309 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33310 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
33311 </li> |
|
33312 </ul> |
|
33313 </li> |
|
33314 </ul> |
|
33315 </div> |
|
33316 </div> |
|
33317 |
|
33318 |
|
33319 |
|
33320 </div> |
|
33321 |
|
33322 |
|
33323 <div id="attr_strings" class="attr item"> |
|
33324 <a name="config_strings"></a> |
|
33325 <h3 class="name"><code>strings</code></h3> |
|
33326 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
33327 |
|
33328 |
|
33329 |
|
33330 |
|
33331 |
|
33332 |
|
33333 |
|
33334 |
|
33335 |
|
33336 |
|
33337 |
|
33338 |
|
33339 |
|
33340 |
|
33341 |
|
33342 <div class="meta"> |
|
33343 |
|
33344 <p>Inherited from |
|
33345 <a href="../classes/Widget.html#attr_strings"> |
|
33346 Widget |
|
33347 </a> |
|
33348 |
|
33349 but overwritten in |
|
33350 |
|
33351 |
|
33352 |
|
33353 <a href="../files/datatable_js_sort.js.html#l160"><code>datatable/js/sort.js:160</code></a> |
|
33354 |
|
33355 </p> |
|
33356 |
|
33357 |
|
33358 |
|
33359 |
|
33360 <p>Available since 3.5.0</p> |
|
33361 |
|
33362 </div> |
|
33363 |
|
33364 <div class="description"> |
|
33365 <p>Strings containing language for sorting tooltips.</p> |
|
33366 </div> |
|
33367 |
|
33368 |
|
33369 <p><strong>Default:</strong> (strings for current lang configured in the YUI instance config)</p> |
|
33370 |
|
33371 |
|
33372 |
|
33373 <div class="emits box"> |
|
33374 <h4>Fires event <code>stringsChange</code></h4> |
|
33375 |
|
33376 <p> |
|
33377 Fires when the value for the configuration attribute <code>strings</code> is |
|
33378 changed. You can listen for the event using the <code>on</code> method if you |
|
33379 wish to be notified before the attribute's value has changed, or |
|
33380 using the <code>after</code> method if you wish to be notified after the |
|
33381 attribute's value has changed. |
|
33382 </p> |
|
33383 |
|
33384 <div class="params"> |
|
33385 <h4>Parameters:</h4> |
|
33386 |
|
33387 <ul class="params-list"> |
|
33388 <li class="param"> |
|
33389 <code class="param-name">e</code> |
|
33390 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
33391 |
|
33392 <div class="param-description"> |
|
33393 An Event Facade object with the following |
|
33394 attribute-specific properties added: |
|
33395 </div> |
|
33396 |
|
33397 <ul class="params-list"> |
|
33398 <li class="param"> |
|
33399 <code class="param-name">prevVal</code> |
|
33400 <span class="type">Any</span> |
|
33401 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
33402 </li> |
|
33403 <li class="param"> |
|
33404 <code class="param-name">newVal</code> |
|
33405 <span class="type">Any</span> |
|
33406 <div class="param-description">The value the attribute is to be set to.</div> |
|
33407 </li> |
|
33408 <li class="param"> |
|
33409 <code class="param-name">attrName</code> |
|
33410 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33411 <div class="param-description">The name of the attribute being set.</div> |
|
33412 </li> |
|
33413 <li class="param"> |
|
33414 <code class="param-name">subAttrName</code> |
|
33415 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33416 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
33417 </li> |
|
33418 </ul> |
|
33419 </li> |
|
33420 </ul> |
|
33421 </div> |
|
33422 </div> |
|
33423 |
|
33424 |
|
33425 |
|
33426 </div> |
|
33427 |
|
33428 |
|
33429 <div id="attr_summary" class="attr item"> |
|
33430 <a name="config_summary"></a> |
|
33431 <h3 class="name"><code>summary</code></h3> |
|
33432 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33433 |
|
33434 |
|
33435 |
|
33436 |
|
33437 |
|
33438 |
|
33439 |
|
33440 |
|
33441 |
|
33442 |
|
33443 |
|
33444 |
|
33445 |
|
33446 |
|
33447 |
|
33448 <div class="meta"> |
|
33449 |
|
33450 |
|
33451 |
|
33452 <p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p> |
|
33453 |
|
33454 <p> |
|
33455 |
|
33456 Defined in |
|
33457 |
|
33458 |
|
33459 |
|
33460 |
|
33461 <a href="../files/datatable_js_core.js.html#l142"><code>datatable/js/core.js:142</code></a> |
|
33462 |
|
33463 </p> |
|
33464 |
|
33465 |
|
33466 |
|
33467 |
|
33468 <p>Available since 3.5.0</p> |
|
33469 |
|
33470 </div> |
|
33471 |
|
33472 <div class="description"> |
|
33473 <p>Content for the <code><table summary="ATTRIBUTE VALUE HERE"></code>. Values assigned |
|
33474 to this attribute will be HTML escaped for security.</p> |
|
33475 </div> |
|
33476 |
|
33477 |
|
33478 <p><strong>Default:</strong> '' (empty string)</p> |
|
33479 |
|
33480 |
|
33481 |
|
33482 <div class="emits box"> |
|
33483 <h4>Fires event <code>summaryChange</code></h4> |
|
33484 |
|
33485 <p> |
|
33486 Fires when the value for the configuration attribute <code>summary</code> is |
|
33487 changed. You can listen for the event using the <code>on</code> method if you |
|
33488 wish to be notified before the attribute's value has changed, or |
|
33489 using the <code>after</code> method if you wish to be notified after the |
|
33490 attribute's value has changed. |
|
33491 </p> |
|
33492 |
|
33493 <div class="params"> |
|
33494 <h4>Parameters:</h4> |
|
33495 |
|
33496 <ul class="params-list"> |
|
33497 <li class="param"> |
|
33498 <code class="param-name">e</code> |
|
33499 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
33500 |
|
33501 <div class="param-description"> |
|
33502 An Event Facade object with the following |
|
33503 attribute-specific properties added: |
|
33504 </div> |
|
33505 |
|
33506 <ul class="params-list"> |
|
33507 <li class="param"> |
|
33508 <code class="param-name">prevVal</code> |
|
33509 <span class="type">Any</span> |
|
33510 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
33511 </li> |
|
33512 <li class="param"> |
|
33513 <code class="param-name">newVal</code> |
|
33514 <span class="type">Any</span> |
|
33515 <div class="param-description">The value the attribute is to be set to.</div> |
|
33516 </li> |
|
33517 <li class="param"> |
|
33518 <code class="param-name">attrName</code> |
|
33519 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33520 <div class="param-description">The name of the attribute being set.</div> |
|
33521 </li> |
|
33522 <li class="param"> |
|
33523 <code class="param-name">subAttrName</code> |
|
33524 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33525 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
33526 </li> |
|
33527 </ul> |
|
33528 </li> |
|
33529 </ul> |
|
33530 </div> |
|
33531 </div> |
|
33532 |
|
33533 |
|
33534 |
|
33535 </div> |
|
33536 |
|
33537 |
|
33538 <div id="attr_tabIndex" class="attr item inherited"> |
|
33539 <a name="config_tabIndex"></a> |
|
33540 <h3 class="name"><code>tabIndex</code></h3> |
|
33541 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
33542 |
|
33543 |
|
33544 |
|
33545 |
|
33546 |
|
33547 |
|
33548 |
|
33549 |
|
33550 |
|
33551 |
|
33552 |
|
33553 |
|
33554 |
|
33555 |
|
33556 |
|
33557 <div class="meta"> |
|
33558 |
|
33559 |
|
33560 <p>Inherited from |
|
33561 <a href="../classes/Widget.html#attr_tabIndex">Widget</a>: |
|
33562 |
|
33563 |
|
33564 |
|
33565 <a href="../files/widget_js_Widget.js.html#l202"><code>widget/js/Widget.js:202</code></a> |
|
33566 |
|
33567 </p> |
|
33568 |
|
33569 |
|
33570 |
|
33571 |
|
33572 </div> |
|
33573 |
|
33574 <div class="description"> |
|
33575 <p>Number (between -32767 to 32767) indicating the widget's |
|
33576 position in the default tab flow. The value is used to set the |
|
33577 "tabIndex" attribute on the widget's bounding box. Negative values allow |
|
33578 the widget to receive DOM focus programmatically (by calling the focus |
|
33579 method), while being removed from the default tab flow. A value of |
|
33580 null removes the "tabIndex" attribute from the widget's bounding box.</p> |
|
33581 </div> |
|
33582 |
|
33583 |
|
33584 <p><strong>Default:</strong> null</p> |
|
33585 |
|
33586 |
|
33587 |
|
33588 <div class="emits box"> |
|
33589 <h4>Fires event <code>tabIndexChange</code></h4> |
|
33590 |
|
33591 <p> |
|
33592 Fires when the value for the configuration attribute <code>tabIndex</code> is |
|
33593 changed. You can listen for the event using the <code>on</code> method if you |
|
33594 wish to be notified before the attribute's value has changed, or |
|
33595 using the <code>after</code> method if you wish to be notified after the |
|
33596 attribute's value has changed. |
|
33597 </p> |
|
33598 |
|
33599 <div class="params"> |
|
33600 <h4>Parameters:</h4> |
|
33601 |
|
33602 <ul class="params-list"> |
|
33603 <li class="param"> |
|
33604 <code class="param-name">e</code> |
|
33605 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
33606 |
|
33607 <div class="param-description"> |
|
33608 An Event Facade object with the following |
|
33609 attribute-specific properties added: |
|
33610 </div> |
|
33611 |
|
33612 <ul class="params-list"> |
|
33613 <li class="param"> |
|
33614 <code class="param-name">prevVal</code> |
|
33615 <span class="type">Any</span> |
|
33616 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
33617 </li> |
|
33618 <li class="param"> |
|
33619 <code class="param-name">newVal</code> |
|
33620 <span class="type">Any</span> |
|
33621 <div class="param-description">The value the attribute is to be set to.</div> |
|
33622 </li> |
|
33623 <li class="param"> |
|
33624 <code class="param-name">attrName</code> |
|
33625 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33626 <div class="param-description">The name of the attribute being set.</div> |
|
33627 </li> |
|
33628 <li class="param"> |
|
33629 <code class="param-name">subAttrName</code> |
|
33630 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33631 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
33632 </li> |
|
33633 </ul> |
|
33634 </li> |
|
33635 </ul> |
|
33636 </div> |
|
33637 </div> |
|
33638 |
|
33639 |
|
33640 |
|
33641 </div> |
|
33642 |
|
33643 |
|
33644 <div id="attr_view" class="attr item inherited"> |
|
33645 <a name="config_view"></a> |
|
33646 <h3 class="name"><code>view</code></h3> |
|
33647 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
33648 |
|
33649 |
|
33650 |
|
33651 |
|
33652 |
|
33653 |
|
33654 |
|
33655 |
|
33656 |
|
33657 |
|
33658 |
|
33659 |
|
33660 |
|
33661 |
|
33662 |
|
33663 <div class="meta"> |
|
33664 |
|
33665 |
|
33666 <p>Inherited from |
|
33667 <a href="../classes/DataTable.Base.html#attr_view">DataTable.Base</a>: |
|
33668 |
|
33669 |
|
33670 |
|
33671 <a href="../files/datatable_js_base.js.html#l538"><code>datatable/js/base.js:538</code></a> |
|
33672 |
|
33673 </p> |
|
33674 |
|
33675 |
|
33676 |
|
33677 |
|
33678 <p>Available since 3.6.0</p> |
|
33679 |
|
33680 </div> |
|
33681 |
|
33682 <div class="description"> |
|
33683 <p>The View class used to render the <code><table></code> into the Widget's |
|
33684 <code>contentBox</code>. This View can handle the entire table rendering itself |
|
33685 or delegate to other Views.</p> |
|
33686 |
|
33687 <p>It is not strictly necessary that the class function assigned here be |
|
33688 a View subclass. It must however have a <code>render()</code> method.</p> |
|
33689 |
|
33690 <p>When the DataTable is rendered, an instance of this View will be |
|
33691 created and its <code>render()</code> method called. The View instance will be |
|
33692 assigned to the DataTable instance's <code>view</code> property.</p> |
|
33693 </div> |
|
33694 |
|
33695 |
|
33696 <p><strong>Default:</strong> Y.DataTable.TableView</p> |
|
33697 |
|
33698 |
|
33699 |
|
33700 <div class="emits box"> |
|
33701 <h4>Fires event <code>viewChange</code></h4> |
|
33702 |
|
33703 <p> |
|
33704 Fires when the value for the configuration attribute <code>view</code> is |
|
33705 changed. You can listen for the event using the <code>on</code> method if you |
|
33706 wish to be notified before the attribute's value has changed, or |
|
33707 using the <code>after</code> method if you wish to be notified after the |
|
33708 attribute's value has changed. |
|
33709 </p> |
|
33710 |
|
33711 <div class="params"> |
|
33712 <h4>Parameters:</h4> |
|
33713 |
|
33714 <ul class="params-list"> |
|
33715 <li class="param"> |
|
33716 <code class="param-name">e</code> |
|
33717 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
33718 |
|
33719 <div class="param-description"> |
|
33720 An Event Facade object with the following |
|
33721 attribute-specific properties added: |
|
33722 </div> |
|
33723 |
|
33724 <ul class="params-list"> |
|
33725 <li class="param"> |
|
33726 <code class="param-name">prevVal</code> |
|
33727 <span class="type">Any</span> |
|
33728 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
33729 </li> |
|
33730 <li class="param"> |
|
33731 <code class="param-name">newVal</code> |
|
33732 <span class="type">Any</span> |
|
33733 <div class="param-description">The value the attribute is to be set to.</div> |
|
33734 </li> |
|
33735 <li class="param"> |
|
33736 <code class="param-name">attrName</code> |
|
33737 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33738 <div class="param-description">The name of the attribute being set.</div> |
|
33739 </li> |
|
33740 <li class="param"> |
|
33741 <code class="param-name">subAttrName</code> |
|
33742 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33743 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
33744 </li> |
|
33745 </ul> |
|
33746 </li> |
|
33747 </ul> |
|
33748 </div> |
|
33749 </div> |
|
33750 |
|
33751 |
|
33752 |
|
33753 </div> |
|
33754 |
|
33755 |
|
33756 <div id="attr_viewConfig" class="attr item protected inherited"> |
|
33757 <a name="config_viewConfig"></a> |
|
33758 <h3 class="name"><code>viewConfig</code></h3> |
|
33759 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
33760 |
|
33761 |
|
33762 |
|
33763 |
|
33764 <span class="flag protected">protected</span> |
|
33765 |
|
33766 |
|
33767 |
|
33768 |
|
33769 |
|
33770 |
|
33771 |
|
33772 |
|
33773 |
|
33774 |
|
33775 |
|
33776 |
|
33777 <div class="meta"> |
|
33778 |
|
33779 |
|
33780 <p>Inherited from |
|
33781 <a href="../classes/DataTable.Base.html#attr_viewConfig">DataTable.Base</a>: |
|
33782 |
|
33783 |
|
33784 |
|
33785 <a href="../files/datatable_js_base.js.html#l560"><code>datatable/js/base.js:560</code></a> |
|
33786 |
|
33787 </p> |
|
33788 |
|
33789 |
|
33790 |
|
33791 |
|
33792 <p>Available since 3.6.0</p> |
|
33793 |
|
33794 </div> |
|
33795 |
|
33796 <div class="description"> |
|
33797 <p>Configuration object passed to the class constructor in <code>view</code> |
|
33798 during render.</p> |
|
33799 </div> |
|
33800 |
|
33801 |
|
33802 <p><strong>Default:</strong> undefined (initially unset)</p> |
|
33803 |
|
33804 |
|
33805 |
|
33806 <div class="emits box"> |
|
33807 <h4>Fires event <code>viewConfigChange</code></h4> |
|
33808 |
|
33809 <p> |
|
33810 Fires when the value for the configuration attribute <code>viewConfig</code> is |
|
33811 changed. You can listen for the event using the <code>on</code> method if you |
|
33812 wish to be notified before the attribute's value has changed, or |
|
33813 using the <code>after</code> method if you wish to be notified after the |
|
33814 attribute's value has changed. |
|
33815 </p> |
|
33816 |
|
33817 <div class="params"> |
|
33818 <h4>Parameters:</h4> |
|
33819 |
|
33820 <ul class="params-list"> |
|
33821 <li class="param"> |
|
33822 <code class="param-name">e</code> |
|
33823 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
33824 |
|
33825 <div class="param-description"> |
|
33826 An Event Facade object with the following |
|
33827 attribute-specific properties added: |
|
33828 </div> |
|
33829 |
|
33830 <ul class="params-list"> |
|
33831 <li class="param"> |
|
33832 <code class="param-name">prevVal</code> |
|
33833 <span class="type">Any</span> |
|
33834 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
33835 </li> |
|
33836 <li class="param"> |
|
33837 <code class="param-name">newVal</code> |
|
33838 <span class="type">Any</span> |
|
33839 <div class="param-description">The value the attribute is to be set to.</div> |
|
33840 </li> |
|
33841 <li class="param"> |
|
33842 <code class="param-name">attrName</code> |
|
33843 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33844 <div class="param-description">The name of the attribute being set.</div> |
|
33845 </li> |
|
33846 <li class="param"> |
|
33847 <code class="param-name">subAttrName</code> |
|
33848 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33849 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
33850 </li> |
|
33851 </ul> |
|
33852 </li> |
|
33853 </ul> |
|
33854 </div> |
|
33855 </div> |
|
33856 |
|
33857 |
|
33858 |
|
33859 </div> |
|
33860 |
|
33861 |
|
33862 <div id="attr_visible" class="attr item inherited"> |
|
33863 <a name="config_visible"></a> |
|
33864 <h3 class="name"><code>visible</code></h3> |
|
33865 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
33866 |
|
33867 |
|
33868 |
|
33869 |
|
33870 |
|
33871 |
|
33872 |
|
33873 |
|
33874 |
|
33875 |
|
33876 |
|
33877 |
|
33878 |
|
33879 |
|
33880 |
|
33881 <div class="meta"> |
|
33882 |
|
33883 |
|
33884 <p>Inherited from |
|
33885 <a href="../classes/Widget.html#attr_visible">Widget</a>: |
|
33886 |
|
33887 |
|
33888 |
|
33889 <a href="../files/widget_js_Widget.js.html#l242"><code>widget/js/Widget.js:242</code></a> |
|
33890 |
|
33891 </p> |
|
33892 |
|
33893 |
|
33894 |
|
33895 |
|
33896 </div> |
|
33897 |
|
33898 <div class="description"> |
|
33899 <p>Boolean indicating whether or not the Widget is visible.</p> |
|
33900 </div> |
|
33901 |
|
33902 |
|
33903 <p><strong>Default:</strong> TRUE</p> |
|
33904 |
|
33905 |
|
33906 |
|
33907 <div class="emits box"> |
|
33908 <h4>Fires event <code>visibleChange</code></h4> |
|
33909 |
|
33910 <p> |
|
33911 Fires when the value for the configuration attribute <code>visible</code> is |
|
33912 changed. You can listen for the event using the <code>on</code> method if you |
|
33913 wish to be notified before the attribute's value has changed, or |
|
33914 using the <code>after</code> method if you wish to be notified after the |
|
33915 attribute's value has changed. |
|
33916 </p> |
|
33917 |
|
33918 <div class="params"> |
|
33919 <h4>Parameters:</h4> |
|
33920 |
|
33921 <ul class="params-list"> |
|
33922 <li class="param"> |
|
33923 <code class="param-name">e</code> |
|
33924 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
33925 |
|
33926 <div class="param-description"> |
|
33927 An Event Facade object with the following |
|
33928 attribute-specific properties added: |
|
33929 </div> |
|
33930 |
|
33931 <ul class="params-list"> |
|
33932 <li class="param"> |
|
33933 <code class="param-name">prevVal</code> |
|
33934 <span class="type">Any</span> |
|
33935 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
33936 </li> |
|
33937 <li class="param"> |
|
33938 <code class="param-name">newVal</code> |
|
33939 <span class="type">Any</span> |
|
33940 <div class="param-description">The value the attribute is to be set to.</div> |
|
33941 </li> |
|
33942 <li class="param"> |
|
33943 <code class="param-name">attrName</code> |
|
33944 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33945 <div class="param-description">The name of the attribute being set.</div> |
|
33946 </li> |
|
33947 <li class="param"> |
|
33948 <code class="param-name">subAttrName</code> |
|
33949 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
33950 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
33951 </li> |
|
33952 </ul> |
|
33953 </li> |
|
33954 </ul> |
|
33955 </div> |
|
33956 </div> |
|
33957 |
|
33958 |
|
33959 |
|
33960 </div> |
|
33961 |
|
33962 |
|
33963 <div id="attr_width" class="attr item inherited"> |
|
33964 <a name="config_width"></a> |
|
33965 <h3 class="name"><code>width</code></h3> |
|
33966 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
33967 |
|
33968 |
|
33969 |
|
33970 |
|
33971 |
|
33972 |
|
33973 |
|
33974 |
|
33975 |
|
33976 |
|
33977 |
|
33978 |
|
33979 |
|
33980 |
|
33981 |
|
33982 <div class="meta"> |
|
33983 |
|
33984 |
|
33985 <p>Inherited from |
|
33986 <a href="../classes/Widget.html#attr_width">Widget</a>: |
|
33987 |
|
33988 |
|
33989 |
|
33990 <a href="../files/widget_js_Widget.js.html#l263"><code>widget/js/Widget.js:263</code></a> |
|
33991 |
|
33992 </p> |
|
33993 |
|
33994 |
|
33995 |
|
33996 |
|
33997 </div> |
|
33998 |
|
33999 <div class="description"> |
|
34000 <p>String with units, or number, representing the width of the Widget. If a number is provided, |
|
34001 the default unit, defined by the Widgets DEF_UNIT, property is used.</p> |
|
34002 </div> |
|
34003 |
|
34004 |
|
34005 <p><strong>Default:</strong> EMPTY_STR</p> |
|
34006 |
|
34007 |
|
34008 |
|
34009 <div class="emits box"> |
|
34010 <h4>Fires event <code>widthChange</code></h4> |
|
34011 |
|
34012 <p> |
|
34013 Fires when the value for the configuration attribute <code>width</code> is |
|
34014 changed. You can listen for the event using the <code>on</code> method if you |
|
34015 wish to be notified before the attribute's value has changed, or |
|
34016 using the <code>after</code> method if you wish to be notified after the |
|
34017 attribute's value has changed. |
|
34018 </p> |
|
34019 |
|
34020 <div class="params"> |
|
34021 <h4>Parameters:</h4> |
|
34022 |
|
34023 <ul class="params-list"> |
|
34024 <li class="param"> |
|
34025 <code class="param-name">e</code> |
|
34026 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
34027 |
|
34028 <div class="param-description"> |
|
34029 An Event Facade object with the following |
|
34030 attribute-specific properties added: |
|
34031 </div> |
|
34032 |
|
34033 <ul class="params-list"> |
|
34034 <li class="param"> |
|
34035 <code class="param-name">prevVal</code> |
|
34036 <span class="type">Any</span> |
|
34037 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
34038 </li> |
|
34039 <li class="param"> |
|
34040 <code class="param-name">newVal</code> |
|
34041 <span class="type">Any</span> |
|
34042 <div class="param-description">The value the attribute is to be set to.</div> |
|
34043 </li> |
|
34044 <li class="param"> |
|
34045 <code class="param-name">attrName</code> |
|
34046 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
34047 <div class="param-description">The name of the attribute being set.</div> |
|
34048 </li> |
|
34049 <li class="param"> |
|
34050 <code class="param-name">subAttrName</code> |
|
34051 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
34052 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
34053 </li> |
|
34054 </ul> |
|
34055 </li> |
|
34056 </ul> |
|
34057 </div> |
|
34058 </div> |
|
34059 |
|
34060 |
|
34061 |
|
34062 </div> |
|
34063 |
|
34064 |
|
34065 </div> |
|
34066 |
|
34067 |
|
34068 |
|
34069 <div id="events" class="api-class-tabpanel"> |
|
34070 <h2 class="off-left">Events</h2> |
|
34071 |
|
34072 |
|
34073 <div id="event_addColumn" class="events item"> |
|
34074 <h3 class="name"><code>addColumn</code></h3> |
|
34075 <span class="type"></span> |
|
34076 |
|
34077 |
|
34078 |
|
34079 |
|
34080 |
|
34081 |
|
34082 |
|
34083 |
|
34084 |
|
34085 <div class="meta"> |
|
34086 |
|
34087 |
|
34088 |
|
34089 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
34090 |
|
34091 <p> |
|
34092 |
|
34093 Defined in |
|
34094 |
|
34095 |
|
34096 |
|
34097 |
|
34098 <a href="../files/datatable_js_mutable.js.html#l592"><code>datatable/js/mutable.js:592</code></a> |
|
34099 |
|
34100 </p> |
|
34101 |
|
34102 |
|
34103 |
|
34104 |
|
34105 <p>Available since 3.5.0</p> |
|
34106 |
|
34107 </div> |
|
34108 |
|
34109 <div class="description"> |
|
34110 <p>Fired by the <code>addColumn</code> method.</p> |
|
34111 </div> |
|
34112 |
|
34113 |
|
34114 <div class="params"> |
|
34115 <h4>Event Payload:</h4> |
|
34116 |
|
34117 <ul class="params-list"> |
|
34118 |
|
34119 <li class="param"> |
|
34120 |
|
34121 <code class="param-name">column</code> |
|
34122 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
34123 |
|
34124 |
|
34125 |
|
34126 |
|
34127 <div class="param-description"> |
|
34128 <p>The new column definition object</p> |
|
34129 </div> |
|
34130 |
|
34131 |
|
34132 </li> |
|
34133 |
|
34134 <li class="param"> |
|
34135 |
|
34136 <code class="param-name">index</code> |
|
34137 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span> |
|
34138 |
|
34139 |
|
34140 |
|
34141 |
|
34142 <div class="param-description"> |
|
34143 <p>The array index to insert the new column</p> |
|
34144 </div> |
|
34145 |
|
34146 |
|
34147 </li> |
|
34148 |
|
34149 </ul> |
|
34150 </div> |
|
34151 |
|
34152 |
|
34153 |
|
34154 |
|
34155 </div> |
|
34156 |
|
34157 |
|
34158 <div id="event_destroy" class="events item inherited"> |
|
34159 <h3 class="name"><code>destroy</code></h3> |
|
34160 <span class="type"></span> |
|
34161 |
|
34162 |
|
34163 |
|
34164 |
|
34165 |
|
34166 |
|
34167 |
|
34168 |
|
34169 |
|
34170 <div class="meta"> |
|
34171 |
|
34172 |
|
34173 <p>Inherited from |
|
34174 <a href="../classes/BaseObservable.html#event_destroy">BaseObservable</a>: |
|
34175 |
|
34176 |
|
34177 |
|
34178 <a href="../files/base_js_BaseObservable.js.html#l151"><code>base/js/BaseObservable.js:151</code></a> |
|
34179 |
|
34180 </p> |
|
34181 |
|
34182 |
|
34183 |
|
34184 |
|
34185 </div> |
|
34186 |
|
34187 <div class="description"> |
|
34188 <p> |
|
34189 Lifecycle event for the destroy phase, |
|
34190 fired prior to destruction. Invoking the preventDefault |
|
34191 method on the event object provided to subscribers will |
|
34192 prevent destruction from proceeding. |
|
34193 </p> |
|
34194 |
|
34195 <p> |
|
34196 Subscribers to the "after" moment of this event, will be notified |
|
34197 after destruction is complete (and as a result cannot prevent |
|
34198 destruction). |
|
34199 </p> |
|
34200 </div> |
|
34201 |
|
34202 |
|
34203 <div class="params"> |
|
34204 <h4>Event Payload:</h4> |
|
34205 |
|
34206 <ul class="params-list"> |
|
34207 |
|
34208 <li class="param"> |
|
34209 |
|
34210 <code class="param-name">e</code> |
|
34211 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
34212 |
|
34213 |
|
34214 |
|
34215 |
|
34216 <div class="param-description"> |
|
34217 <p>Event object</p> |
|
34218 </div> |
|
34219 |
|
34220 |
|
34221 </li> |
|
34222 |
|
34223 </ul> |
|
34224 </div> |
|
34225 |
|
34226 |
|
34227 |
|
34228 |
|
34229 </div> |
|
34230 |
|
34231 |
|
34232 <div id="event_init" class="events item inherited"> |
|
34233 <h3 class="name"><code>init</code></h3> |
|
34234 <span class="type"></span> |
|
34235 |
|
34236 |
|
34237 |
|
34238 |
|
34239 |
|
34240 |
|
34241 |
|
34242 |
|
34243 |
|
34244 <div class="meta"> |
|
34245 |
|
34246 |
|
34247 <p>Inherited from |
|
34248 <a href="../classes/BaseObservable.html#event_init">BaseObservable</a>: |
|
34249 |
|
34250 |
|
34251 |
|
34252 <a href="../files/base_js_BaseObservable.js.html#l62"><code>base/js/BaseObservable.js:62</code></a> |
|
34253 |
|
34254 </p> |
|
34255 |
|
34256 |
|
34257 |
|
34258 |
|
34259 </div> |
|
34260 |
|
34261 <div class="description"> |
|
34262 <p> |
|
34263 Lifecycle event for the init phase, fired prior to initialization. |
|
34264 Invoking the preventDefault() method on the event object provided |
|
34265 to subscribers will prevent initialization from occuring. |
|
34266 </p> |
|
34267 |
|
34268 <p> |
|
34269 Subscribers to the "after" momemt of this event, will be notified |
|
34270 after initialization of the object is complete (and therefore |
|
34271 cannot prevent initialization). |
|
34272 </p> |
|
34273 </div> |
|
34274 |
|
34275 |
|
34276 <div class="params"> |
|
34277 <h4>Event Payload:</h4> |
|
34278 |
|
34279 <ul class="params-list"> |
|
34280 |
|
34281 <li class="param"> |
|
34282 |
|
34283 <code class="param-name">e</code> |
|
34284 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
34285 |
|
34286 |
|
34287 |
|
34288 |
|
34289 <div class="param-description"> |
|
34290 <p>Event object, with a cfg property which |
|
34291 refers to the configuration object passed to the constructor.</p> |
|
34292 </div> |
|
34293 |
|
34294 |
|
34295 </li> |
|
34296 |
|
34297 </ul> |
|
34298 </div> |
|
34299 |
|
34300 |
|
34301 |
|
34302 |
|
34303 </div> |
|
34304 |
|
34305 |
|
34306 <div id="event_modifyColumn" class="events item"> |
|
34307 <h3 class="name"><code>modifyColumn</code></h3> |
|
34308 <span class="type"></span> |
|
34309 |
|
34310 |
|
34311 |
|
34312 |
|
34313 |
|
34314 |
|
34315 |
|
34316 |
|
34317 |
|
34318 <div class="meta"> |
|
34319 |
|
34320 |
|
34321 |
|
34322 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
34323 |
|
34324 <p> |
|
34325 |
|
34326 Defined in |
|
34327 |
|
34328 |
|
34329 |
|
34330 |
|
34331 <a href="../files/datatable_js_mutable.js.html#l611"><code>datatable/js/mutable.js:611</code></a> |
|
34332 |
|
34333 </p> |
|
34334 |
|
34335 |
|
34336 |
|
34337 |
|
34338 <p>Available since 3.5.0</p> |
|
34339 |
|
34340 </div> |
|
34341 |
|
34342 <div class="description"> |
|
34343 <p>Fired by the <code>modifyColumn</code> method.</p> |
|
34344 </div> |
|
34345 |
|
34346 |
|
34347 <div class="params"> |
|
34348 <h4>Event Payload:</h4> |
|
34349 |
|
34350 <ul class="params-list"> |
|
34351 |
|
34352 <li class="param"> |
|
34353 |
|
34354 <code class="param-name">column</code> |
|
34355 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span> |
|
34356 |
|
34357 |
|
34358 |
|
34359 |
|
34360 <div class="param-description"> |
|
34361 <p>The column definition object or identifier</p> |
|
34362 </div> |
|
34363 |
|
34364 |
|
34365 </li> |
|
34366 |
|
34367 <li class="param"> |
|
34368 |
|
34369 <code class="param-name">newColumnDef</code> |
|
34370 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
34371 |
|
34372 |
|
34373 |
|
34374 |
|
34375 <div class="param-description"> |
|
34376 <p>The properties to assign to the column</p> |
|
34377 </div> |
|
34378 |
|
34379 |
|
34380 </li> |
|
34381 |
|
34382 </ul> |
|
34383 </div> |
|
34384 |
|
34385 |
|
34386 |
|
34387 |
|
34388 </div> |
|
34389 |
|
34390 |
|
34391 <div id="event_moveColumn" class="events item"> |
|
34392 <h3 class="name"><code>moveColumn</code></h3> |
|
34393 <span class="type"></span> |
|
34394 |
|
34395 |
|
34396 |
|
34397 |
|
34398 |
|
34399 |
|
34400 |
|
34401 |
|
34402 |
|
34403 <div class="meta"> |
|
34404 |
|
34405 |
|
34406 |
|
34407 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
34408 |
|
34409 <p> |
|
34410 |
|
34411 Defined in |
|
34412 |
|
34413 |
|
34414 |
|
34415 |
|
34416 <a href="../files/datatable_js_mutable.js.html#l621"><code>datatable/js/mutable.js:621</code></a> |
|
34417 |
|
34418 </p> |
|
34419 |
|
34420 |
|
34421 |
|
34422 |
|
34423 <p>Available since 3.5.0</p> |
|
34424 |
|
34425 </div> |
|
34426 |
|
34427 <div class="description"> |
|
34428 <p>Fired by the <code>moveColumn</code> method.</p> |
|
34429 </div> |
|
34430 |
|
34431 |
|
34432 <div class="params"> |
|
34433 <h4>Event Payload:</h4> |
|
34434 |
|
34435 <ul class="params-list"> |
|
34436 |
|
34437 <li class="param"> |
|
34438 |
|
34439 <code class="param-name">column</code> |
|
34440 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span> |
|
34441 |
|
34442 |
|
34443 |
|
34444 |
|
34445 <div class="param-description"> |
|
34446 <p>The column definition object or identifier</p> |
|
34447 </div> |
|
34448 |
|
34449 |
|
34450 </li> |
|
34451 |
|
34452 <li class="param"> |
|
34453 |
|
34454 <code class="param-name">index</code> |
|
34455 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
34456 |
|
34457 |
|
34458 |
|
34459 |
|
34460 <div class="param-description"> |
|
34461 <p>The destination index to move to</p> |
|
34462 </div> |
|
34463 |
|
34464 |
|
34465 </li> |
|
34466 |
|
34467 </ul> |
|
34468 </div> |
|
34469 |
|
34470 |
|
34471 |
|
34472 |
|
34473 </div> |
|
34474 |
|
34475 |
|
34476 <div id="event_removeColumn" class="events item"> |
|
34477 <h3 class="name"><code>removeColumn</code></h3> |
|
34478 <span class="type"></span> |
|
34479 |
|
34480 |
|
34481 |
|
34482 |
|
34483 |
|
34484 |
|
34485 |
|
34486 |
|
34487 |
|
34488 <div class="meta"> |
|
34489 |
|
34490 |
|
34491 |
|
34492 <p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p> |
|
34493 |
|
34494 <p> |
|
34495 |
|
34496 Defined in |
|
34497 |
|
34498 |
|
34499 |
|
34500 |
|
34501 <a href="../files/datatable_js_mutable.js.html#l602"><code>datatable/js/mutable.js:602</code></a> |
|
34502 |
|
34503 </p> |
|
34504 |
|
34505 |
|
34506 |
|
34507 |
|
34508 <p>Available since 3.5.0</p> |
|
34509 |
|
34510 </div> |
|
34511 |
|
34512 <div class="description"> |
|
34513 <p>Fired by the <code>removeColumn</code> method.</p> |
|
34514 </div> |
|
34515 |
|
34516 |
|
34517 <div class="params"> |
|
34518 <h4>Event Payload:</h4> |
|
34519 |
|
34520 <ul class="params-list"> |
|
34521 |
|
34522 <li class="param"> |
|
34523 |
|
34524 <code class="param-name">column</code> |
|
34525 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span> |
|
34526 |
|
34527 |
|
34528 |
|
34529 |
|
34530 <div class="param-description"> |
|
34531 <p>The column definition object or identifier</p> |
|
34532 </div> |
|
34533 |
|
34534 |
|
34535 </li> |
|
34536 |
|
34537 </ul> |
|
34538 </div> |
|
34539 |
|
34540 |
|
34541 |
|
34542 |
|
34543 </div> |
|
34544 |
|
34545 |
|
34546 <div id="event_render" class="events item inherited"> |
|
34547 <h3 class="name"><code>render</code></h3> |
|
34548 <span class="type"></span> |
|
34549 |
|
34550 |
|
34551 |
|
34552 |
|
34553 |
|
34554 |
|
34555 |
|
34556 |
|
34557 |
|
34558 <div class="meta"> |
|
34559 |
|
34560 |
|
34561 <p>Inherited from |
|
34562 <a href="../classes/Widget.html#event_render">Widget</a>: |
|
34563 |
|
34564 |
|
34565 |
|
34566 <a href="../files/widget_js_Widget.js.html#l543"><code>widget/js/Widget.js:543</code></a> |
|
34567 |
|
34568 </p> |
|
34569 |
|
34570 |
|
34571 |
|
34572 |
|
34573 </div> |
|
34574 |
|
34575 <div class="description"> |
|
34576 <p>Lifecycle event for the render phase, fired prior to rendering the UI |
|
34577 for the widget (prior to invoking the widget's renderer method).</p> |
|
34578 |
|
34579 <p> |
|
34580 Subscribers to the "on" moment of this event, will be notified |
|
34581 before the widget is rendered. |
|
34582 </p> |
|
34583 |
|
34584 <p> |
|
34585 Subscribers to the "after" moment of this event, will be notified |
|
34586 after rendering is complete. |
|
34587 </p> |
|
34588 </div> |
|
34589 |
|
34590 |
|
34591 <div class="params"> |
|
34592 <h4>Event Payload:</h4> |
|
34593 |
|
34594 <ul class="params-list"> |
|
34595 |
|
34596 <li class="param"> |
|
34597 |
|
34598 <code class="param-name">e</code> |
|
34599 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
34600 |
|
34601 |
|
34602 |
|
34603 |
|
34604 <div class="param-description"> |
|
34605 <p>The Event Facade</p> |
|
34606 </div> |
|
34607 |
|
34608 |
|
34609 </li> |
|
34610 |
|
34611 </ul> |
|
34612 </div> |
|
34613 |
|
34614 |
|
34615 |
|
34616 |
|
34617 </div> |
|
34618 |
|
34619 |
|
34620 <div id="event_sort" class="events item"> |
|
34621 <h3 class="name"><code>sort</code></h3> |
|
34622 <span class="type"></span> |
|
34623 |
|
34624 |
|
34625 |
|
34626 |
|
34627 |
|
34628 |
|
34629 |
|
34630 |
|
34631 |
|
34632 <div class="meta"> |
|
34633 |
|
34634 |
|
34635 |
|
34636 <p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p> |
|
34637 |
|
34638 <p> |
|
34639 |
|
34640 Defined in |
|
34641 |
|
34642 |
|
34643 |
|
34644 |
|
34645 <a href="../files/datatable_js_sort.js.html#l201"><code>datatable/js/sort.js:201</code></a> |
|
34646 |
|
34647 </p> |
|
34648 |
|
34649 |
|
34650 |
|
34651 |
|
34652 </div> |
|
34653 |
|
34654 <div class="description"> |
|
34655 <p>Notifies of an impending sort, either from clicking on a column |
|
34656 header, or from a call to the <code>sort</code> or <code>toggleSort</code> method.</p> |
|
34657 |
|
34658 <p>The requested sort is available in the <code>sortBy</code> property of the event.</p> |
|
34659 |
|
34660 <p>The default behavior of this event sets the table's <code>sortBy</code> attribute.</p> |
|
34661 </div> |
|
34662 |
|
34663 |
|
34664 <div class="params"> |
|
34665 <h4>Event Payload:</h4> |
|
34666 |
|
34667 <ul class="params-list"> |
|
34668 |
|
34669 <li class="param"> |
|
34670 |
|
34671 <code class="param-name">sortBy</code> |
|
34672 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
34673 |
|
34674 |
|
34675 |
|
34676 |
|
34677 <div class="param-description"> |
|
34678 <p>The requested sort</p> |
|
34679 </div> |
|
34680 |
|
34681 |
|
34682 </li> |
|
34683 |
|
34684 </ul> |
|
34685 </div> |
|
34686 |
|
34687 |
|
34688 |
|
34689 |
|
34690 </div> |
|
34691 |
|
34692 |
|
34693 <div id="event_widget:contentUpdate" class="events item inherited"> |
|
34694 <h3 class="name"><code>widget:contentUpdate</code></h3> |
|
34695 <span class="type"></span> |
|
34696 |
|
34697 |
|
34698 |
|
34699 |
|
34700 |
|
34701 |
|
34702 |
|
34703 |
|
34704 |
|
34705 <div class="meta"> |
|
34706 |
|
34707 |
|
34708 <p>Inherited from |
|
34709 <a href="../classes/Widget.html#event_widget:contentUpdate">Widget</a>: |
|
34710 |
|
34711 |
|
34712 |
|
34713 <a href="../files/widget_js_Widget.js.html#l397"><code>widget/js/Widget.js:397</code></a> |
|
34714 |
|
34715 </p> |
|
34716 |
|
34717 |
|
34718 |
|
34719 |
|
34720 </div> |
|
34721 |
|
34722 <div class="description"> |
|
34723 <p>Notification event, which widget implementations can fire, when |
|
34724 they change the content of the widget. This event has no default |
|
34725 behavior and cannot be prevented, so the "on" or "after" |
|
34726 moments are effectively equivalent (with on listeners being invoked before |
|
34727 after listeners).</p> |
|
34728 </div> |
|
34729 |
|
34730 |
|
34731 <div class="params"> |
|
34732 <h4>Event Payload:</h4> |
|
34733 |
|
34734 <ul class="params-list"> |
|
34735 |
|
34736 <li class="param"> |
|
34737 |
|
34738 <code class="param-name">e</code> |
|
34739 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
34740 |
|
34741 |
|
34742 |
|
34743 |
|
34744 <div class="param-description"> |
|
34745 <p>The Event Facade</p> |
|
34746 </div> |
|
34747 |
|
34748 |
|
34749 </li> |
|
34750 |
|
34751 </ul> |
|
34752 </div> |
|
34753 |
|
34754 |
|
34755 |
|
34756 |
|
34757 </div> |
|
34758 |
|
34759 |
|
34760 </div> |
|
34761 |
|
34762 </div> |
|
34763 </div> |
|
34764 |
|
34765 </div> |
|
34766 </div> |
|
34767 </div> |
|
34768 </div> |
|
34769 </div> |
|
34770 </div> |
|
34771 <script src="../assets/vendor/prettify/prettify-min.js"></script> |
|
34772 <script>prettyPrint();</script> |
|
34773 <script src="../assets/js/yui-prettify.js"></script> |
|
34774 <script src="../assets/../api.js"></script> |
|
34775 <script src="../assets/js/api-filter.js"></script> |
|
34776 <script src="../assets/js/api-list.js"></script> |
|
34777 <script src="../assets/js/api-search.js"></script> |
|
34778 <script src="../assets/js/apidocs.js"></script> |
|
34779 </body> |
|
34780 </html> |