|
1 <!DOCTYPE html> |
|
2 <html lang="en"> |
|
3 <head> |
|
4 <meta charset="utf-8"> |
|
5 <title>ModelSync.REST - 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>ModelSync.REST Class</h1> |
|
1532 <div class="box meta"> |
|
1533 |
|
1534 |
|
1535 |
|
1536 |
|
1537 |
|
1538 <div class="foundat"> |
|
1539 Defined in: <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l12"><code>app/js/model-extensions/model-sync-rest.js:12</code></a> |
|
1540 </div> |
|
1541 |
|
1542 |
|
1543 |
|
1544 |
|
1545 Module: <a href="../modules/model-sync-rest.html">model-sync-rest</a><br> |
|
1546 Parent Module: <a href="../modules/app.html">app</a> |
|
1547 |
|
1548 |
|
1549 |
|
1550 |
|
1551 <p>Available since 3.6.0</p> |
|
1552 |
|
1553 </div> |
|
1554 |
|
1555 |
|
1556 |
|
1557 <div class="box intro"> |
|
1558 <p>An extension which provides a RESTful XHR sync implementation that can be mixed |
|
1559 into a Model or ModelList subclass.</p> |
|
1560 |
|
1561 <p>This makes it trivial for your Model or ModelList subclasses communicate and |
|
1562 transmit their data via RESTful XHRs. In most cases you'll only need to provide |
|
1563 a value for <code>root</code> when sub-classing <code>Y.Model</code>.</p> |
|
1564 |
|
1565 <pre class="code prettyprint"><code>Y.User = Y.Base.create('user', Y.Model, [Y.ModelSync.REST], { |
|
1566 root: '/users' |
|
1567 }); |
|
1568 |
|
1569 Y.Users = Y.Base.create('users', Y.ModelList, [Y.ModelSync.REST], { |
|
1570 // By convention <code>Y.User</code>'s <code>root</code> will be used for the lists' URL. |
|
1571 model: Y.User |
|
1572 }); |
|
1573 |
|
1574 var users = new Y.Users(); |
|
1575 |
|
1576 // GET users list from: "/users" |
|
1577 users.load(function () { |
|
1578 var firstUser = users.item(0); |
|
1579 |
|
1580 firstUser.get('id'); // => "1" |
|
1581 |
|
1582 // PUT updated user data at: "/users/1" |
|
1583 firstUser.set('name', 'Eric').save(); |
|
1584 }); |
|
1585 </code></pre> |
|
1586 </div> |
|
1587 |
|
1588 |
|
1589 |
|
1590 <div id="classdocs" class="tabview"> |
|
1591 <ul class="api-class-tabs"> |
|
1592 <li class="api-class-tab index"><a href="#index">Index</a></li> |
|
1593 |
|
1594 |
|
1595 <li class="api-class-tab methods"><a href="#methods">Methods</a></li> |
|
1596 |
|
1597 |
|
1598 <li class="api-class-tab properties"><a href="#properties">Properties</a></li> |
|
1599 |
|
1600 |
|
1601 |
|
1602 </ul> |
|
1603 |
|
1604 <div> |
|
1605 <div id="index" class="api-class-tabpanel index"> |
|
1606 <h2 class="off-left">Item Index</h2> |
|
1607 |
|
1608 |
|
1609 <div class="index-section methods"> |
|
1610 <h3>Methods</h3> |
|
1611 |
|
1612 <ul class="index-list methods"> |
|
1613 |
|
1614 <li class="index-item method protected"> |
|
1615 <a href="#method__joinURL">_joinURL</a> |
|
1616 |
|
1617 |
|
1618 |
|
1619 </li> |
|
1620 |
|
1621 <li class="index-item method protected"> |
|
1622 <a href="#method__onSyncIOEnd">_onSyncIOEnd</a> |
|
1623 |
|
1624 |
|
1625 |
|
1626 </li> |
|
1627 |
|
1628 <li class="index-item method protected"> |
|
1629 <a href="#method__onSyncIOFailure">_onSyncIOFailure</a> |
|
1630 |
|
1631 |
|
1632 |
|
1633 </li> |
|
1634 |
|
1635 <li class="index-item method protected"> |
|
1636 <a href="#method__onSyncIOStart">_onSyncIOStart</a> |
|
1637 |
|
1638 |
|
1639 |
|
1640 </li> |
|
1641 |
|
1642 <li class="index-item method protected"> |
|
1643 <a href="#method__onSyncIOSuccess">_onSyncIOSuccess</a> |
|
1644 |
|
1645 |
|
1646 |
|
1647 </li> |
|
1648 |
|
1649 <li class="index-item method protected"> |
|
1650 <a href="#method__parse">_parse</a> |
|
1651 |
|
1652 |
|
1653 |
|
1654 </li> |
|
1655 |
|
1656 <li class="index-item method protected"> |
|
1657 <a href="#method__sendSyncIORequest">_sendSyncIORequest</a> |
|
1658 |
|
1659 |
|
1660 |
|
1661 </li> |
|
1662 |
|
1663 <li class="index-item method protected"> |
|
1664 <a href="#method__substituteURL">_substituteURL</a> |
|
1665 |
|
1666 |
|
1667 |
|
1668 </li> |
|
1669 |
|
1670 <li class="index-item method"> |
|
1671 <a href="#method_getURL">getURL</a> |
|
1672 |
|
1673 |
|
1674 |
|
1675 </li> |
|
1676 |
|
1677 <li class="index-item method"> |
|
1678 <a href="#method_parseIOResponse">parseIOResponse</a> |
|
1679 |
|
1680 |
|
1681 |
|
1682 </li> |
|
1683 |
|
1684 <li class="index-item method"> |
|
1685 <a href="#method_serialize">serialize</a> |
|
1686 |
|
1687 |
|
1688 |
|
1689 </li> |
|
1690 |
|
1691 <li class="index-item method"> |
|
1692 <a href="#method_sync">sync</a> |
|
1693 |
|
1694 |
|
1695 |
|
1696 </li> |
|
1697 |
|
1698 </ul> |
|
1699 </div> |
|
1700 |
|
1701 |
|
1702 |
|
1703 <div class="index-section properties"> |
|
1704 <h3>Properties</h3> |
|
1705 |
|
1706 <ul class="index-list properties"> |
|
1707 |
|
1708 <li class="index-item property protected"> |
|
1709 <a href="#property__NON_ATTRS_CFG">_NON_ATTRS_CFG</a> |
|
1710 |
|
1711 |
|
1712 <span class="flag static">static</span> |
|
1713 |
|
1714 |
|
1715 </li> |
|
1716 |
|
1717 <li class="index-item property"> |
|
1718 <a href="#property_CSRF_TOKEN">CSRF_TOKEN</a> |
|
1719 |
|
1720 |
|
1721 <span class="flag static">static</span> |
|
1722 |
|
1723 |
|
1724 </li> |
|
1725 |
|
1726 <li class="index-item property"> |
|
1727 <a href="#property_EMULATE_HTTP">EMULATE_HTTP</a> |
|
1728 |
|
1729 |
|
1730 <span class="flag static">static</span> |
|
1731 |
|
1732 |
|
1733 </li> |
|
1734 |
|
1735 <li class="index-item property"> |
|
1736 <a href="#property_HTTP_HEADERS">HTTP_HEADERS</a> |
|
1737 |
|
1738 |
|
1739 <span class="flag static">static</span> |
|
1740 |
|
1741 |
|
1742 </li> |
|
1743 |
|
1744 <li class="index-item property"> |
|
1745 <a href="#property_HTTP_METHODS">HTTP_METHODS</a> |
|
1746 |
|
1747 |
|
1748 <span class="flag static">static</span> |
|
1749 |
|
1750 |
|
1751 </li> |
|
1752 |
|
1753 <li class="index-item property"> |
|
1754 <a href="#property_HTTP_TIMEOUT">HTTP_TIMEOUT</a> |
|
1755 |
|
1756 |
|
1757 <span class="flag static">static</span> |
|
1758 |
|
1759 |
|
1760 </li> |
|
1761 |
|
1762 <li class="index-item property"> |
|
1763 <a href="#property_root">root</a> |
|
1764 |
|
1765 |
|
1766 |
|
1767 </li> |
|
1768 |
|
1769 <li class="index-item property"> |
|
1770 <a href="#property_url">url</a> |
|
1771 |
|
1772 |
|
1773 |
|
1774 </li> |
|
1775 |
|
1776 </ul> |
|
1777 </div> |
|
1778 |
|
1779 |
|
1780 |
|
1781 |
|
1782 |
|
1783 </div> |
|
1784 |
|
1785 |
|
1786 <div id="methods" class="api-class-tabpanel"> |
|
1787 <h2 class="off-left">Methods</h2> |
|
1788 |
|
1789 |
|
1790 <div id="method__joinURL" class="method item protected"> |
|
1791 <h3 class="name"><code>_joinURL</code></h3> |
|
1792 |
|
1793 |
|
1794 <div class="args"> |
|
1795 <span class="paren">(</span><ul class="args-list inline commas"> |
|
1796 |
|
1797 <li class="arg"> |
|
1798 |
|
1799 <code>url</code> |
|
1800 |
|
1801 </li> |
|
1802 |
|
1803 </ul><span class="paren">)</span> |
|
1804 </div> |
|
1805 |
|
1806 |
|
1807 |
|
1808 <span class="returns-inline"> |
|
1809 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
1810 </span> |
|
1811 |
|
1812 |
|
1813 |
|
1814 |
|
1815 |
|
1816 <span class="flag protected">protected</span> |
|
1817 |
|
1818 |
|
1819 |
|
1820 |
|
1821 |
|
1822 |
|
1823 |
|
1824 |
|
1825 |
|
1826 |
|
1827 <div class="meta"> |
|
1828 |
|
1829 |
|
1830 |
|
1831 <p> |
|
1832 |
|
1833 Defined in |
|
1834 |
|
1835 |
|
1836 |
|
1837 |
|
1838 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l496"><code>app/js/model-extensions/model-sync-rest.js:496</code></a> |
|
1839 |
|
1840 </p> |
|
1841 |
|
1842 |
|
1843 |
|
1844 |
|
1845 |
|
1846 <p>Available since 3.6.0</p> |
|
1847 |
|
1848 </div> |
|
1849 |
|
1850 <div class="description"> |
|
1851 <p>Joins the <code>root</code> URL to the specified <code>url</code>, normalizing leading/trailing |
|
1852 "/" characters.</p> |
|
1853 </div> |
|
1854 |
|
1855 |
|
1856 <div class="params"> |
|
1857 <h4>Parameters:</h4> |
|
1858 |
|
1859 <ul class="params-list"> |
|
1860 |
|
1861 <li class="param"> |
|
1862 |
|
1863 <code class="param-name">url</code> |
|
1864 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
1865 |
|
1866 |
|
1867 |
|
1868 |
|
1869 <div class="param-description"> |
|
1870 <p>URL to append to the <code>root</code> URL.</p> |
|
1871 </div> |
|
1872 |
|
1873 |
|
1874 </li> |
|
1875 |
|
1876 </ul> |
|
1877 </div> |
|
1878 |
|
1879 |
|
1880 |
|
1881 <div class="returns"> |
|
1882 <h4>Returns:</h4> |
|
1883 |
|
1884 <div class="returns-description"> |
|
1885 |
|
1886 |
|
1887 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
1888 |
|
1889 Joined URL. |
|
1890 |
|
1891 </div> |
|
1892 </div> |
|
1893 |
|
1894 |
|
1895 |
|
1896 <div class="example"> |
|
1897 <h4>Example:</h4> |
|
1898 |
|
1899 <div class="example-content"> |
|
1900 <pre class="code prettyprint"><code>model.root = '/foo' |
|
1901 model._joinURL('bar'); // => '/foo/bar' |
|
1902 model._joinURL('/bar'); // => '/foo/bar' |
|
1903 |
|
1904 model.root = '/foo/' |
|
1905 model._joinURL('bar'); // => '/foo/bar/' |
|
1906 model._joinURL('/bar'); // => '/foo/bar/' |
|
1907 </code></pre> |
|
1908 </div> |
|
1909 </div> |
|
1910 |
|
1911 </div> |
|
1912 |
|
1913 |
|
1914 <div id="method__onSyncIOEnd" class="method item protected"> |
|
1915 <h3 class="name"><code>_onSyncIOEnd</code></h3> |
|
1916 |
|
1917 |
|
1918 <div class="args"> |
|
1919 <span class="paren">(</span><ul class="args-list inline commas"> |
|
1920 |
|
1921 <li class="arg"> |
|
1922 |
|
1923 <code>txId</code> |
|
1924 |
|
1925 </li> |
|
1926 |
|
1927 <li class="arg"> |
|
1928 |
|
1929 <code>details</code> |
|
1930 |
|
1931 </li> |
|
1932 |
|
1933 </ul><span class="paren">)</span> |
|
1934 </div> |
|
1935 |
|
1936 |
|
1937 |
|
1938 |
|
1939 |
|
1940 |
|
1941 |
|
1942 <span class="flag protected">protected</span> |
|
1943 |
|
1944 |
|
1945 |
|
1946 |
|
1947 |
|
1948 |
|
1949 |
|
1950 |
|
1951 |
|
1952 |
|
1953 <div class="meta"> |
|
1954 |
|
1955 |
|
1956 |
|
1957 <p> |
|
1958 |
|
1959 Defined in |
|
1960 |
|
1961 |
|
1962 |
|
1963 |
|
1964 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l641"><code>app/js/model-extensions/model-sync-rest.js:641</code></a> |
|
1965 |
|
1966 </p> |
|
1967 |
|
1968 |
|
1969 |
|
1970 |
|
1971 |
|
1972 <p>Available since 3.6.0</p> |
|
1973 |
|
1974 </div> |
|
1975 |
|
1976 <div class="description"> |
|
1977 <p>Called when the <code>Y.io</code> request has finished, after "success" or "failure" |
|
1978 has been determined.</p> |
|
1979 |
|
1980 <p>This is a no-op by default, but provides a hook for overriding.</p> |
|
1981 </div> |
|
1982 |
|
1983 |
|
1984 <div class="params"> |
|
1985 <h4>Parameters:</h4> |
|
1986 |
|
1987 <ul class="params-list"> |
|
1988 |
|
1989 <li class="param"> |
|
1990 |
|
1991 <code class="param-name">txId</code> |
|
1992 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
1993 |
|
1994 |
|
1995 |
|
1996 |
|
1997 <div class="param-description"> |
|
1998 <p>The <code>Y.io</code> transaction id.</p> |
|
1999 </div> |
|
2000 |
|
2001 |
|
2002 </li> |
|
2003 |
|
2004 <li class="param"> |
|
2005 |
|
2006 <code class="param-name">details</code> |
|
2007 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2008 |
|
2009 |
|
2010 |
|
2011 |
|
2012 <div class="param-description"> |
|
2013 <p>Extra details carried through from <code>sync()</code>:</p> |
|
2014 </div> |
|
2015 |
|
2016 |
|
2017 <ul class="params-list"> |
|
2018 |
|
2019 <li class="param"> |
|
2020 |
|
2021 <code class="param-name">action</code> |
|
2022 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2023 |
|
2024 |
|
2025 <div class="param-description"> |
|
2026 <p>The sync action performed.</p> |
|
2027 </div> |
|
2028 |
|
2029 |
|
2030 </li> |
|
2031 |
|
2032 <li class="param"> |
|
2033 |
|
2034 <code class="param-name optional">[callback]</code> |
|
2035 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
2036 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
2037 |
|
2038 |
|
2039 <div class="param-description"> |
|
2040 <p>The function to call after syncing.</p> |
|
2041 </div> |
|
2042 |
|
2043 |
|
2044 </li> |
|
2045 |
|
2046 <li class="param"> |
|
2047 |
|
2048 <code class="param-name">url</code> |
|
2049 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2050 |
|
2051 |
|
2052 <div class="param-description"> |
|
2053 <p>The URL of the requested resource.</p> |
|
2054 </div> |
|
2055 |
|
2056 |
|
2057 </li> |
|
2058 |
|
2059 </ul> |
|
2060 |
|
2061 </li> |
|
2062 |
|
2063 </ul> |
|
2064 </div> |
|
2065 |
|
2066 |
|
2067 |
|
2068 |
|
2069 |
|
2070 </div> |
|
2071 |
|
2072 |
|
2073 <div id="method__onSyncIOFailure" class="method item protected"> |
|
2074 <h3 class="name"><code>_onSyncIOFailure</code></h3> |
|
2075 |
|
2076 |
|
2077 <div class="args"> |
|
2078 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2079 |
|
2080 <li class="arg"> |
|
2081 |
|
2082 <code>txId</code> |
|
2083 |
|
2084 </li> |
|
2085 |
|
2086 <li class="arg"> |
|
2087 |
|
2088 <code>res</code> |
|
2089 |
|
2090 </li> |
|
2091 |
|
2092 <li class="arg"> |
|
2093 |
|
2094 <code>details</code> |
|
2095 |
|
2096 </li> |
|
2097 |
|
2098 </ul><span class="paren">)</span> |
|
2099 </div> |
|
2100 |
|
2101 |
|
2102 |
|
2103 |
|
2104 |
|
2105 |
|
2106 |
|
2107 <span class="flag protected">protected</span> |
|
2108 |
|
2109 |
|
2110 |
|
2111 |
|
2112 |
|
2113 |
|
2114 |
|
2115 |
|
2116 |
|
2117 |
|
2118 <div class="meta"> |
|
2119 |
|
2120 |
|
2121 |
|
2122 <p> |
|
2123 |
|
2124 Defined in |
|
2125 |
|
2126 |
|
2127 |
|
2128 |
|
2129 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l658"><code>app/js/model-extensions/model-sync-rest.js:658</code></a> |
|
2130 |
|
2131 </p> |
|
2132 |
|
2133 |
|
2134 |
|
2135 |
|
2136 |
|
2137 <p>Available since 3.6.0</p> |
|
2138 |
|
2139 </div> |
|
2140 |
|
2141 <div class="description"> |
|
2142 <p>Called when the <code>Y.io</code> request has finished unsuccessfully.</p> |
|
2143 |
|
2144 <p>By default this calls the <code>details.callback</code> function passing it the HTTP |
|
2145 status code and message as an error object along with the response body.</p> |
|
2146 </div> |
|
2147 |
|
2148 |
|
2149 <div class="params"> |
|
2150 <h4>Parameters:</h4> |
|
2151 |
|
2152 <ul class="params-list"> |
|
2153 |
|
2154 <li class="param"> |
|
2155 |
|
2156 <code class="param-name">txId</code> |
|
2157 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2158 |
|
2159 |
|
2160 |
|
2161 |
|
2162 <div class="param-description"> |
|
2163 <p>The <code>Y.io</code> transaction id.</p> |
|
2164 </div> |
|
2165 |
|
2166 |
|
2167 </li> |
|
2168 |
|
2169 <li class="param"> |
|
2170 |
|
2171 <code class="param-name">res</code> |
|
2172 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2173 |
|
2174 |
|
2175 |
|
2176 |
|
2177 <div class="param-description"> |
|
2178 <p>The <code>Y.io</code> response object.</p> |
|
2179 </div> |
|
2180 |
|
2181 |
|
2182 </li> |
|
2183 |
|
2184 <li class="param"> |
|
2185 |
|
2186 <code class="param-name">details</code> |
|
2187 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2188 |
|
2189 |
|
2190 |
|
2191 |
|
2192 <div class="param-description"> |
|
2193 <p>Extra details carried through from <code>sync()</code>:</p> |
|
2194 </div> |
|
2195 |
|
2196 |
|
2197 <ul class="params-list"> |
|
2198 |
|
2199 <li class="param"> |
|
2200 |
|
2201 <code class="param-name">action</code> |
|
2202 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2203 |
|
2204 |
|
2205 <div class="param-description"> |
|
2206 <p>The sync action performed.</p> |
|
2207 </div> |
|
2208 |
|
2209 |
|
2210 </li> |
|
2211 |
|
2212 <li class="param"> |
|
2213 |
|
2214 <code class="param-name optional">[callback]</code> |
|
2215 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
2216 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
2217 |
|
2218 |
|
2219 <div class="param-description"> |
|
2220 <p>The function to call after syncing.</p> |
|
2221 </div> |
|
2222 |
|
2223 |
|
2224 </li> |
|
2225 |
|
2226 <li class="param"> |
|
2227 |
|
2228 <code class="param-name">url</code> |
|
2229 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2230 |
|
2231 |
|
2232 <div class="param-description"> |
|
2233 <p>The URL of the requested resource.</p> |
|
2234 </div> |
|
2235 |
|
2236 |
|
2237 </li> |
|
2238 |
|
2239 </ul> |
|
2240 |
|
2241 </li> |
|
2242 |
|
2243 </ul> |
|
2244 </div> |
|
2245 |
|
2246 |
|
2247 |
|
2248 |
|
2249 |
|
2250 </div> |
|
2251 |
|
2252 |
|
2253 <div id="method__onSyncIOStart" class="method item protected"> |
|
2254 <h3 class="name"><code>_onSyncIOStart</code></h3> |
|
2255 |
|
2256 |
|
2257 <div class="args"> |
|
2258 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2259 |
|
2260 <li class="arg"> |
|
2261 |
|
2262 <code>txId</code> |
|
2263 |
|
2264 </li> |
|
2265 |
|
2266 <li class="arg"> |
|
2267 |
|
2268 <code>details</code> |
|
2269 |
|
2270 </li> |
|
2271 |
|
2272 <li class="arg"> |
|
2273 |
|
2274 <code>detials.action</code> |
|
2275 |
|
2276 </li> |
|
2277 |
|
2278 </ul><span class="paren">)</span> |
|
2279 </div> |
|
2280 |
|
2281 |
|
2282 |
|
2283 |
|
2284 |
|
2285 |
|
2286 |
|
2287 <span class="flag protected">protected</span> |
|
2288 |
|
2289 |
|
2290 |
|
2291 |
|
2292 |
|
2293 |
|
2294 |
|
2295 |
|
2296 |
|
2297 |
|
2298 <div class="meta"> |
|
2299 |
|
2300 |
|
2301 |
|
2302 <p> |
|
2303 |
|
2304 Defined in |
|
2305 |
|
2306 |
|
2307 |
|
2308 |
|
2309 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l709"><code>app/js/model-extensions/model-sync-rest.js:709</code></a> |
|
2310 |
|
2311 </p> |
|
2312 |
|
2313 |
|
2314 |
|
2315 |
|
2316 |
|
2317 <p>Available since 3.6.0</p> |
|
2318 |
|
2319 </div> |
|
2320 |
|
2321 <div class="description"> |
|
2322 <p>Called when the <code>Y.io</code> request is made.</p> |
|
2323 |
|
2324 <p>This is a no-op by default, but provides a hook for overriding.</p> |
|
2325 </div> |
|
2326 |
|
2327 |
|
2328 <div class="params"> |
|
2329 <h4>Parameters:</h4> |
|
2330 |
|
2331 <ul class="params-list"> |
|
2332 |
|
2333 <li class="param"> |
|
2334 |
|
2335 <code class="param-name">txId</code> |
|
2336 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2337 |
|
2338 |
|
2339 |
|
2340 |
|
2341 <div class="param-description"> |
|
2342 <p>The <code>Y.io</code> transaction id.</p> |
|
2343 </div> |
|
2344 |
|
2345 |
|
2346 </li> |
|
2347 |
|
2348 <li class="param"> |
|
2349 |
|
2350 <code class="param-name">details</code> |
|
2351 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2352 |
|
2353 |
|
2354 |
|
2355 |
|
2356 <div class="param-description"> |
|
2357 <p>Extra details carried through from <code>sync()</code>:</p> |
|
2358 </div> |
|
2359 |
|
2360 |
|
2361 <ul class="params-list"> |
|
2362 |
|
2363 <li class="param"> |
|
2364 |
|
2365 <code class="param-name optional">[callback]</code> |
|
2366 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
2367 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
2368 |
|
2369 |
|
2370 <div class="param-description"> |
|
2371 <p>The function to call after syncing.</p> |
|
2372 </div> |
|
2373 |
|
2374 |
|
2375 </li> |
|
2376 |
|
2377 <li class="param"> |
|
2378 |
|
2379 <code class="param-name">url</code> |
|
2380 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2381 |
|
2382 |
|
2383 <div class="param-description"> |
|
2384 <p>The URL of the requested resource.</p> |
|
2385 </div> |
|
2386 |
|
2387 |
|
2388 </li> |
|
2389 |
|
2390 </ul> |
|
2391 |
|
2392 </li> |
|
2393 |
|
2394 <li class="param"> |
|
2395 |
|
2396 <code class="param-name">detials.action</code> |
|
2397 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2398 |
|
2399 |
|
2400 |
|
2401 |
|
2402 <div class="param-description"> |
|
2403 <p>The sync action performed.</p> |
|
2404 </div> |
|
2405 |
|
2406 |
|
2407 </li> |
|
2408 |
|
2409 </ul> |
|
2410 </div> |
|
2411 |
|
2412 |
|
2413 |
|
2414 |
|
2415 |
|
2416 </div> |
|
2417 |
|
2418 |
|
2419 <div id="method__onSyncIOSuccess" class="method item protected"> |
|
2420 <h3 class="name"><code>_onSyncIOSuccess</code></h3> |
|
2421 |
|
2422 |
|
2423 <div class="args"> |
|
2424 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2425 |
|
2426 <li class="arg"> |
|
2427 |
|
2428 <code>txId</code> |
|
2429 |
|
2430 </li> |
|
2431 |
|
2432 <li class="arg"> |
|
2433 |
|
2434 <code>res</code> |
|
2435 |
|
2436 </li> |
|
2437 |
|
2438 <li class="arg"> |
|
2439 |
|
2440 <code>details</code> |
|
2441 |
|
2442 </li> |
|
2443 |
|
2444 </ul><span class="paren">)</span> |
|
2445 </div> |
|
2446 |
|
2447 |
|
2448 |
|
2449 |
|
2450 |
|
2451 |
|
2452 |
|
2453 <span class="flag protected">protected</span> |
|
2454 |
|
2455 |
|
2456 |
|
2457 |
|
2458 |
|
2459 |
|
2460 |
|
2461 |
|
2462 |
|
2463 |
|
2464 <div class="meta"> |
|
2465 |
|
2466 |
|
2467 |
|
2468 <p> |
|
2469 |
|
2470 Defined in |
|
2471 |
|
2472 |
|
2473 |
|
2474 |
|
2475 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l685"><code>app/js/model-extensions/model-sync-rest.js:685</code></a> |
|
2476 |
|
2477 </p> |
|
2478 |
|
2479 |
|
2480 |
|
2481 |
|
2482 |
|
2483 <p>Available since 3.6.0</p> |
|
2484 |
|
2485 </div> |
|
2486 |
|
2487 <div class="description"> |
|
2488 <p>Called when the <code>Y.io</code> request has finished successfully.</p> |
|
2489 |
|
2490 <p>By default this calls the <code>details.callback</code> function passing it the |
|
2491 response body.</p> |
|
2492 </div> |
|
2493 |
|
2494 |
|
2495 <div class="params"> |
|
2496 <h4>Parameters:</h4> |
|
2497 |
|
2498 <ul class="params-list"> |
|
2499 |
|
2500 <li class="param"> |
|
2501 |
|
2502 <code class="param-name">txId</code> |
|
2503 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2504 |
|
2505 |
|
2506 |
|
2507 |
|
2508 <div class="param-description"> |
|
2509 <p>The <code>Y.io</code> transaction id.</p> |
|
2510 </div> |
|
2511 |
|
2512 |
|
2513 </li> |
|
2514 |
|
2515 <li class="param"> |
|
2516 |
|
2517 <code class="param-name">res</code> |
|
2518 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2519 |
|
2520 |
|
2521 |
|
2522 |
|
2523 <div class="param-description"> |
|
2524 <p>The <code>Y.io</code> response object.</p> |
|
2525 </div> |
|
2526 |
|
2527 |
|
2528 </li> |
|
2529 |
|
2530 <li class="param"> |
|
2531 |
|
2532 <code class="param-name">details</code> |
|
2533 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2534 |
|
2535 |
|
2536 |
|
2537 |
|
2538 <div class="param-description"> |
|
2539 <p>Extra details carried through from <code>sync()</code>:</p> |
|
2540 </div> |
|
2541 |
|
2542 |
|
2543 <ul class="params-list"> |
|
2544 |
|
2545 <li class="param"> |
|
2546 |
|
2547 <code class="param-name">action</code> |
|
2548 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2549 |
|
2550 |
|
2551 <div class="param-description"> |
|
2552 <p>The sync action performed.</p> |
|
2553 </div> |
|
2554 |
|
2555 |
|
2556 </li> |
|
2557 |
|
2558 <li class="param"> |
|
2559 |
|
2560 <code class="param-name optional">[callback]</code> |
|
2561 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
2562 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
2563 |
|
2564 |
|
2565 <div class="param-description"> |
|
2566 <p>The function to call after syncing.</p> |
|
2567 </div> |
|
2568 |
|
2569 |
|
2570 </li> |
|
2571 |
|
2572 <li class="param"> |
|
2573 |
|
2574 <code class="param-name">url</code> |
|
2575 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2576 |
|
2577 |
|
2578 <div class="param-description"> |
|
2579 <p>The URL of the requested resource.</p> |
|
2580 </div> |
|
2581 |
|
2582 |
|
2583 </li> |
|
2584 |
|
2585 </ul> |
|
2586 |
|
2587 </li> |
|
2588 |
|
2589 </ul> |
|
2590 </div> |
|
2591 |
|
2592 |
|
2593 |
|
2594 |
|
2595 |
|
2596 </div> |
|
2597 |
|
2598 |
|
2599 <div id="method__parse" class="method item protected"> |
|
2600 <h3 class="name"><code>_parse</code></h3> |
|
2601 |
|
2602 |
|
2603 <div class="args"> |
|
2604 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2605 |
|
2606 <li class="arg"> |
|
2607 |
|
2608 <code>response</code> |
|
2609 |
|
2610 </li> |
|
2611 |
|
2612 </ul><span class="paren">)</span> |
|
2613 </div> |
|
2614 |
|
2615 |
|
2616 |
|
2617 <span class="returns-inline"> |
|
2618 <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/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
2619 </span> |
|
2620 |
|
2621 |
|
2622 |
|
2623 |
|
2624 |
|
2625 <span class="flag protected">protected</span> |
|
2626 |
|
2627 |
|
2628 |
|
2629 |
|
2630 |
|
2631 |
|
2632 |
|
2633 |
|
2634 |
|
2635 |
|
2636 <div class="meta"> |
|
2637 |
|
2638 |
|
2639 |
|
2640 <p> |
|
2641 |
|
2642 Defined in |
|
2643 |
|
2644 |
|
2645 |
|
2646 |
|
2647 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l534"><code>app/js/model-extensions/model-sync-rest.js:534</code></a> |
|
2648 |
|
2649 </p> |
|
2650 |
|
2651 |
|
2652 |
|
2653 |
|
2654 |
|
2655 <p>Available since 3.7.0</p> |
|
2656 |
|
2657 </div> |
|
2658 |
|
2659 <div class="description"> |
|
2660 <p>Calls both public, overrideable methods: <code>parseIOResponse()</code>, then <code>parse()</code> |
|
2661 and returns the result.</p> |
|
2662 |
|
2663 <p>This will call into <code>parseIOResponse()</code>, if it's defined as a method, |
|
2664 passing it the full response object from the XHR and using its return value |
|
2665 to pass along to the <code>parse()</code>. This enables developers to easily parse data |
|
2666 out of the response headers which should be used by the <code>parse()</code> method.</p> |
|
2667 </div> |
|
2668 |
|
2669 |
|
2670 <div class="params"> |
|
2671 <h4>Parameters:</h4> |
|
2672 |
|
2673 <ul class="params-list"> |
|
2674 |
|
2675 <li class="param"> |
|
2676 |
|
2677 <code class="param-name">response</code> |
|
2678 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2679 |
|
2680 |
|
2681 |
|
2682 |
|
2683 <div class="param-description"> |
|
2684 <p>Response object from <code>Y.io()</code>.</p> |
|
2685 </div> |
|
2686 |
|
2687 |
|
2688 </li> |
|
2689 |
|
2690 </ul> |
|
2691 </div> |
|
2692 |
|
2693 |
|
2694 |
|
2695 <div class="returns"> |
|
2696 <h4>Returns:</h4> |
|
2697 |
|
2698 <div class="returns-description"> |
|
2699 |
|
2700 |
|
2701 <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/Object" class="crosslink external" target="_blank">Object[]</a></span>: |
|
2702 |
|
2703 Attribute hash or Array of model attribute hashes. |
|
2704 |
|
2705 </div> |
|
2706 </div> |
|
2707 |
|
2708 |
|
2709 |
|
2710 </div> |
|
2711 |
|
2712 |
|
2713 <div id="method__sendSyncIORequest" class="method item protected"> |
|
2714 <h3 class="name"><code>_sendSyncIORequest</code></h3> |
|
2715 |
|
2716 |
|
2717 <div class="args"> |
|
2718 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2719 |
|
2720 <li class="arg"> |
|
2721 |
|
2722 <code>config</code> |
|
2723 |
|
2724 </li> |
|
2725 |
|
2726 </ul><span class="paren">)</span> |
|
2727 </div> |
|
2728 |
|
2729 |
|
2730 |
|
2731 <span class="returns-inline"> |
|
2732 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2733 </span> |
|
2734 |
|
2735 |
|
2736 |
|
2737 |
|
2738 |
|
2739 <span class="flag protected">protected</span> |
|
2740 |
|
2741 |
|
2742 |
|
2743 |
|
2744 |
|
2745 |
|
2746 |
|
2747 |
|
2748 |
|
2749 |
|
2750 <div class="meta"> |
|
2751 |
|
2752 |
|
2753 |
|
2754 <p> |
|
2755 |
|
2756 Defined in |
|
2757 |
|
2758 |
|
2759 |
|
2760 |
|
2761 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l560"><code>app/js/model-extensions/model-sync-rest.js:560</code></a> |
|
2762 |
|
2763 </p> |
|
2764 |
|
2765 |
|
2766 |
|
2767 |
|
2768 |
|
2769 <p>Available since 3.6.0</p> |
|
2770 |
|
2771 </div> |
|
2772 |
|
2773 <div class="description"> |
|
2774 <p>Performs the XHR and returns the resulting <code>Y.io()</code> request object.</p> |
|
2775 |
|
2776 <p>This method is called by <code>sync()</code>.</p> |
|
2777 </div> |
|
2778 |
|
2779 |
|
2780 <div class="params"> |
|
2781 <h4>Parameters:</h4> |
|
2782 |
|
2783 <ul class="params-list"> |
|
2784 |
|
2785 <li class="param"> |
|
2786 |
|
2787 <code class="param-name">config</code> |
|
2788 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2789 |
|
2790 |
|
2791 |
|
2792 |
|
2793 <div class="param-description"> |
|
2794 <p>An object with the following properties:</p> |
|
2795 </div> |
|
2796 |
|
2797 |
|
2798 <ul class="params-list"> |
|
2799 |
|
2800 <li class="param"> |
|
2801 |
|
2802 <code class="param-name">action</code> |
|
2803 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2804 |
|
2805 |
|
2806 <div class="param-description"> |
|
2807 <p>The <code>sync()</code> action being performed.</p> |
|
2808 </div> |
|
2809 |
|
2810 |
|
2811 </li> |
|
2812 |
|
2813 <li class="param"> |
|
2814 |
|
2815 <code class="param-name optional">[callback]</code> |
|
2816 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
2817 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
2818 |
|
2819 |
|
2820 <div class="param-description"> |
|
2821 <p>Called when the sync operation |
|
2822 finishes.</p> |
|
2823 </div> |
|
2824 |
|
2825 |
|
2826 </li> |
|
2827 |
|
2828 <li class="param"> |
|
2829 |
|
2830 <code class="param-name optional">[entity]</code> |
|
2831 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2832 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
2833 |
|
2834 |
|
2835 <div class="param-description"> |
|
2836 <p>The HTTP request entity body.</p> |
|
2837 </div> |
|
2838 |
|
2839 |
|
2840 </li> |
|
2841 |
|
2842 <li class="param"> |
|
2843 |
|
2844 <code class="param-name">headers</code> |
|
2845 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2846 |
|
2847 |
|
2848 <div class="param-description"> |
|
2849 <p>The HTTP request headers.</p> |
|
2850 </div> |
|
2851 |
|
2852 |
|
2853 </li> |
|
2854 |
|
2855 <li class="param"> |
|
2856 |
|
2857 <code class="param-name">method</code> |
|
2858 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2859 |
|
2860 |
|
2861 <div class="param-description"> |
|
2862 <p>The HTTP request method.</p> |
|
2863 </div> |
|
2864 |
|
2865 |
|
2866 </li> |
|
2867 |
|
2868 <li class="param"> |
|
2869 |
|
2870 <code class="param-name optional">[timeout]</code> |
|
2871 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
2872 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
2873 |
|
2874 |
|
2875 <div class="param-description"> |
|
2876 <p>Time until the HTTP request is aborted.</p> |
|
2877 </div> |
|
2878 |
|
2879 |
|
2880 </li> |
|
2881 |
|
2882 <li class="param"> |
|
2883 |
|
2884 <code class="param-name">url</code> |
|
2885 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2886 |
|
2887 |
|
2888 <div class="param-description"> |
|
2889 <p>The URL of the HTTP resource.</p> |
|
2890 </div> |
|
2891 |
|
2892 |
|
2893 </li> |
|
2894 |
|
2895 </ul> |
|
2896 |
|
2897 </li> |
|
2898 |
|
2899 </ul> |
|
2900 </div> |
|
2901 |
|
2902 |
|
2903 |
|
2904 <div class="returns"> |
|
2905 <h4>Returns:</h4> |
|
2906 |
|
2907 <div class="returns-description"> |
|
2908 |
|
2909 |
|
2910 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
2911 |
|
2912 The resulting <code>Y.io()</code> request object. |
|
2913 |
|
2914 </div> |
|
2915 </div> |
|
2916 |
|
2917 |
|
2918 |
|
2919 </div> |
|
2920 |
|
2921 |
|
2922 <div id="method__substituteURL" class="method item protected"> |
|
2923 <h3 class="name"><code>_substituteURL</code></h3> |
|
2924 |
|
2925 |
|
2926 <div class="args"> |
|
2927 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2928 |
|
2929 <li class="arg"> |
|
2930 |
|
2931 <code>url</code> |
|
2932 |
|
2933 </li> |
|
2934 |
|
2935 <li class="arg"> |
|
2936 |
|
2937 <code>data</code> |
|
2938 |
|
2939 </li> |
|
2940 |
|
2941 </ul><span class="paren">)</span> |
|
2942 </div> |
|
2943 |
|
2944 |
|
2945 |
|
2946 <span class="returns-inline"> |
|
2947 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
2948 </span> |
|
2949 |
|
2950 |
|
2951 |
|
2952 |
|
2953 |
|
2954 <span class="flag protected">protected</span> |
|
2955 |
|
2956 |
|
2957 |
|
2958 |
|
2959 |
|
2960 |
|
2961 |
|
2962 |
|
2963 |
|
2964 |
|
2965 <div class="meta"> |
|
2966 |
|
2967 |
|
2968 |
|
2969 <p> |
|
2970 |
|
2971 Defined in |
|
2972 |
|
2973 |
|
2974 |
|
2975 |
|
2976 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l602"><code>app/js/model-extensions/model-sync-rest.js:602</code></a> |
|
2977 |
|
2978 </p> |
|
2979 |
|
2980 |
|
2981 |
|
2982 |
|
2983 |
|
2984 <p>Available since 3.6.0</p> |
|
2985 |
|
2986 </div> |
|
2987 |
|
2988 <div class="description"> |
|
2989 <p>Utility which takes a tokenized <code>url</code> string and substitutes its |
|
2990 placeholders using a specified <code>data</code> object.</p> |
|
2991 |
|
2992 <p>This method will property URL-encode any values before substituting them. |
|
2993 Also, only expect it to work with String and Number values.</p> |
|
2994 </div> |
|
2995 |
|
2996 |
|
2997 <div class="params"> |
|
2998 <h4>Parameters:</h4> |
|
2999 |
|
3000 <ul class="params-list"> |
|
3001 |
|
3002 <li class="param"> |
|
3003 |
|
3004 <code class="param-name">url</code> |
|
3005 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3006 |
|
3007 |
|
3008 |
|
3009 |
|
3010 <div class="param-description"> |
|
3011 <p>Tokenized URL string to substitute placeholder values.</p> |
|
3012 </div> |
|
3013 |
|
3014 |
|
3015 </li> |
|
3016 |
|
3017 <li class="param"> |
|
3018 |
|
3019 <code class="param-name">data</code> |
|
3020 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3021 |
|
3022 |
|
3023 |
|
3024 |
|
3025 <div class="param-description"> |
|
3026 <p>Set of data to fill in the <code>url</code>'s placeholders.</p> |
|
3027 </div> |
|
3028 |
|
3029 |
|
3030 </li> |
|
3031 |
|
3032 </ul> |
|
3033 </div> |
|
3034 |
|
3035 |
|
3036 |
|
3037 <div class="returns"> |
|
3038 <h4>Returns:</h4> |
|
3039 |
|
3040 <div class="returns-description"> |
|
3041 |
|
3042 |
|
3043 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
3044 |
|
3045 Substituted URL. |
|
3046 |
|
3047 </div> |
|
3048 </div> |
|
3049 |
|
3050 |
|
3051 |
|
3052 <div class="example"> |
|
3053 <h4>Example:</h4> |
|
3054 |
|
3055 <div class="example-content"> |
|
3056 <pre class="code prettyprint"><code>var url = this._substituteURL('/users/{name}', {id: 'Eric F'}); |
|
3057 // => "/users/Eric%20F" |
|
3058 </code></pre> |
|
3059 </div> |
|
3060 </div> |
|
3061 |
|
3062 </div> |
|
3063 |
|
3064 |
|
3065 <div id="method_getURL" class="method item"> |
|
3066 <h3 class="name"><code>getURL</code></h3> |
|
3067 |
|
3068 |
|
3069 <div class="args"> |
|
3070 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3071 |
|
3072 <li class="arg"> |
|
3073 |
|
3074 <code class="optional">[action]</code> |
|
3075 |
|
3076 </li> |
|
3077 |
|
3078 <li class="arg"> |
|
3079 |
|
3080 <code class="optional">[options]</code> |
|
3081 |
|
3082 </li> |
|
3083 |
|
3084 </ul><span class="paren">)</span> |
|
3085 </div> |
|
3086 |
|
3087 |
|
3088 |
|
3089 <span class="returns-inline"> |
|
3090 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3091 </span> |
|
3092 |
|
3093 |
|
3094 |
|
3095 |
|
3096 |
|
3097 |
|
3098 |
|
3099 |
|
3100 |
|
3101 |
|
3102 |
|
3103 |
|
3104 |
|
3105 |
|
3106 <div class="meta"> |
|
3107 |
|
3108 |
|
3109 |
|
3110 <p> |
|
3111 |
|
3112 Defined in |
|
3113 |
|
3114 |
|
3115 |
|
3116 |
|
3117 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l310"><code>app/js/model-extensions/model-sync-rest.js:310</code></a> |
|
3118 |
|
3119 </p> |
|
3120 |
|
3121 |
|
3122 |
|
3123 |
|
3124 |
|
3125 <p>Available since 3.6.0</p> |
|
3126 |
|
3127 </div> |
|
3128 |
|
3129 <div class="description"> |
|
3130 <p>Returns the URL for this model or model list for the given <code>action</code> and |
|
3131 <code>options</code>, if specified.</p> |
|
3132 |
|
3133 <p>This method correctly handles the variations of <code>root</code> and <code>url</code> values and |
|
3134 is called by the <code>sync()</code> method to get the URLs used to make the XHRs.</p> |
|
3135 |
|
3136 <p>You can override this method if you need to provide a specific |
|
3137 implementation for how the URLs of your Model and ModelList subclasses need |
|
3138 to be generated.</p> |
|
3139 </div> |
|
3140 |
|
3141 |
|
3142 <div class="params"> |
|
3143 <h4>Parameters:</h4> |
|
3144 |
|
3145 <ul class="params-list"> |
|
3146 |
|
3147 <li class="param"> |
|
3148 |
|
3149 <code class="param-name optional">[action]</code> |
|
3150 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3151 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
3152 |
|
3153 |
|
3154 |
|
3155 |
|
3156 <div class="param-description"> |
|
3157 <p>Optional <code>sync()</code> action for which to generate the |
|
3158 URL.</p> |
|
3159 </div> |
|
3160 |
|
3161 |
|
3162 </li> |
|
3163 |
|
3164 <li class="param"> |
|
3165 |
|
3166 <code class="param-name optional">[options]</code> |
|
3167 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3168 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
3169 |
|
3170 |
|
3171 |
|
3172 |
|
3173 <div class="param-description"> |
|
3174 <p>Optional options which may be used to help |
|
3175 generate the URL.</p> |
|
3176 </div> |
|
3177 |
|
3178 |
|
3179 </li> |
|
3180 |
|
3181 </ul> |
|
3182 </div> |
|
3183 |
|
3184 |
|
3185 |
|
3186 <div class="returns"> |
|
3187 <h4>Returns:</h4> |
|
3188 |
|
3189 <div class="returns-description"> |
|
3190 |
|
3191 |
|
3192 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
3193 |
|
3194 this model's or model list's URL for the the given |
|
3195 <code>action</code> and <code>options</code>. |
|
3196 |
|
3197 </div> |
|
3198 </div> |
|
3199 |
|
3200 |
|
3201 |
|
3202 </div> |
|
3203 |
|
3204 |
|
3205 <div id="method_parseIOResponse" class="method item"> |
|
3206 <h3 class="name"><code>parseIOResponse</code></h3> |
|
3207 |
|
3208 |
|
3209 <div class="args"> |
|
3210 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3211 |
|
3212 <li class="arg"> |
|
3213 |
|
3214 <code>response</code> |
|
3215 |
|
3216 </li> |
|
3217 |
|
3218 </ul><span class="paren">)</span> |
|
3219 </div> |
|
3220 |
|
3221 |
|
3222 |
|
3223 <span class="returns-inline"> |
|
3224 <span class="type">Any</span> |
|
3225 </span> |
|
3226 |
|
3227 |
|
3228 |
|
3229 |
|
3230 |
|
3231 |
|
3232 |
|
3233 |
|
3234 |
|
3235 |
|
3236 |
|
3237 |
|
3238 |
|
3239 |
|
3240 <div class="meta"> |
|
3241 |
|
3242 |
|
3243 |
|
3244 <p> |
|
3245 |
|
3246 Defined in |
|
3247 |
|
3248 |
|
3249 |
|
3250 |
|
3251 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l366"><code>app/js/model-extensions/model-sync-rest.js:366</code></a> |
|
3252 |
|
3253 </p> |
|
3254 |
|
3255 |
|
3256 |
|
3257 |
|
3258 |
|
3259 <p>Available since 3.7.0</p> |
|
3260 |
|
3261 </div> |
|
3262 |
|
3263 <div class="description"> |
|
3264 <p>Called to parse the response object returned from <code>Y.io()</code>. This method |
|
3265 receives the full response object and is expected to "prep" a response which |
|
3266 is suitable to pass to the <code>parse()</code> method.</p> |
|
3267 |
|
3268 <p>By default the response body is returned (<code>responseText</code>), because it |
|
3269 usually represents the entire entity of this model on the server.</p> |
|
3270 |
|
3271 <p>If you need to parse data out of the response's headers you should do so by |
|
3272 overriding this method. If you'd like the entire response object from the |
|
3273 XHR to be passed to your <code>parse()</code> method, you can simply assign this |
|
3274 property to <code>false</code>.</p> |
|
3275 </div> |
|
3276 |
|
3277 |
|
3278 <div class="params"> |
|
3279 <h4>Parameters:</h4> |
|
3280 |
|
3281 <ul class="params-list"> |
|
3282 |
|
3283 <li class="param"> |
|
3284 |
|
3285 <code class="param-name">response</code> |
|
3286 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3287 |
|
3288 |
|
3289 |
|
3290 |
|
3291 <div class="param-description"> |
|
3292 <p>Response object from <code>Y.io()</code>.</p> |
|
3293 </div> |
|
3294 |
|
3295 |
|
3296 </li> |
|
3297 |
|
3298 </ul> |
|
3299 </div> |
|
3300 |
|
3301 |
|
3302 |
|
3303 <div class="returns"> |
|
3304 <h4>Returns:</h4> |
|
3305 |
|
3306 <div class="returns-description"> |
|
3307 |
|
3308 |
|
3309 <span class="type">Any</span>: |
|
3310 |
|
3311 The modified response to pass along to the <code>parse()</code> method. |
|
3312 |
|
3313 </div> |
|
3314 </div> |
|
3315 |
|
3316 |
|
3317 |
|
3318 </div> |
|
3319 |
|
3320 |
|
3321 <div id="method_serialize" class="method item"> |
|
3322 <h3 class="name"><code>serialize</code></h3> |
|
3323 |
|
3324 |
|
3325 <div class="args"> |
|
3326 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3327 |
|
3328 <li class="arg"> |
|
3329 |
|
3330 <code class="optional">[action]</code> |
|
3331 |
|
3332 </li> |
|
3333 |
|
3334 </ul><span class="paren">)</span> |
|
3335 </div> |
|
3336 |
|
3337 |
|
3338 |
|
3339 <span class="returns-inline"> |
|
3340 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3341 </span> |
|
3342 |
|
3343 |
|
3344 |
|
3345 |
|
3346 |
|
3347 |
|
3348 |
|
3349 |
|
3350 |
|
3351 |
|
3352 |
|
3353 |
|
3354 |
|
3355 |
|
3356 <div class="meta"> |
|
3357 |
|
3358 |
|
3359 |
|
3360 <p> |
|
3361 |
|
3362 Defined in |
|
3363 |
|
3364 |
|
3365 |
|
3366 |
|
3367 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l388"><code>app/js/model-extensions/model-sync-rest.js:388</code></a> |
|
3368 |
|
3369 </p> |
|
3370 |
|
3371 |
|
3372 |
|
3373 |
|
3374 |
|
3375 <p>Available since 3.6.0</p> |
|
3376 |
|
3377 </div> |
|
3378 |
|
3379 <div class="description"> |
|
3380 <p>Serializes <code>this</code> model to be used as the HTTP request entity body.</p> |
|
3381 |
|
3382 <p>By default this model will be serialized to a JSON string via its <code>toJSON()</code> |
|
3383 method.</p> |
|
3384 |
|
3385 <p>You can override this method when the HTTP server expects a different |
|
3386 representation of this model's data that is different from the default JSON |
|
3387 serialization. If you're sending and receive content other than JSON, be |
|
3388 sure change the <code>Accept</code> and <code>Content-Type</code> <code>HTTP_HEADERS</code> as well.</p> |
|
3389 |
|
3390 <p><strong>Note:</strong> A model's <code>toJSON()</code> method can also be overridden. If you only |
|
3391 need to modify which attributes are serialized to JSON, that's a better |
|
3392 place to start.</p> |
|
3393 </div> |
|
3394 |
|
3395 |
|
3396 <div class="params"> |
|
3397 <h4>Parameters:</h4> |
|
3398 |
|
3399 <ul class="params-list"> |
|
3400 |
|
3401 <li class="param"> |
|
3402 |
|
3403 <code class="param-name optional">[action]</code> |
|
3404 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3405 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
3406 |
|
3407 |
|
3408 |
|
3409 |
|
3410 <div class="param-description"> |
|
3411 <p>Optional <code>sync()</code> action for which to generate the |
|
3412 the serialized representation of this model.</p> |
|
3413 </div> |
|
3414 |
|
3415 |
|
3416 </li> |
|
3417 |
|
3418 </ul> |
|
3419 </div> |
|
3420 |
|
3421 |
|
3422 |
|
3423 <div class="returns"> |
|
3424 <h4>Returns:</h4> |
|
3425 |
|
3426 <div class="returns-description"> |
|
3427 |
|
3428 |
|
3429 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
3430 |
|
3431 serialized HTTP request entity body. |
|
3432 |
|
3433 </div> |
|
3434 </div> |
|
3435 |
|
3436 |
|
3437 |
|
3438 </div> |
|
3439 |
|
3440 |
|
3441 <div id="method_sync" class="method item"> |
|
3442 <h3 class="name"><code>sync</code></h3> |
|
3443 |
|
3444 |
|
3445 <div class="args"> |
|
3446 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3447 |
|
3448 <li class="arg"> |
|
3449 |
|
3450 <code>action</code> |
|
3451 |
|
3452 </li> |
|
3453 |
|
3454 <li class="arg"> |
|
3455 |
|
3456 <code class="optional">[options]</code> |
|
3457 |
|
3458 </li> |
|
3459 |
|
3460 <li class="arg"> |
|
3461 |
|
3462 <code class="optional">[callback]</code> |
|
3463 |
|
3464 </li> |
|
3465 |
|
3466 </ul><span class="paren">)</span> |
|
3467 </div> |
|
3468 |
|
3469 |
|
3470 |
|
3471 |
|
3472 |
|
3473 |
|
3474 |
|
3475 |
|
3476 |
|
3477 |
|
3478 |
|
3479 |
|
3480 |
|
3481 |
|
3482 |
|
3483 |
|
3484 <div class="meta"> |
|
3485 |
|
3486 |
|
3487 |
|
3488 <p> |
|
3489 |
|
3490 Defined in |
|
3491 |
|
3492 |
|
3493 |
|
3494 |
|
3495 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l413"><code>app/js/model-extensions/model-sync-rest.js:413</code></a> |
|
3496 |
|
3497 </p> |
|
3498 |
|
3499 |
|
3500 |
|
3501 |
|
3502 |
|
3503 </div> |
|
3504 |
|
3505 <div class="description"> |
|
3506 <p>Communicates with a RESTful HTTP server by sending and receiving data via |
|
3507 XHRs. This method is called internally by load(), save(), and destroy().</p> |
|
3508 |
|
3509 <p>The URL used for each XHR will be retrieved by calling the <code>getURL()</code> method |
|
3510 and passing it the specified <code>action</code> and <code>options</code>.</p> |
|
3511 |
|
3512 <p>This method relies heavily on standard RESTful HTTP conventions</p> |
|
3513 </div> |
|
3514 |
|
3515 |
|
3516 <div class="params"> |
|
3517 <h4>Parameters:</h4> |
|
3518 |
|
3519 <ul class="params-list"> |
|
3520 |
|
3521 <li class="param"> |
|
3522 |
|
3523 <code class="param-name">action</code> |
|
3524 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3525 |
|
3526 |
|
3527 |
|
3528 |
|
3529 <div class="param-description"> |
|
3530 <p>Sync action to perform. May be one of the following:</p> |
|
3531 |
|
3532 <ul> |
|
3533 <li><code>create</code>: Store a newly-created model for the first time.</li> |
|
3534 <li><code>delete</code>: Delete an existing model.</li> |
|
3535 <li><code>read</code> : Load an existing model.</li> |
|
3536 <li><code>update</code>: Update an existing model.</li> |
|
3537 </ul> |
|
3538 </div> |
|
3539 |
|
3540 |
|
3541 </li> |
|
3542 |
|
3543 <li class="param"> |
|
3544 |
|
3545 <code class="param-name optional">[options]</code> |
|
3546 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3547 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
3548 |
|
3549 |
|
3550 |
|
3551 |
|
3552 <div class="param-description"> |
|
3553 <p>Sync options:</p> |
|
3554 </div> |
|
3555 |
|
3556 |
|
3557 <ul class="params-list"> |
|
3558 |
|
3559 <li class="param"> |
|
3560 |
|
3561 <code class="param-name optional">[csrfToken]</code> |
|
3562 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3563 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
3564 |
|
3565 |
|
3566 <div class="param-description"> |
|
3567 <p>The authenticity token used by the |
|
3568 server to verify the validity of this request and protected against CSRF |
|
3569 attacks. This overrides the default value provided by the static |
|
3570 <code>CSRF_TOKEN</code> property.</p> |
|
3571 </div> |
|
3572 |
|
3573 |
|
3574 </li> |
|
3575 |
|
3576 <li class="param"> |
|
3577 |
|
3578 <code class="param-name optional">[headers]</code> |
|
3579 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3580 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
3581 |
|
3582 |
|
3583 <div class="param-description"> |
|
3584 <p>The HTTP headers to mix with the default |
|
3585 headers specified by the static <code>HTTP_HEADERS</code> property.</p> |
|
3586 </div> |
|
3587 |
|
3588 |
|
3589 </li> |
|
3590 |
|
3591 <li class="param"> |
|
3592 |
|
3593 <code class="param-name optional">[timeout]</code> |
|
3594 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
3595 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
3596 |
|
3597 |
|
3598 <div class="param-description"> |
|
3599 <p>The number of milliseconds before the |
|
3600 request will timeout and be aborted. This overrides the default provided |
|
3601 by the static <code>HTTP_TIMEOUT</code> property.</p> |
|
3602 </div> |
|
3603 |
|
3604 |
|
3605 </li> |
|
3606 |
|
3607 </ul> |
|
3608 |
|
3609 </li> |
|
3610 |
|
3611 <li class="param"> |
|
3612 |
|
3613 <code class="param-name optional">[callback]</code> |
|
3614 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
3615 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
3616 |
|
3617 |
|
3618 |
|
3619 |
|
3620 <div class="param-description"> |
|
3621 <p>Called when the sync operation finishes.</p> |
|
3622 </div> |
|
3623 |
|
3624 |
|
3625 <ul class="params-list"> |
|
3626 |
|
3627 <li class="param"> |
|
3628 |
|
3629 <code class="param-name">err</code> |
|
3630 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span> |
|
3631 |
|
3632 |
|
3633 <div class="param-description"> |
|
3634 <p>If an error occurred, this parameter will |
|
3635 contain the error. If the sync operation succeeded, <em>err</em> will be |
|
3636 falsy.</p> |
|
3637 </div> |
|
3638 |
|
3639 |
|
3640 </li> |
|
3641 |
|
3642 <li class="param"> |
|
3643 |
|
3644 <code class="param-name optional">[response]</code> |
|
3645 <span class="type">Any</span> |
|
3646 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
3647 |
|
3648 |
|
3649 <div class="param-description"> |
|
3650 <p>The server's response.</p> |
|
3651 </div> |
|
3652 |
|
3653 |
|
3654 </li> |
|
3655 |
|
3656 </ul> |
|
3657 |
|
3658 </li> |
|
3659 |
|
3660 </ul> |
|
3661 </div> |
|
3662 |
|
3663 |
|
3664 |
|
3665 |
|
3666 |
|
3667 </div> |
|
3668 |
|
3669 |
|
3670 </div> |
|
3671 |
|
3672 |
|
3673 |
|
3674 <div id="properties" class="api-class-tabpanel"> |
|
3675 <h2 class="off-left">Properties</h2> |
|
3676 |
|
3677 |
|
3678 <div id="property__NON_ATTRS_CFG" class="property item protected"> |
|
3679 <h3 class="name"><code>_NON_ATTRS_CFG</code></h3> |
|
3680 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
3681 |
|
3682 |
|
3683 |
|
3684 |
|
3685 <span class="flag protected">protected</span> |
|
3686 |
|
3687 |
|
3688 |
|
3689 |
|
3690 |
|
3691 <span class="flag static">static</span> |
|
3692 |
|
3693 |
|
3694 <div class="meta"> |
|
3695 |
|
3696 |
|
3697 |
|
3698 <p> |
|
3699 |
|
3700 Defined in |
|
3701 |
|
3702 |
|
3703 |
|
3704 |
|
3705 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l155"><code>app/js/model-extensions/model-sync-rest.js:155</code></a> |
|
3706 |
|
3707 </p> |
|
3708 |
|
3709 |
|
3710 |
|
3711 |
|
3712 <p>Available since 3.6.0</p> |
|
3713 |
|
3714 </div> |
|
3715 |
|
3716 <div class="description"> |
|
3717 <p>Properties that shouldn't be turned into ad-hoc attributes when passed to a |
|
3718 Model or ModelList constructor.</p> |
|
3719 </div> |
|
3720 |
|
3721 |
|
3722 <p><strong>Default:</strong> ["root", "url"]</p> |
|
3723 |
|
3724 |
|
3725 |
|
3726 |
|
3727 |
|
3728 </div> |
|
3729 |
|
3730 |
|
3731 <div id="property_CSRF_TOKEN" class="property item"> |
|
3732 <h3 class="name"><code>CSRF_TOKEN</code></h3> |
|
3733 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3734 |
|
3735 |
|
3736 |
|
3737 |
|
3738 |
|
3739 |
|
3740 |
|
3741 |
|
3742 <span class="flag static">static</span> |
|
3743 |
|
3744 |
|
3745 <div class="meta"> |
|
3746 |
|
3747 |
|
3748 |
|
3749 <p> |
|
3750 |
|
3751 Defined in |
|
3752 |
|
3753 |
|
3754 |
|
3755 |
|
3756 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l48"><code>app/js/model-extensions/model-sync-rest.js:48</code></a> |
|
3757 |
|
3758 </p> |
|
3759 |
|
3760 |
|
3761 |
|
3762 |
|
3763 <p>Available since 3.6.0</p> |
|
3764 |
|
3765 </div> |
|
3766 |
|
3767 <div class="description"> |
|
3768 <p>A request authenticity token to validate HTTP requests made by this extension |
|
3769 with the server when the request results in changing persistent state. This |
|
3770 allows you to protect your server from Cross-Site Request Forgery attacks.</p> |
|
3771 |
|
3772 <p>A CSRF token provided by the server can be embedded in the HTML document and |
|
3773 assigned to <code>YUI.Env.CSRF_TOKEN</code> like this:</p> |
|
3774 |
|
3775 <pre class="code prettyprint"><code><script> |
|
3776 YUI.Env.CSRF_TOKEN = {{session.authenticityToken}}; |
|
3777 </script> |
|
3778 </code></pre> |
|
3779 |
|
3780 <p>The above should come after YUI seed file so that <code>YUI.Env</code> will be defined.</p> |
|
3781 |
|
3782 <p><strong>Note:</strong> This can be overridden on a per-request basis. See <code>sync()</code> method.</p> |
|
3783 |
|
3784 <p>When a value for the CSRF token is provided, either statically or via <code>options</code> |
|
3785 passed to the <code>save()</code> and <code>destroy()</code> methods, the applicable HTTP requests |
|
3786 will have a <code>X-CSRF-Token</code> header added with the token value.</p> |
|
3787 </div> |
|
3788 |
|
3789 |
|
3790 <p><strong>Default:</strong> YUI.Env.CSRF_TOKEN</p> |
|
3791 |
|
3792 |
|
3793 |
|
3794 |
|
3795 |
|
3796 </div> |
|
3797 |
|
3798 |
|
3799 <div id="property_EMULATE_HTTP" class="property item"> |
|
3800 <h3 class="name"><code>EMULATE_HTTP</code></h3> |
|
3801 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
3802 |
|
3803 |
|
3804 |
|
3805 |
|
3806 |
|
3807 |
|
3808 |
|
3809 |
|
3810 <span class="flag static">static</span> |
|
3811 |
|
3812 |
|
3813 <div class="meta"> |
|
3814 |
|
3815 |
|
3816 |
|
3817 <p> |
|
3818 |
|
3819 Defined in |
|
3820 |
|
3821 |
|
3822 |
|
3823 |
|
3824 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l76"><code>app/js/model-extensions/model-sync-rest.js:76</code></a> |
|
3825 |
|
3826 </p> |
|
3827 |
|
3828 |
|
3829 |
|
3830 |
|
3831 <p>Available since 3.6.0</p> |
|
3832 |
|
3833 </div> |
|
3834 |
|
3835 <div class="description"> |
|
3836 <p>Static flag to use the HTTP POST method instead of PUT or DELETE.</p> |
|
3837 |
|
3838 <p>If the server-side HTTP framework isn't RESTful, setting this flag to <code>true</code> |
|
3839 will cause all PUT and DELETE requests to instead use the POST HTTP method, and |
|
3840 add a <code>X-HTTP-Method-Override</code> HTTP header with the value of the method type |
|
3841 which was overridden.</p> |
|
3842 </div> |
|
3843 |
|
3844 |
|
3845 <p><strong>Default:</strong> false</p> |
|
3846 |
|
3847 |
|
3848 |
|
3849 |
|
3850 |
|
3851 </div> |
|
3852 |
|
3853 |
|
3854 <div id="property_HTTP_HEADERS" class="property item"> |
|
3855 <h3 class="name"><code>HTTP_HEADERS</code></h3> |
|
3856 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3857 |
|
3858 |
|
3859 |
|
3860 |
|
3861 |
|
3862 |
|
3863 |
|
3864 |
|
3865 <span class="flag static">static</span> |
|
3866 |
|
3867 |
|
3868 <div class="meta"> |
|
3869 |
|
3870 |
|
3871 |
|
3872 <p> |
|
3873 |
|
3874 Defined in |
|
3875 |
|
3876 |
|
3877 |
|
3878 |
|
3879 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l92"><code>app/js/model-extensions/model-sync-rest.js:92</code></a> |
|
3880 |
|
3881 </p> |
|
3882 |
|
3883 |
|
3884 |
|
3885 |
|
3886 <p>Available since 3.6.0</p> |
|
3887 |
|
3888 </div> |
|
3889 |
|
3890 <div class="description"> |
|
3891 <p>Default headers used with all XHRs.</p> |
|
3892 |
|
3893 <p>By default the <code>Accept</code> and <code>Content-Type</code> headers are set to |
|
3894 "application/json", this signals to the HTTP server to process the request |
|
3895 bodies as JSON and send JSON responses. If you're sending and receiving content |
|
3896 other than JSON, you can override these headers and the <code>parse()</code> and |
|
3897 <code>serialize()</code> methods.</p> |
|
3898 |
|
3899 <p><strong>Note:</strong> These headers will be merged with any request-specific headers, and |
|
3900 the request-specific headers will take precedence.</p> |
|
3901 </div> |
|
3902 |
|
3903 |
|
3904 <p><strong>Default:</strong> { |
|
3905 "Accept" : "application/json", |
|
3906 "Content-Type": "application/json" |
|
3907 }</p> |
|
3908 |
|
3909 |
|
3910 |
|
3911 |
|
3912 |
|
3913 </div> |
|
3914 |
|
3915 |
|
3916 <div id="property_HTTP_METHODS" class="property item"> |
|
3917 <h3 class="name"><code>HTTP_METHODS</code></h3> |
|
3918 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3919 |
|
3920 |
|
3921 |
|
3922 |
|
3923 |
|
3924 |
|
3925 |
|
3926 |
|
3927 <span class="flag static">static</span> |
|
3928 |
|
3929 |
|
3930 <div class="meta"> |
|
3931 |
|
3932 |
|
3933 |
|
3934 <p> |
|
3935 |
|
3936 Defined in |
|
3937 |
|
3938 |
|
3939 |
|
3940 |
|
3941 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l119"><code>app/js/model-extensions/model-sync-rest.js:119</code></a> |
|
3942 |
|
3943 </p> |
|
3944 |
|
3945 |
|
3946 |
|
3947 |
|
3948 <p>Available since 3.6.0</p> |
|
3949 |
|
3950 </div> |
|
3951 |
|
3952 <div class="description"> |
|
3953 <p>Static mapping of RESTful HTTP methods corresponding to CRUD actions.</p> |
|
3954 </div> |
|
3955 |
|
3956 |
|
3957 <p><strong>Default:</strong> { |
|
3958 "create": "POST", |
|
3959 "read" : "GET", |
|
3960 "update": "PUT", |
|
3961 "delete": "DELETE" |
|
3962 }</p> |
|
3963 |
|
3964 |
|
3965 |
|
3966 |
|
3967 |
|
3968 </div> |
|
3969 |
|
3970 |
|
3971 <div id="property_HTTP_TIMEOUT" class="property item"> |
|
3972 <h3 class="name"><code>HTTP_TIMEOUT</code></h3> |
|
3973 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
3974 |
|
3975 |
|
3976 |
|
3977 |
|
3978 |
|
3979 |
|
3980 |
|
3981 |
|
3982 <span class="flag static">static</span> |
|
3983 |
|
3984 |
|
3985 <div class="meta"> |
|
3986 |
|
3987 |
|
3988 |
|
3989 <p> |
|
3990 |
|
3991 Defined in |
|
3992 |
|
3993 |
|
3994 |
|
3995 |
|
3996 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l141"><code>app/js/model-extensions/model-sync-rest.js:141</code></a> |
|
3997 |
|
3998 </p> |
|
3999 |
|
4000 |
|
4001 |
|
4002 |
|
4003 <p>Available since 3.6.0</p> |
|
4004 |
|
4005 </div> |
|
4006 |
|
4007 <div class="description"> |
|
4008 <p>The number of milliseconds before the XHRs will timeout/abort. This defaults to |
|
4009 30 seconds.</p> |
|
4010 |
|
4011 <p><strong>Note:</strong> This can be overridden on a per-request basis. See <code>sync()</code> method.</p> |
|
4012 </div> |
|
4013 |
|
4014 |
|
4015 <p><strong>Default:</strong> 30000</p> |
|
4016 |
|
4017 |
|
4018 |
|
4019 |
|
4020 |
|
4021 </div> |
|
4022 |
|
4023 |
|
4024 <div id="property_root" class="property item"> |
|
4025 <h3 class="name"><code>root</code></h3> |
|
4026 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4027 |
|
4028 |
|
4029 |
|
4030 |
|
4031 |
|
4032 |
|
4033 |
|
4034 |
|
4035 |
|
4036 <div class="meta"> |
|
4037 |
|
4038 |
|
4039 |
|
4040 <p> |
|
4041 |
|
4042 Defined in |
|
4043 |
|
4044 |
|
4045 |
|
4046 |
|
4047 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l172"><code>app/js/model-extensions/model-sync-rest.js:172</code></a> |
|
4048 |
|
4049 </p> |
|
4050 |
|
4051 |
|
4052 |
|
4053 |
|
4054 <p>Available since 3.6.0</p> |
|
4055 |
|
4056 </div> |
|
4057 |
|
4058 <div class="description"> |
|
4059 <p>A string which represents the root or collection part of the URL which |
|
4060 relates to a Model or ModelList. Usually this value should be same for all |
|
4061 instances of a specific Model/ModelList subclass.</p> |
|
4062 |
|
4063 <p>When sub-classing <code>Y.Model</code>, usually you'll only need to override this |
|
4064 property, which lets the URLs for the XHRs be generated by convention. If |
|
4065 the <code>root</code> string ends with a trailing-slash, XHR URLs will also end with a |
|
4066 "/", and if the <code>root</code> does not end with a slash, neither will the XHR URLs.</p> |
|
4067 </div> |
|
4068 |
|
4069 |
|
4070 <p><strong>Default:</strong> ""</p> |
|
4071 |
|
4072 |
|
4073 |
|
4074 <div class="example"> |
|
4075 <h4>Example:</h4> |
|
4076 |
|
4077 <div class="example-content"> |
|
4078 <pre class="code prettyprint"><code>Y.User = Y.Base.create('user', Y.Model, [Y.ModelSync.REST], { |
|
4079 root: '/users' |
|
4080 }); |
|
4081 |
|
4082 var currentUser, newUser; |
|
4083 |
|
4084 // GET the user data from: "/users/123" |
|
4085 currentUser = new Y.User({id: '123'}).load(); |
|
4086 |
|
4087 // POST the new user data to: "/users" |
|
4088 newUser = new Y.User({name: 'Eric Ferraiuolo'}).save(); |
|
4089 </code></pre> |
|
4090 |
|
4091 <p>When sub-classing <code>Y.ModelList</code>, usually you'll want to ignore configuring |
|
4092 the <code>root</code> and simply rely on the build-in convention of the list's |
|
4093 generated URLs defaulting to the <code>root</code> specified by the list's <code>model</code>.</p> |
|
4094 </div> |
|
4095 </div> |
|
4096 |
|
4097 |
|
4098 |
|
4099 </div> |
|
4100 |
|
4101 |
|
4102 <div id="property_url" class="property item"> |
|
4103 <h3 class="name"><code>url</code></h3> |
|
4104 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4105 |
|
4106 |
|
4107 |
|
4108 |
|
4109 |
|
4110 |
|
4111 |
|
4112 |
|
4113 |
|
4114 <div class="meta"> |
|
4115 |
|
4116 |
|
4117 |
|
4118 <p> |
|
4119 |
|
4120 Defined in |
|
4121 |
|
4122 |
|
4123 |
|
4124 |
|
4125 <a href="../files/app_js_model-extensions_model-sync-rest.js.html#l206"><code>app/js/model-extensions/model-sync-rest.js:206</code></a> |
|
4126 |
|
4127 </p> |
|
4128 |
|
4129 |
|
4130 |
|
4131 |
|
4132 <p>Available since 3.6.0</p> |
|
4133 |
|
4134 </div> |
|
4135 |
|
4136 <div class="description"> |
|
4137 <p>A string which specifies the URL to use when making XHRs, if not value is |
|
4138 provided, the URLs used to make XHRs will be generated by convention.</p> |
|
4139 |
|
4140 <p>While a <code>url</code> can be provided for each Model/ModelList instance, usually |
|
4141 you'll want to either rely on the default convention or provide a tokenized |
|
4142 string on the prototype which can be used for all instances.</p> |
|
4143 |
|
4144 <p>When sub-classing <code>Y.Model</code>, you will probably be able to rely on the |
|
4145 default convention of generating URLs in conjunction with the <code>root</code> |
|
4146 property and whether the model is new or not (i.e. has an <code>id</code>). If the |
|
4147 <code>root</code> property ends with a trailing-slash, the generated URL for the |
|
4148 specific model will also end with a trailing-slash.</p> |
|
4149 </div> |
|
4150 |
|
4151 |
|
4152 <p><strong>Default:</strong> ""</p> |
|
4153 |
|
4154 |
|
4155 |
|
4156 <div class="example"> |
|
4157 <h4>Example:</h4> |
|
4158 |
|
4159 <div class="example-content"> |
|
4160 <pre class="code prettyprint"><code>Y.User = Y.Base.create('user', Y.Model, [Y.ModelSync.REST], { |
|
4161 root: '/users/' |
|
4162 }); |
|
4163 |
|
4164 var currentUser, newUser; |
|
4165 |
|
4166 // GET the user data from: "/users/123/" |
|
4167 currentUser = new Y.User({id: '123'}).load(); |
|
4168 |
|
4169 // POST the new user data to: "/users/" |
|
4170 newUser = new Y.User({name: 'Eric Ferraiuolo'}).save(); |
|
4171 </code></pre> |
|
4172 |
|
4173 <p>If a <code>url</code> is specified, it will be processed by <code>Y.Lang.sub()</code>, which is |
|
4174 useful when the URLs for a Model/ModelList subclass match a specific pattern |
|
4175 and can use simple replacement tokens; e.g.:</p><pre class="code prettyprint"><code>Y.User = Y.Base.create('user', Y.Model, [Y.ModelSync.REST], { |
|
4176 root: '/users', |
|
4177 url : '/users/{username}' |
|
4178 }); |
|
4179 </code></pre> |
|
4180 |
|
4181 <p><strong>Note:</strong> String subsitituion of the <code>url</code> only use string an number values |
|
4182 provided by this object's attribute and/or the <code>options</code> passed to the |
|
4183 <code>getURL()</code> method. Do not expect something fancy to happen with Object, |
|
4184 Array, or Boolean values, they will simply be ignored.</p> |
|
4185 |
|
4186 <p>If your URLs have plural roots or collection URLs, while the specific item |
|
4187 resources are under a singular name, e.g. "/users" (plural) and "/user/123" |
|
4188 (singular), you'll probably want to configure the <code>root</code> and <code>url</code> |
|
4189 properties like this:</p><pre class="code prettyprint"><code>Y.User = Y.Base.create('user', Y.Model, [Y.ModelSync.REST], { |
|
4190 root: '/users', |
|
4191 url : '/user/{id}' |
|
4192 }); |
|
4193 |
|
4194 var currentUser, newUser; |
|
4195 |
|
4196 // GET the user data from: "/user/123" |
|
4197 currentUser = new Y.User({id: '123'}).load(); |
|
4198 |
|
4199 // POST the new user data to: "/users" |
|
4200 newUser = new Y.User({name: 'Eric Ferraiuolo'}).save(); |
|
4201 </code></pre> |
|
4202 |
|
4203 <p>When sub-classing <code>Y.ModelList</code>, usually you'll be able to rely on the |
|
4204 associated <code>model</code> to supply its <code>root</code> to be used as the model list's URL. |
|
4205 If this needs to be customized, you can provide a simple string for the |
|
4206 <code>url</code> property.</p><pre class="code prettyprint"><code>Y.Users = Y.Base.create('users', Y.ModelList, [Y.ModelSync.REST], { |
|
4207 // Leverages <code>Y.User</code>'s <code>root</code>, which is "/users". |
|
4208 model: Y.User |
|
4209 }); |
|
4210 |
|
4211 // Or specified explicitly... |
|
4212 |
|
4213 Y.Users = Y.Base.create('users', Y.ModelList, [Y.ModelSync.REST], { |
|
4214 model: Y.User, |
|
4215 url : '/users' |
|
4216 }); |
|
4217 </code></pre> |
|
4218 </div> |
|
4219 </div> |
|
4220 |
|
4221 |
|
4222 |
|
4223 </div> |
|
4224 |
|
4225 |
|
4226 </div> |
|
4227 |
|
4228 |
|
4229 |
|
4230 |
|
4231 |
|
4232 </div> |
|
4233 </div> |
|
4234 |
|
4235 </div> |
|
4236 </div> |
|
4237 </div> |
|
4238 </div> |
|
4239 </div> |
|
4240 </div> |
|
4241 <script src="../assets/vendor/prettify/prettify-min.js"></script> |
|
4242 <script>prettyPrint();</script> |
|
4243 <script src="../assets/js/yui-prettify.js"></script> |
|
4244 <script src="../assets/../api.js"></script> |
|
4245 <script src="../assets/js/api-filter.js"></script> |
|
4246 <script src="../assets/js/api-list.js"></script> |
|
4247 <script src="../assets/js/api-search.js"></script> |
|
4248 <script src="../assets/js/apidocs.js"></script> |
|
4249 </body> |
|
4250 </html> |