5
<title>IO - YUI 3</title>
6
<link rel="stylesheet" href="http://yui.yahooapis.com/3.5.0pr4/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
<script src="http://yui.yahooapis.com/3.5.0pr4/build/yui/yui-min.js"></script>
11
<body class="yui3-skin-sam">
14
<div id="hd" class="yui3-g header">
15
<div class="yui3-u-3-4">
17
<h1><img src="../assets/css/logo.png" title="YUI 3"></h1>
20
<div class="yui3-u-1-4 version">
21
<em>API Docs for: 3.5.0</em>
24
<div id="bd" class="yui3-g">
26
<div class="yui3-u-1-4">
27
<div id="docs-sidebar" class="sidebar apidocs">
29
<h2 class="off-left">APIs</h2>
30
<div id="api-tabview" class="tabview">
32
<li><a href="#api-classes">Classes</a></li>
33
<li><a href="#api-modules">Modules</a></li>
36
<div id="api-tabview-filter">
37
<input type="search" id="api-filter" placeholder="Type to filter APIs">
40
<div id="api-tabview-panel">
41
<ul id="api-classes" class="apis classes">
43
<li><a href="../classes/Anim.html">Anim</a></li>
45
<li><a href="../classes/App.html">App</a></li>
47
<li><a href="../classes/App.Base.html">App.Base</a></li>
49
<li><a href="../classes/App.Transitions.html">App.Transitions</a></li>
51
<li><a href="../classes/App.TransitionsNative.html">App.TransitionsNative</a></li>
53
<li><a href="../classes/AreaSeries.html">AreaSeries</a></li>
55
<li><a href="../classes/AreaSplineSeries.html">AreaSplineSeries</a></li>
57
<li><a href="../classes/Array.html">Array</a></li>
59
<li><a href="../classes/ArrayList.html">ArrayList</a></li>
61
<li><a href="../classes/ArraySort.html">ArraySort</a></li>
63
<li><a href="../classes/AsyncQueue.html">AsyncQueue</a></li>
65
<li><a href="../classes/Attribute.html">Attribute</a></li>
67
<li><a href="../classes/AttributeCore.html">AttributeCore</a></li>
69
<li><a href="../classes/AttributeEvents.html">AttributeEvents</a></li>
71
<li><a href="../classes/AttributeExtras.html">AttributeExtras</a></li>
73
<li><a href="../classes/AttributeLite.html">AttributeLite</a></li>
75
<li><a href="../classes/AutoComplete.html">AutoComplete</a></li>
77
<li><a href="../classes/AutoCompleteBase.html">AutoCompleteBase</a></li>
79
<li><a href="../classes/AutoCompleteFilters.html">AutoCompleteFilters</a></li>
81
<li><a href="../classes/AutoCompleteHighlighters.html">AutoCompleteHighlighters</a></li>
83
<li><a href="../classes/AutoCompleteList.html">AutoCompleteList</a></li>
85
<li><a href="../classes/Axis.html">Axis</a></li>
87
<li><a href="../classes/AxisType.html">AxisType</a></li>
89
<li><a href="../classes/BarSeries.html">BarSeries</a></li>
91
<li><a href="../classes/Base.html">Base</a></li>
93
<li><a href="../classes/BaseCore.html">BaseCore</a></li>
95
<li><a href="../classes/BottomAxisLayout.html">BottomAxisLayout</a></li>
97
<li><a href="../classes/Button.html">Button</a></li>
99
<li><a href="../classes/ButtonCore.html">ButtonCore</a></li>
101
<li><a href="../classes/ButtonGroup.html">ButtonGroup</a></li>
103
<li><a href="../classes/ButtonPlugin.html">ButtonPlugin</a></li>
105
<li><a href="../classes/Cache.html">Cache</a></li>
107
<li><a href="../classes/CacheOffline.html">CacheOffline</a></li>
109
<li><a href="../classes/Calendar.html">Calendar</a></li>
111
<li><a href="../classes/CalendarBase.html">CalendarBase</a></li>
113
<li><a href="../classes/CanvasCircle.html">CanvasCircle</a></li>
115
<li><a href="../classes/CanvasDrawing.html">CanvasDrawing</a></li>
117
<li><a href="../classes/CanvasEllipse.html">CanvasEllipse</a></li>
119
<li><a href="../classes/CanvasGraphic.html">CanvasGraphic</a></li>
121
<li><a href="../classes/CanvasPath.html">CanvasPath</a></li>
123
<li><a href="../classes/CanvasPieSlice.html">CanvasPieSlice</a></li>
125
<li><a href="../classes/CanvasRect.html">CanvasRect</a></li>
127
<li><a href="../classes/CanvasShape.html">CanvasShape</a></li>
129
<li><a href="../classes/CartesianChart.html">CartesianChart</a></li>
131
<li><a href="../classes/CartesianSeries.html">CartesianSeries</a></li>
133
<li><a href="../classes/CategoryAxis.html">CategoryAxis</a></li>
135
<li><a href="../classes/Chart.html">Chart</a></li>
137
<li><a href="../classes/ChartBase.html">ChartBase</a></li>
139
<li><a href="../classes/ChartLegend.html">ChartLegend</a></li>
141
<li><a href="../classes/Circle.html">Circle</a></li>
143
<li><a href="../classes/ClassNameManager.html">ClassNameManager</a></li>
145
<li><a href="../classes/ClickableRail.html">ClickableRail</a></li>
147
<li><a href="../classes/ColumnSeries.html">ColumnSeries</a></li>
149
<li><a href="../classes/ComboSeries.html">ComboSeries</a></li>
151
<li><a href="../classes/ComboSplineSeries.html">ComboSplineSeries</a></li>
153
<li><a href="../classes/config.html">config</a></li>
155
<li><a href="../classes/Console.html">Console</a></li>
157
<li><a href="../classes/Controller.html">Controller</a></li>
159
<li><a href="../classes/Cookie.html">Cookie</a></li>
161
<li><a href="../classes/CurveUtil.html">CurveUtil</a></li>
163
<li><a href="../classes/CustomEvent.html">CustomEvent</a></li>
165
<li><a href="../classes/DataSchema.Array.html">DataSchema.Array</a></li>
167
<li><a href="../classes/DataSchema.Base.html">DataSchema.Base</a></li>
169
<li><a href="../classes/DataSchema.JSON.html">DataSchema.JSON</a></li>
171
<li><a href="../classes/DataSchema.Text.html">DataSchema.Text</a></li>
173
<li><a href="../classes/DataSchema.XML.html">DataSchema.XML</a></li>
175
<li><a href="../classes/DataSource.Function.html">DataSource.Function</a></li>
177
<li><a href="../classes/DataSource.Get.html">DataSource.Get</a></li>
179
<li><a href="../classes/DataSource.IO.html">DataSource.IO</a></li>
181
<li><a href="../classes/DataSource.Local.html">DataSource.Local</a></li>
183
<li><a href="../classes/DataSourceArraySchema.html">DataSourceArraySchema</a></li>
185
<li><a href="../classes/DataSourceCache.html">DataSourceCache</a></li>
187
<li><a href="../classes/DataSourceCacheExtension.html">DataSourceCacheExtension</a></li>
189
<li><a href="../classes/DataSourceJSONSchema.html">DataSourceJSONSchema</a></li>
191
<li><a href="../classes/DataSourceTextSchema.html">DataSourceTextSchema</a></li>
193
<li><a href="../classes/DataSourceXMLSchema.html">DataSourceXMLSchema</a></li>
195
<li><a href="../classes/DataTable.html">DataTable</a></li>
197
<li><a href="../classes/DataTable.Base.html">DataTable.Base</a></li>
199
<li><a href="../classes/DataTable.BodyView.html">DataTable.BodyView</a></li>
201
<li><a href="../classes/DataTable.ColumnWidths.html">DataTable.ColumnWidths</a></li>
203
<li><a href="../classes/DataTable.Core.html">DataTable.Core</a></li>
205
<li><a href="../classes/DataTable.HeaderView.html">DataTable.HeaderView</a></li>
207
<li><a href="../classes/DataTable.Message.html">DataTable.Message</a></li>
209
<li><a href="../classes/DataTable.Mutable.html">DataTable.Mutable</a></li>
211
<li><a href="../classes/DataTable.Scrollable.html">DataTable.Scrollable</a></li>
213
<li><a href="../classes/DataTable.Sortable.html">DataTable.Sortable</a></li>
215
<li><a href="../classes/DataType.Date.html">DataType.Date</a></li>
217
<li><a href="../classes/DataType.Date.Locale.html">DataType.Date.Locale</a></li>
219
<li><a href="../classes/DataType.Number.html">DataType.Number</a></li>
221
<li><a href="../classes/DataType.XML.html">DataType.XML</a></li>
223
<li><a href="../classes/DD.DDM.html">DD.DDM</a></li>
225
<li><a href="../classes/DD.Delegate.html">DD.Delegate</a></li>
227
<li><a href="../classes/DD.Drag.html">DD.Drag</a></li>
229
<li><a href="../classes/DD.Drop.html">DD.Drop</a></li>
231
<li><a href="../classes/DD.Plugin.DDWindowScroll.html">DD.Plugin.DDWindowScroll</a></li>
233
<li><a href="../classes/DD.Scroll.html">DD.Scroll</a></li>
235
<li><a href="../classes/Dial.html">Dial</a></li>
237
<li><a href="../classes/Do.html">Do</a></li>
239
<li><a href="../classes/Do.AlterArgs.html">Do.AlterArgs</a></li>
241
<li><a href="../classes/Do.AlterReturn.html">Do.AlterReturn</a></li>
243
<li><a href="../classes/Do.Error.html">Do.Error</a></li>
245
<li><a href="../classes/Do.Halt.html">Do.Halt</a></li>
247
<li><a href="../classes/Do.Method.html">Do.Method</a></li>
249
<li><a href="../classes/Do.Prevent.html">Do.Prevent</a></li>
251
<li><a href="../classes/DOM.html">DOM</a></li>
253
<li><a href="../classes/DOMEventFacade.html">DOMEventFacade</a></li>
255
<li><a href="../classes/Drawing.html">Drawing</a></li>
257
<li><a href="../classes/Easing.html">Easing</a></li>
259
<li><a href="../classes/EditorBase.html">EditorBase</a></li>
261
<li><a href="../classes/EditorSelection.html">EditorSelection</a></li>
263
<li><a href="../classes/Ellipse.html">Ellipse</a></li>
265
<li><a href="../classes/EllipseGroup.html">EllipseGroup</a></li>
267
<li><a href="../classes/Escape.html">Escape</a></li>
269
<li><a href="../classes/Event.html">Event</a></li>
271
<li><a href="../classes/EventFacade.html">EventFacade</a></li>
273
<li><a href="../classes/EventHandle.html">EventHandle</a></li>
275
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
277
<li><a href="../classes/ExecCommand.html">ExecCommand</a></li>
279
<li><a href="../classes/Features.html">Features</a></li>
281
<li><a href="../classes/File.html">File</a></li>
283
<li><a href="../classes/FileFlash.html">FileFlash</a></li>
285
<li><a href="../classes/FileHTML5.html">FileHTML5</a></li>
287
<li><a href="../classes/Fills.html">Fills</a></li>
289
<li><a href="../classes/Frame.html">Frame</a></li>
291
<li><a href="../classes/Get.html">Get</a></li>
293
<li><a href="../classes/Get.Transaction.html">Get.Transaction</a></li>
295
<li><a href="../classes/GetNodeJS.html">GetNodeJS</a></li>
297
<li><a href="../classes/Graph.html">Graph</a></li>
299
<li><a href="../classes/Graphic.html">Graphic</a></li>
301
<li><a href="../classes/GraphicBase.html">GraphicBase</a></li>
303
<li><a href="../classes/Gridlines.html">Gridlines</a></li>
305
<li><a href="../classes/GroupCircle.html">GroupCircle</a></li>
307
<li><a href="../classes/GroupDiamond.html">GroupDiamond</a></li>
309
<li><a href="../classes/GroupRect.html">GroupRect</a></li>
311
<li><a href="../classes/Handlebars.html">Handlebars</a></li>
313
<li><a href="../classes/Highlight.html">Highlight</a></li>
315
<li><a href="../classes/Histogram.html">Histogram</a></li>
317
<li><a href="../classes/HistoryBase.html">HistoryBase</a></li>
319
<li><a href="../classes/HistoryHash.html">HistoryHash</a></li>
321
<li><a href="../classes/HistoryHTML5.html">HistoryHTML5</a></li>
323
<li><a href="../classes/HorizontalLegendLayout.html">HorizontalLegendLayout</a></li>
325
<li><a href="../classes/ImgLoadGroup.html">ImgLoadGroup</a></li>
327
<li><a href="../classes/ImgLoadImgObj.html">ImgLoadImgObj</a></li>
329
<li><a href="../classes/Intl.html">Intl</a></li>
331
<li><a href="../classes/IO.html">IO</a></li>
333
<li><a href="../classes/json.html">json</a></li>
335
<li><a href="../classes/JSONPRequest.html">JSONPRequest</a></li>
337
<li><a href="../classes/Lang.html">Lang</a></li>
339
<li><a href="../classes/LeftAxisLayout.html">LeftAxisLayout</a></li>
341
<li><a href="../classes/Lines.html">Lines</a></li>
343
<li><a href="../classes/LineSeries.html">LineSeries</a></li>
345
<li><a href="../classes/Loader.html">Loader</a></li>
347
<li><a href="../classes/MarkerSeries.html">MarkerSeries</a></li>
349
<li><a href="../classes/Matrix.html">Matrix</a></li>
351
<li><a href="../classes/Model.html">Model</a></li>
353
<li><a href="../classes/ModelList.html">ModelList</a></li>
355
<li><a href="../classes/Node.html">Node</a></li>
357
<li><a href="../classes/NodeList.html">NodeList</a></li>
359
<li><a href="../classes/NumericAxis.html">NumericAxis</a></li>
361
<li><a href="../classes/Object.html">Object</a></li>
363
<li><a href="../classes/Overlay.html">Overlay</a></li>
365
<li><a href="../classes/Panel.html">Panel</a></li>
367
<li><a href="../classes/Parallel.html">Parallel</a></li>
369
<li><a href="../classes/Path.html">Path</a></li>
371
<li><a href="../classes/PieChart.html">PieChart</a></li>
373
<li><a href="../classes/PieSeries.html">PieSeries</a></li>
375
<li><a href="../classes/Pjax.html">Pjax</a></li>
377
<li><a href="../classes/PjaxBase.html">PjaxBase</a></li>
379
<li><a href="../classes/Plots.html">Plots</a></li>
381
<li><a href="../classes/Plugin.Align.html">Plugin.Align</a></li>
383
<li><a href="../classes/Plugin.AutoComplete.html">Plugin.AutoComplete</a></li>
385
<li><a href="../classes/Plugin.Base.html">Plugin.Base</a></li>
387
<li><a href="../classes/Plugin.Cache.html">Plugin.Cache</a></li>
389
<li><a href="../classes/Plugin.CalendarNavigator.html">Plugin.CalendarNavigator</a></li>
391
<li><a href="../classes/Plugin.ConsoleFilters.html">Plugin.ConsoleFilters</a></li>
393
<li><a href="../classes/Plugin.CreateLinkBase.html">Plugin.CreateLinkBase</a></li>
395
<li><a href="../classes/Plugin.DataTableDataSource.html">Plugin.DataTableDataSource</a></li>
397
<li><a href="../classes/Plugin.DDConstrained.html">Plugin.DDConstrained</a></li>
399
<li><a href="../classes/Plugin.DDNodeScroll.html">Plugin.DDNodeScroll</a></li>
401
<li><a href="../classes/Plugin.DDProxy.html">Plugin.DDProxy</a></li>
403
<li><a href="../classes/Plugin.Drag.html">Plugin.Drag</a></li>
405
<li><a href="../classes/Plugin.Drop.html">Plugin.Drop</a></li>
407
<li><a href="../classes/Plugin.EditorBidi.html">Plugin.EditorBidi</a></li>
409
<li><a href="../classes/Plugin.EditorBR.html">Plugin.EditorBR</a></li>
411
<li><a href="../classes/Plugin.EditorLists.html">Plugin.EditorLists</a></li>
413
<li><a href="../classes/Plugin.EditorPara.html">Plugin.EditorPara</a></li>
415
<li><a href="../classes/Plugin.EditorParaBase.html">Plugin.EditorParaBase</a></li>
417
<li><a href="../classes/Plugin.EditorParaIE.html">Plugin.EditorParaIE</a></li>
419
<li><a href="../classes/Plugin.EditorTab.html">Plugin.EditorTab</a></li>
421
<li><a href="../classes/Plugin.ExecCommand.html">Plugin.ExecCommand</a></li>
423
<li><a href="../classes/Plugin.Flick.html">Plugin.Flick</a></li>
425
<li><a href="../classes/Plugin.Host.html">Plugin.Host</a></li>
427
<li><a href="../classes/plugin.NodeFocusManager.html">plugin.NodeFocusManager</a></li>
429
<li><a href="../classes/Plugin.NodeFX.html">Plugin.NodeFX</a></li>
431
<li><a href="../classes/plugin.NodeMenuNav.html">plugin.NodeMenuNav</a></li>
433
<li><a href="../classes/Plugin.Pjax.html">Plugin.Pjax</a></li>
435
<li><a href="../classes/Plugin.Resize.html">Plugin.Resize</a></li>
437
<li><a href="../classes/Plugin.ResizeConstrained.html">Plugin.ResizeConstrained</a></li>
439
<li><a href="../classes/Plugin.ResizeProxy.html">Plugin.ResizeProxy</a></li>
441
<li><a href="../classes/Plugin.ScrollViewList.html">Plugin.ScrollViewList</a></li>
443
<li><a href="../classes/Plugin.ScrollViewPaginator.html">Plugin.ScrollViewPaginator</a></li>
445
<li><a href="../classes/Plugin.ScrollViewScrollbars.html">Plugin.ScrollViewScrollbars</a></li>
447
<li><a href="../classes/Plugin.Shim.html">Plugin.Shim</a></li>
449
<li><a href="../classes/Plugin.SortScroll.html">Plugin.SortScroll</a></li>
451
<li><a href="../classes/Plugin.WidgetAnim.html">Plugin.WidgetAnim</a></li>
453
<li><a href="../classes/Pollable.html">Pollable</a></li>
455
<li><a href="../classes/Profiler.html">Profiler</a></li>
457
<li><a href="../classes/QueryString.html">QueryString</a></li>
459
<li><a href="../classes/Queue.html">Queue</a></li>
461
<li><a href="../classes/Record.html">Record</a></li>
463
<li><a href="../classes/Recordset.html">Recordset</a></li>
465
<li><a href="../classes/RecordsetFilter.html">RecordsetFilter</a></li>
467
<li><a href="../classes/RecordsetIndexer.html">RecordsetIndexer</a></li>
469
<li><a href="../classes/RecordsetSort.html">RecordsetSort</a></li>
471
<li><a href="../classes/Rect.html">Rect</a></li>
473
<li><a href="../classes/Renderer.html">Renderer</a></li>
475
<li><a href="../classes/Resize.html">Resize</a></li>
477
<li><a href="../classes/RightAxisLayout.html">RightAxisLayout</a></li>
479
<li><a href="../classes/Router.html">Router</a></li>
481
<li><a href="../classes/ScrollView.html">ScrollView</a></li>
483
<li><a href="../classes/Selector.html">Selector</a></li>
485
<li><a href="../classes/Shape.html">Shape</a></li>
487
<li><a href="../classes/ShapeGroup.html">ShapeGroup</a></li>
489
<li><a href="../classes/Slider.html">Slider</a></li>
491
<li><a href="../classes/SliderBase.html">SliderBase</a></li>
493
<li><a href="../classes/SliderValueRange.html">SliderValueRange</a></li>
495
<li><a href="../classes/Sortable.html">Sortable</a></li>
497
<li><a href="../classes/SplineSeries.html">SplineSeries</a></li>
499
<li><a href="../classes/StackedAreaSeries.html">StackedAreaSeries</a></li>
501
<li><a href="../classes/StackedAreaSplineSeries.html">StackedAreaSplineSeries</a></li>
503
<li><a href="../classes/StackedAxis.html">StackedAxis</a></li>
505
<li><a href="../classes/StackedBarSeries.html">StackedBarSeries</a></li>
507
<li><a href="../classes/StackedColumnSeries.html">StackedColumnSeries</a></li>
509
<li><a href="../classes/StackedComboSeries.html">StackedComboSeries</a></li>
511
<li><a href="../classes/StackedComboSplineSeries.html">StackedComboSplineSeries</a></li>
513
<li><a href="../classes/StackedLineSeries.html">StackedLineSeries</a></li>
515
<li><a href="../classes/StackedMarkerSeries.html">StackedMarkerSeries</a></li>
517
<li><a href="../classes/StackedSplineSeries.html">StackedSplineSeries</a></li>
519
<li><a href="../classes/StackingUtil.html">StackingUtil</a></li>
521
<li><a href="../classes/State.html">State</a></li>
523
<li><a href="../classes/StyleSheet.html">StyleSheet</a></li>
525
<li><a href="../classes/Subscriber.html">Subscriber</a></li>
527
<li><a href="../classes/SVGCircle.html">SVGCircle</a></li>
529
<li><a href="../classes/SVGDrawing.html">SVGDrawing</a></li>
531
<li><a href="../classes/SVGEllipse.html">SVGEllipse</a></li>
533
<li><a href="../classes/SVGGraphic.html">SVGGraphic</a></li>
535
<li><a href="../classes/SVGPath.html">SVGPath</a></li>
537
<li><a href="../classes/SVGPieSlice.html">SVGPieSlice</a></li>
539
<li><a href="../classes/SVGRect.html">SVGRect</a></li>
541
<li><a href="../classes/SVGShape.html">SVGShape</a></li>
543
<li><a href="../classes/SWF.html">SWF</a></li>
545
<li><a href="../classes/SWFDetect.html">SWFDetect</a></li>
547
<li><a href="../classes/SyntheticEvent.html">SyntheticEvent</a></li>
549
<li><a href="../classes/SyntheticEvent.Notifier.html">SyntheticEvent.Notifier</a></li>
551
<li><a href="../classes/SynthRegistry.html">SynthRegistry</a></li>
553
<li><a href="../classes/Tab.html">Tab</a></li>
555
<li><a href="../classes/TabView.html">TabView</a></li>
557
<li><a href="../classes/Test.html">Test</a></li>
559
<li><a href="../classes/Test.ArrayAssert.html">Test.ArrayAssert</a></li>
561
<li><a href="../classes/Test.Assert.html">Test.Assert</a></li>
563
<li><a href="../classes/Test.AssertionError.html">Test.AssertionError</a></li>
565
<li><a href="../classes/Test.ComparisonFailure.html">Test.ComparisonFailure</a></li>
567
<li><a href="../classes/Test.Console.html">Test.Console</a></li>
569
<li><a href="../classes/Test.CoverageFormat.CoverageFormat.html">Test.CoverageFormat.CoverageFormat</a></li>
571
<li><a href="../classes/Test.DateAssert.html">Test.DateAssert</a></li>
573
<li><a href="../classes/Test.EventTarget.html">Test.EventTarget</a></li>
575
<li><a href="../classes/Test.Mock.Mock.html">Test.Mock.Mock</a></li>
577
<li><a href="../classes/Test.Mock.Value.html">Test.Mock.Value</a></li>
579
<li><a href="../classes/Test.ObjectAssert.html">Test.ObjectAssert</a></li>
581
<li><a href="../classes/Test.Reporter.html">Test.Reporter</a></li>
583
<li><a href="../classes/Test.Results.html">Test.Results</a></li>
585
<li><a href="../classes/Test.Runner.html">Test.Runner</a></li>
587
<li><a href="../classes/Test.ShouldError.html">Test.ShouldError</a></li>
589
<li><a href="../classes/Test.ShouldFail.html">Test.ShouldFail</a></li>
591
<li><a href="../classes/Test.TestCase.html">Test.TestCase</a></li>
593
<li><a href="../classes/Test.TestFormat.html">Test.TestFormat</a></li>
595
<li><a href="../classes/Test.TestNode.html">Test.TestNode</a></li>
597
<li><a href="../classes/Test.TestRunner.html">Test.TestRunner</a></li>
599
<li><a href="../classes/Test.TestSuite.html">Test.TestSuite</a></li>
601
<li><a href="../classes/Test.UnexpectedError.html">Test.UnexpectedError</a></li>
603
<li><a href="../classes/Test.UnexpectedValue.html">Test.UnexpectedValue</a></li>
605
<li><a href="../classes/Test.Wait.html">Test.Wait</a></li>
607
<li><a href="../classes/Text.AccentFold.html">Text.AccentFold</a></li>
609
<li><a href="../classes/Text.WordBreak.html">Text.WordBreak</a></li>
611
<li><a href="../classes/TimeAxis.html">TimeAxis</a></li>
613
<li><a href="../classes/ToggleButton.html">ToggleButton</a></li>
615
<li><a href="../classes/TopAxisLayout.html">TopAxisLayout</a></li>
617
<li><a href="../classes/Transition.html">Transition</a></li>
619
<li><a href="../classes/UA.html">UA</a></li>
621
<li><a href="../classes/Uploader.html">Uploader</a></li>
623
<li><a href="../classes/Uploader.Queue.html">Uploader.Queue</a></li>
625
<li><a href="../classes/UploaderFlash.html">UploaderFlash</a></li>
627
<li><a href="../classes/UploaderHTML5.html">UploaderHTML5</a></li>
629
<li><a href="../classes/ValueChange.html">ValueChange</a></li>
631
<li><a href="../classes/VerticalLegendLayout.html">VerticalLegendLayout</a></li>
633
<li><a href="../classes/View.html">View</a></li>
635
<li><a href="../classes/View.NodeMap.html">View.NodeMap</a></li>
637
<li><a href="../classes/VMLCircle.html">VMLCircle</a></li>
639
<li><a href="../classes/VMLDrawing.html">VMLDrawing</a></li>
641
<li><a href="../classes/VMLEllipse.html">VMLEllipse</a></li>
643
<li><a href="../classes/VMLGraphic.html">VMLGraphic</a></li>
645
<li><a href="../classes/VMLPath.html">VMLPath</a></li>
647
<li><a href="../classes/VMLPieSlice.html">VMLPieSlice</a></li>
649
<li><a href="../classes/VMLRect.html">VMLRect</a></li>
651
<li><a href="../classes/VMLShape.html">VMLShape</a></li>
653
<li><a href="../classes/Widget.html">Widget</a></li>
655
<li><a href="../classes/WidgetAutohide.html">WidgetAutohide</a></li>
657
<li><a href="../classes/WidgetButtons.html">WidgetButtons</a></li>
659
<li><a href="../classes/WidgetChild.html">WidgetChild</a></li>
661
<li><a href="../classes/WidgetModality.html">WidgetModality</a></li>
663
<li><a href="../classes/WidgetParent.html">WidgetParent</a></li>
665
<li><a href="../classes/WidgetPosition.html">WidgetPosition</a></li>
667
<li><a href="../classes/WidgetPositionAlign.html">WidgetPositionAlign</a></li>
669
<li><a href="../classes/WidgetPositionConstrain.html">WidgetPositionConstrain</a></li>
671
<li><a href="../classes/WidgetStack.html">WidgetStack</a></li>
673
<li><a href="../classes/WidgetStdMod.html">WidgetStdMod</a></li>
675
<li><a href="../classes/YQL.html">YQL</a></li>
677
<li><a href="../classes/YQLRequest.html">YQLRequest</a></li>
679
<li><a href="../classes/YUI.html">YUI</a></li>
681
<li><a href="../classes/YUI~substitute.html">YUI~substitute</a></li>
685
<ul id="api-modules" class="apis modules">
687
<li><a href="../modules/align-plugin.html">align-plugin</a></li>
689
<li><a href="../modules/anim.html">anim</a></li>
691
<li><a href="../modules/anim-base.html">anim-base</a></li>
693
<li><a href="../modules/anim-color.html">anim-color</a></li>
695
<li><a href="../modules/anim-curve.html">anim-curve</a></li>
697
<li><a href="../modules/anim-easing.html">anim-easing</a></li>
699
<li><a href="../modules/anim-node-plugin.html">anim-node-plugin</a></li>
701
<li><a href="../modules/anim-scroll.html">anim-scroll</a></li>
703
<li><a href="../modules/anim-xy.html">anim-xy</a></li>
705
<li><a href="../modules/app.html">app</a></li>
707
<li><a href="../modules/app-base.html">app-base</a></li>
709
<li><a href="../modules/app-transitions.html">app-transitions</a></li>
711
<li><a href="../modules/app-transitions-native.html">app-transitions-native</a></li>
713
<li><a href="../modules/array-extras.html">array-extras</a></li>
715
<li><a href="../modules/array-invoke.html">array-invoke</a></li>
717
<li><a href="../modules/arraylist.html">arraylist</a></li>
719
<li><a href="../modules/arraylist-add.html">arraylist-add</a></li>
721
<li><a href="../modules/arraylist-filter.html">arraylist-filter</a></li>
723
<li><a href="../modules/arraysort.html">arraysort</a></li>
725
<li><a href="../modules/async-queue.html">async-queue</a></li>
727
<li><a href="../modules/attribute.html">attribute</a></li>
729
<li><a href="../modules/attribute-base.html">attribute-base</a></li>
731
<li><a href="../modules/attribute-complex.html">attribute-complex</a></li>
733
<li><a href="../modules/attribute-core.html">attribute-core</a></li>
735
<li><a href="../modules/attribute-events.html">attribute-events</a></li>
737
<li><a href="../modules/attribute-extras.html">attribute-extras</a></li>
739
<li><a href="../modules/autocomplete.html">autocomplete</a></li>
741
<li><a href="../modules/autocomplete-base.html">autocomplete-base</a></li>
743
<li><a href="../modules/autocomplete-filters.html">autocomplete-filters</a></li>
745
<li><a href="../modules/autocomplete-filters-accentfold.html">autocomplete-filters-accentfold</a></li>
747
<li><a href="../modules/autocomplete-highlighters.html">autocomplete-highlighters</a></li>
749
<li><a href="../modules/autocomplete-highlighters-accentfold.html">autocomplete-highlighters-accentfold</a></li>
751
<li><a href="../modules/autocomplete-list.html">autocomplete-list</a></li>
753
<li><a href="../modules/autocomplete-list-keys.html">autocomplete-list-keys</a></li>
755
<li><a href="../modules/autocomplete-plugin.html">autocomplete-plugin</a></li>
757
<li><a href="../modules/autocomplete-sources.html">autocomplete-sources</a></li>
759
<li><a href="../modules/base.html">base</a></li>
761
<li><a href="../modules/base-base.html">base-base</a></li>
763
<li><a href="../modules/base-build.html">base-build</a></li>
765
<li><a href="../modules/base-core.html">base-core</a></li>
767
<li><a href="../modules/base-pluginhost.html">base-pluginhost</a></li>
769
<li><a href="../modules/button.html">button</a></li>
771
<li><a href="../modules/button-core.html">button-core</a></li>
773
<li><a href="../modules/button-group.html">button-group</a></li>
775
<li><a href="../modules/button-plugin.html">button-plugin</a></li>
777
<li><a href="../modules/cache.html">cache</a></li>
779
<li><a href="../modules/cache-base.html">cache-base</a></li>
781
<li><a href="../modules/cache-offline.html">cache-offline</a></li>
783
<li><a href="../modules/cache-plugin.html">cache-plugin</a></li>
785
<li><a href="../modules/calendar.html">calendar</a></li>
787
<li><a href="../modules/calendar-base.html">calendar-base</a></li>
789
<li><a href="../modules/calendarnavigator.html">calendarnavigator</a></li>
791
<li><a href="../modules/charts.html">charts</a></li>
793
<li><a href="../modules/charts-legend.html">charts-legend</a></li>
795
<li><a href="../modules/classnamemanager.html">classnamemanager</a></li>
797
<li><a href="../modules/clickable-rail.html">clickable-rail</a></li>
799
<li><a href="../modules/collection.html">collection</a></li>
801
<li><a href="../modules/console.html">console</a></li>
803
<li><a href="../modules/console-filters.html">console-filters</a></li>
805
<li><a href="../modules/cookie.html">cookie</a></li>
807
<li><a href="../modules/createlink-base.html">createlink-base</a></li>
809
<li><a href="../modules/dataschema.html">dataschema</a></li>
811
<li><a href="../modules/dataschema-array.html">dataschema-array</a></li>
813
<li><a href="../modules/dataschema-base.html">dataschema-base</a></li>
815
<li><a href="../modules/dataschema-json.html">dataschema-json</a></li>
817
<li><a href="../modules/dataschema-text.html">dataschema-text</a></li>
819
<li><a href="../modules/dataschema-xml.html">dataschema-xml</a></li>
821
<li><a href="../modules/datasource.html">datasource</a></li>
823
<li><a href="../modules/datasource-arrayschema.html">datasource-arrayschema</a></li>
825
<li><a href="../modules/datasource-cache.html">datasource-cache</a></li>
827
<li><a href="../modules/datasource-function.html">datasource-function</a></li>
829
<li><a href="../modules/datasource-get.html">datasource-get</a></li>
831
<li><a href="../modules/datasource-io.html">datasource-io</a></li>
833
<li><a href="../modules/datasource-jsonschema.html">datasource-jsonschema</a></li>
835
<li><a href="../modules/datasource-local.html">datasource-local</a></li>
837
<li><a href="../modules/datasource-polling.html">datasource-polling</a></li>
839
<li><a href="../modules/datasource-textschema.html">datasource-textschema</a></li>
841
<li><a href="../modules/datasource-xmlschema.html">datasource-xmlschema</a></li>
843
<li><a href="../modules/datatable.html">datatable</a></li>
845
<li><a href="../modules/datatable-base.html">datatable-base</a></li>
847
<li><a href="../modules/datatable-base-deprecated.html">datatable-base-deprecated</a></li>
849
<li><a href="../modules/datatable-body.html">datatable-body</a></li>
851
<li><a href="../modules/datatable-column-widths.html">datatable-column-widths</a></li>
853
<li><a href="../modules/datatable-core.html">datatable-core</a></li>
855
<li><a href="../modules/datatable-datasource.html">datatable-datasource</a></li>
857
<li><a href="../modules/datatable-datasource-deprecated.html">datatable-datasource-deprecated</a></li>
859
<li><a href="../modules/datatable-deprecated.html">datatable-deprecated</a></li>
861
<li><a href="../modules/datatable-head.html">datatable-head</a></li>
863
<li><a href="../modules/datatable-message.html">datatable-message</a></li>
865
<li><a href="../modules/datatable-mutable.html">datatable-mutable</a></li>
867
<li><a href="../modules/datatable-scroll.html">datatable-scroll</a></li>
869
<li><a href="../modules/datatable-scroll-deprecated.html">datatable-scroll-deprecated</a></li>
871
<li><a href="../modules/datatable-sort.html">datatable-sort</a></li>
873
<li><a href="../modules/datatable-sort-deprecated.html">datatable-sort-deprecated</a></li>
875
<li><a href="../modules/datatype.html">datatype</a></li>
877
<li><a href="../modules/datatype-date.html">datatype-date</a></li>
879
<li><a href="../modules/datatype-date-format.html">datatype-date-format</a></li>
881
<li><a href="../modules/datatype-date-math.html">datatype-date-math</a></li>
883
<li><a href="../modules/datatype-date-parse.html">datatype-date-parse</a></li>
885
<li><a href="../modules/datatype-number.html">datatype-number</a></li>
887
<li><a href="../modules/datatype-number-format.html">datatype-number-format</a></li>
889
<li><a href="../modules/datatype-number-parse.html">datatype-number-parse</a></li>
891
<li><a href="../modules/datatype-xml.html">datatype-xml</a></li>
893
<li><a href="../modules/datatype-xml-format.html">datatype-xml-format</a></li>
895
<li><a href="../modules/datatype-xml-parse.html">datatype-xml-parse</a></li>
897
<li><a href="../modules/dd.html">dd</a></li>
899
<li><a href="../modules/dd-constrain.html">dd-constrain</a></li>
901
<li><a href="../modules/dd-ddm.html">dd-ddm</a></li>
903
<li><a href="../modules/dd-ddm-base.html">dd-ddm-base</a></li>
905
<li><a href="../modules/dd-ddm-drop.html">dd-ddm-drop</a></li>
907
<li><a href="../modules/dd-delegate.html">dd-delegate</a></li>
909
<li><a href="../modules/dd-drag.html">dd-drag</a></li>
911
<li><a href="../modules/dd-drop.html">dd-drop</a></li>
913
<li><a href="../modules/dd-drop-plugin.html">dd-drop-plugin</a></li>
915
<li><a href="../modules/dd-plugin.html">dd-plugin</a></li>
917
<li><a href="../modules/dd-proxy.html">dd-proxy</a></li>
919
<li><a href="../modules/dd-scroll.html">dd-scroll</a></li>
921
<li><a href="../modules/dial.html">dial</a></li>
923
<li><a href="../modules/dom.html">dom</a></li>
925
<li><a href="../modules/dom-base.html">dom-base</a></li>
927
<li><a href="../modules/dom-screen.html">dom-screen</a></li>
929
<li><a href="../modules/dom-style.html">dom-style</a></li>
931
<li><a href="../modules/dump.html">dump</a></li>
933
<li><a href="../modules/editor.html">editor</a></li>
935
<li><a href="../modules/editor-base.html">editor-base</a></li>
937
<li><a href="../modules/editor-bidi.html">editor-bidi</a></li>
939
<li><a href="../modules/editor-br.html">editor-br</a></li>
941
<li><a href="../modules/editor-lists.html">editor-lists</a></li>
943
<li><a href="../modules/editor-para.html">editor-para</a></li>
945
<li><a href="../modules/editor-para-base.html">editor-para-base</a></li>
947
<li><a href="../modules/editor-para-ie.html">editor-para-ie</a></li>
949
<li><a href="../modules/editor-tab.html">editor-tab</a></li>
951
<li><a href="../modules/escape.html">escape</a></li>
953
<li><a href="../modules/event.html">event</a></li>
955
<li><a href="../modules/event-base.html">event-base</a></li>
957
<li><a href="../modules/event-contextmenu.html">event-contextmenu</a></li>
959
<li><a href="../modules/event-custom.html">event-custom</a></li>
961
<li><a href="../modules/event-custom-base.html">event-custom-base</a></li>
963
<li><a href="../modules/event-custom-complex.html">event-custom-complex</a></li>
965
<li><a href="../modules/event-delegate.html">event-delegate</a></li>
967
<li><a href="../modules/event-flick.html">event-flick</a></li>
969
<li><a href="../modules/event-focus.html">event-focus</a></li>
971
<li><a href="../modules/event-gestures.html">event-gestures</a></li>
973
<li><a href="../modules/event-hover.html">event-hover</a></li>
975
<li><a href="../modules/event-key.html">event-key</a></li>
977
<li><a href="../modules/event-mouseenter.html">event-mouseenter</a></li>
979
<li><a href="../modules/event-mousewheel.html">event-mousewheel</a></li>
981
<li><a href="../modules/event-move.html">event-move</a></li>
983
<li><a href="../modules/event-outside.html">event-outside</a></li>
985
<li><a href="../modules/event-resize.html">event-resize</a></li>
987
<li><a href="../modules/event-simulate.html">event-simulate</a></li>
989
<li><a href="../modules/event-synthetic.html">event-synthetic</a></li>
991
<li><a href="../modules/event-touch.html">event-touch</a></li>
993
<li><a href="../modules/event-valuechange.html">event-valuechange</a></li>
995
<li><a href="../modules/exec-command.html">exec-command</a></li>
997
<li><a href="../modules/features.html">features</a></li>
999
<li><a href="../modules/file.html">file</a></li>
1001
<li><a href="../modules/file-flash.html">file-flash</a></li>
1003
<li><a href="../modules/file-html5.html">file-html5</a></li>
1005
<li><a href="../modules/frame.html">frame</a></li>
1007
<li><a href="../modules/get.html">get</a></li>
1009
<li><a href="../modules/get-nodejs.html">get-nodejs</a></li>
1011
<li><a href="../modules/graphics.html">graphics</a></li>
1013
<li><a href="../modules/handlebars.html">handlebars</a></li>
1015
<li><a href="../modules/handlebars-base.html">handlebars-base</a></li>
1017
<li><a href="../modules/handlebars-compiler.html">handlebars-compiler</a></li>
1019
<li><a href="../modules/highlight.html">highlight</a></li>
1021
<li><a href="../modules/highlight-accentfold.html">highlight-accentfold</a></li>
1023
<li><a href="../modules/highlight-base.html">highlight-base</a></li>
1025
<li><a href="../modules/history.html">history</a></li>
1027
<li><a href="../modules/history-base.html">history-base</a></li>
1029
<li><a href="../modules/history-hash.html">history-hash</a></li>
1031
<li><a href="../modules/history-hash-ie.html">history-hash-ie</a></li>
1033
<li><a href="../modules/history-html5.html">history-html5</a></li>
1035
<li><a href="../modules/imageloader.html">imageloader</a></li>
1037
<li><a href="../modules/intl.html">intl</a></li>
1039
<li><a href="../modules/io.html">io</a></li>
1041
<li><a href="../modules/io-base.html">io-base</a></li>
1043
<li><a href="../modules/io-form.html">io-form</a></li>
1045
<li><a href="../modules/io-queue.html">io-queue</a></li>
1047
<li><a href="../modules/io-upload-iframe.html">io-upload-iframe</a></li>
1049
<li><a href="../modules/io-xdr.html">io-xdr</a></li>
1051
<li><a href="../modules/json.html">json</a></li>
1053
<li><a href="../modules/json-parse.html">json-parse</a></li>
1055
<li><a href="../modules/json-stringify.html">json-stringify</a></li>
1057
<li><a href="../modules/jsonp.html">jsonp</a></li>
1059
<li><a href="../modules/jsonp-url.html">jsonp-url</a></li>
1061
<li><a href="../modules/loader.html">loader</a></li>
1063
<li><a href="../modules/loader-base.html">loader-base</a></li>
1065
<li><a href="../modules/matrix.html">matrix</a></li>
1067
<li><a href="../modules/model.html">model</a></li>
1069
<li><a href="../modules/model-list.html">model-list</a></li>
1071
<li><a href="../modules/node.html">node</a></li>
1073
<li><a href="../modules/node-base.html">node-base</a></li>
1075
<li><a href="../modules/node-core.html">node-core</a></li>
1077
<li><a href="../modules/node-data.html">node-data</a></li>
1079
<li><a href="../modules/node-deprecated.html">node-deprecated</a></li>
1081
<li><a href="../modules/node-event-delegate.html">node-event-delegate</a></li>
1083
<li><a href="../modules/node-event-html5.html">node-event-html5</a></li>
1085
<li><a href="../modules/node-event-simulate.html">node-event-simulate</a></li>
1087
<li><a href="../modules/node-flick.html">node-flick</a></li>
1089
<li><a href="../modules/node-focusmanager.html">node-focusmanager</a></li>
1091
<li><a href="../modules/node-load.html">node-load</a></li>
1093
<li><a href="../modules/node-menunav.html">node-menunav</a></li>
1095
<li><a href="../modules/node-pluginhost.html">node-pluginhost</a></li>
1097
<li><a href="../modules/node-screen.html">node-screen</a></li>
1099
<li><a href="../modules/node-style.html">node-style</a></li>
1101
<li><a href="../modules/oop.html">oop</a></li>
1103
<li><a href="../modules/overlay.html">overlay</a></li>
1105
<li><a href="../modules/panel.html">panel</a></li>
1107
<li><a href="../modules/parallel.html">parallel</a></li>
1109
<li><a href="../modules/pjax.html">pjax</a></li>
1111
<li><a href="../modules/pjax-base.html">pjax-base</a></li>
1113
<li><a href="../modules/pjax-plugin.html">pjax-plugin</a></li>
1115
<li><a href="../modules/plugin.html">plugin</a></li>
1117
<li><a href="../modules/pluginhost.html">pluginhost</a></li>
1119
<li><a href="../modules/pluginhost-base.html">pluginhost-base</a></li>
1121
<li><a href="../modules/pluginhost-config.html">pluginhost-config</a></li>
1123
<li><a href="../modules/profiler.html">profiler</a></li>
1125
<li><a href="../modules/querystring.html">querystring</a></li>
1127
<li><a href="../modules/querystring-parse.html">querystring-parse</a></li>
1129
<li><a href="../modules/querystring-parse-simple.html">querystring-parse-simple</a></li>
1131
<li><a href="../modules/querystring-stringify.html">querystring-stringify</a></li>
1133
<li><a href="../modules/querystring-stringify-simple.html">querystring-stringify-simple</a></li>
1135
<li><a href="../modules/queue-promote.html">queue-promote</a></li>
1137
<li><a href="../modules/range-slider.html">range-slider</a></li>
1139
<li><a href="../modules/recordset.html">recordset</a></li>
1141
<li><a href="../modules/recordset-base.html">recordset-base</a></li>
1143
<li><a href="../modules/recordset-filter.html">recordset-filter</a></li>
1145
<li><a href="../modules/recordset-indexer.html">recordset-indexer</a></li>
1147
<li><a href="../modules/recordset-sort.html">recordset-sort</a></li>
1149
<li><a href="../modules/resize.html">resize</a></li>
1151
<li><a href="../modules/resize-contrain.html">resize-contrain</a></li>
1153
<li><a href="../modules/resize-plugin.html">resize-plugin</a></li>
1155
<li><a href="../modules/resize-proxy.html">resize-proxy</a></li>
1157
<li><a href="../modules/rollup.html">rollup</a></li>
1159
<li><a href="../modules/router.html">router</a></li>
1161
<li><a href="../modules/scrollview.html">scrollview</a></li>
1163
<li><a href="../modules/scrollview-base.html">scrollview-base</a></li>
1165
<li><a href="../modules/scrollview-base-ie.html">scrollview-base-ie</a></li>
1167
<li><a href="../modules/scrollview-list.html">scrollview-list</a></li>
1169
<li><a href="../modules/scrollview-paginator.html">scrollview-paginator</a></li>
1171
<li><a href="../modules/scrollview-scrollbars.html">scrollview-scrollbars</a></li>
1173
<li><a href="../modules/selection.html">selection</a></li>
1175
<li><a href="../modules/selector-css2.html">selector-css2</a></li>
1177
<li><a href="../modules/selector-css3.html">selector-css3</a></li>
1179
<li><a href="../modules/selector-native.html">selector-native</a></li>
1181
<li><a href="../modules/shim-plugin.html">shim-plugin</a></li>
1183
<li><a href="../modules/slider.html">slider</a></li>
1185
<li><a href="../modules/slider-base.html">slider-base</a></li>
1187
<li><a href="../modules/slider-value-range.html">slider-value-range</a></li>
1189
<li><a href="../modules/sortable.html">sortable</a></li>
1191
<li><a href="../modules/sortable-scroll.html">sortable-scroll</a></li>
1193
<li><a href="../modules/stylesheet.html">stylesheet</a></li>
1195
<li><a href="../modules/substitute.html">substitute</a></li>
1197
<li><a href="../modules/swf.html">swf</a></li>
1199
<li><a href="../modules/swfdetect.html">swfdetect</a></li>
1201
<li><a href="../modules/tabview.html">tabview</a></li>
1203
<li><a href="../modules/test.html">test</a></li>
1205
<li><a href="../modules/test-console.html">test-console</a></li>
1207
<li><a href="../modules/text.html">text</a></li>
1209
<li><a href="../modules/text-accentfold.html">text-accentfold</a></li>
1211
<li><a href="../modules/text-wordbreak.html">text-wordbreak</a></li>
1213
<li><a href="../modules/transition.html">transition</a></li>
1215
<li><a href="../modules/uploader.html">uploader</a></li>
1217
<li><a href="../modules/uploader-deprecated.html">uploader-deprecated</a></li>
1219
<li><a href="../modules/uploader-flash.html">uploader-flash</a></li>
1221
<li><a href="../modules/uploader-html5.html">uploader-html5</a></li>
1223
<li><a href="../modules/uploader-queue.html">uploader-queue</a></li>
1225
<li><a href="../modules/view.html">view</a></li>
1227
<li><a href="../modules/view-node-map.html">view-node-map</a></li>
1229
<li><a href="../modules/widget.html">widget</a></li>
1231
<li><a href="../modules/widget-anim.html">widget-anim</a></li>
1233
<li><a href="../modules/widget-autohide.html">widget-autohide</a></li>
1235
<li><a href="../modules/widget-base.html">widget-base</a></li>
1237
<li><a href="../modules/widget-base-ie.html">widget-base-ie</a></li>
1239
<li><a href="../modules/widget-buttons.html">widget-buttons</a></li>
1241
<li><a href="../modules/widget-child.html">widget-child</a></li>
1243
<li><a href="../modules/widget-htmlparser.html">widget-htmlparser</a></li>
1245
<li><a href="../modules/widget-locale.html">widget-locale</a></li>
1247
<li><a href="../modules/widget-modality.html">widget-modality</a></li>
1249
<li><a href="../modules/widget-parent.html">widget-parent</a></li>
1251
<li><a href="../modules/widget-position.html">widget-position</a></li>
1253
<li><a href="../modules/widget-position-align.html">widget-position-align</a></li>
1255
<li><a href="../modules/widget-position-constrain.html">widget-position-constrain</a></li>
1257
<li><a href="../modules/widget-skin.html">widget-skin</a></li>
1259
<li><a href="../modules/widget-stack.html">widget-stack</a></li>
1261
<li><a href="../modules/widget-stdmod.html">widget-stdmod</a></li>
1263
<li><a href="../modules/widget-uievents.html">widget-uievents</a></li>
1265
<li><a href="../modules/yql.html">yql</a></li>
1267
<li><a href="../modules/yui.html">yui</a></li>
1269
<li><a href="../modules/yui-base.html">yui-base</a></li>
1271
<li><a href="../modules/yui-later.html">yui-later</a></li>
1273
<li><a href="../modules/yui-log.html">yui-log</a></li>
1275
<li><a href="../modules/yui-throttle.html">yui-throttle</a></li>
1277
<li><a href="../modules/yui3.html">yui3</a></li>
1286
<div class="yui3-u-3-4">
1287
<div id="api-options">
1289
<label for="api-show-inherited">
1290
<input type="checkbox" id="api-show-inherited" checked>
1294
<label for="api-show-protected">
1295
<input type="checkbox" id="api-show-protected">
1299
<label for="api-show-private">
1300
<input type="checkbox" id="api-show-private">
1306
<div class="apidocs">
1307
<div id="docs-main">
1308
<div class="content">
1310
<div class="box meta">
1316
<div class="foundat">
1317
Defined in: <a href="../files/io_js_io-base.js.html#l17"><code>io/js/io-base.js:17</code></a>
1323
Module: <a href="../modules/io-upload-iframe.html">io-upload-iframe</a><br>
1324
Parent Module: <a href="../modules/io-base.html">io-base</a>
1333
<div class="box intro">
1334
<p>The IO class is a utility that brokers HTTP requests through a simplified
1335
interface. Specifically, it allows JavaScript to make HTTP requests to
1336
a resource without a page reload. The underlying transport for making
1337
same-domain requests is the XMLHttpRequest object. IO can also use
1338
Flash, if specified as a transport, for cross-domain requests.</p>
1342
<div class="constructor">
1343
<h2>Constructor</h2>
1344
<div id="method_IO" class="method item">
1345
<h3 class="name"><code>IO</code></h3>
1349
<span class="paren">(</span><ul class="args-list inline commas">
1357
</ul><span class="paren">)</span>
1384
<a href="../files/io_js_io-base.js.html#l17"><code>io/js/io-base.js:17</code></a>
1394
<div class="description">
1399
<div class="params">
1400
<h4>Parameters:</h4>
1402
<ul class="params-list">
1406
<code class="param-name">config</code>
1407
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
1412
<div class="param-description">
1413
<p>Object of EventTarget's publish method configurations
1414
used to configure IO's events.</p>
1432
<div id="classdocs" class="tabview">
1433
<ul class="api-class-tabs">
1434
<li class="api-class-tab index"><a href="#index">Index</a></li>
1437
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
1440
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
1444
<li class="api-class-tab events"><a href="#events">Events</a></li>
1449
<div id="index" class="api-class-tabpanel index">
1450
<h2 class="off-left">Item Index</h2>
1453
<div class="index-section methods">
1456
<ul class="index-list methods">
1458
<li class="index-item method private">
1459
<a href="#method__abort">_abort</a>
1464
<li class="index-item method private">
1465
<a href="#method__abort">_abort</a>
1470
<li class="index-item method private">
1471
<a href="#method__cFrame">_cFrame</a>
1476
<li class="index-item method private">
1477
<a href="#method__clearTimeout">_clearTimeout</a>
1482
<li class="index-item method private">
1483
<a href="#method__clearUploadTimeout">_clearUploadTimeout</a>
1486
<span class="flag static">static</span>
1490
<li class="index-item method private">
1491
<a href="#method__concat">_concat</a>
1496
<li class="index-item method private">
1497
<a href="#method__create">_create</a>
1502
<li class="index-item method private">
1503
<a href="#method__data">_data</a>
1508
<li class="index-item method private">
1509
<a href="#method__dFrame">_dFrame</a>
1514
<li class="index-item method private">
1515
<a href="#method__evt">_evt</a>
1520
<li class="index-item method private">
1521
<a href="#method__ieEvt">_ieEvt</a>
1524
<span class="flag static">static</span>
1528
<li class="index-item method private">
1529
<a href="#method__isInProgress">_isInProgress</a>
1534
<li class="index-item method private">
1535
<a href="#method__qShift">_qShift</a>
1538
<span class="flag static">static</span>
1542
<li class="index-item method private">
1543
<a href="#method__removeData">_removeData</a>
1546
<span class="flag static">static</span>
1550
<li class="index-item method private">
1551
<a href="#method__resetAttrs">_resetAttrs</a>
1554
<span class="flag static">static</span>
1558
<li class="index-item method private">
1559
<a href="#method__result">_result</a>
1562
<span class="flag static">static</span>
1566
<li class="index-item method private">
1567
<a href="#method__retry">_retry</a>
1572
<li class="index-item method private">
1573
<a href="#method__rS">_rS</a>
1578
<li class="index-item method private">
1579
<a href="#method__serialize">_serialize</a>
1582
<span class="flag static">static</span>
1586
<li class="index-item method private">
1587
<a href="#method__setAttrs">_setAttrs</a>
1590
<span class="flag static">static</span>
1594
<li class="index-item method private">
1595
<a href="#method__setHeaders">_setHeaders</a>
1600
<li class="index-item method private">
1601
<a href="#method__size">_size</a>
1604
<span class="flag static">static</span>
1608
<li class="index-item method private">
1609
<a href="#method__startTimeout">_startTimeout</a>
1614
<li class="index-item method private">
1615
<a href="#method__startUploadTimeout">_startUploadTimeout</a>
1618
<span class="flag static">static</span>
1622
<li class="index-item method private">
1623
<a href="#method__stop">_stop</a>
1626
<span class="flag static">static</span>
1630
<li class="index-item method private">
1631
<a href="#method__swf">_swf</a>
1636
<li class="index-item method private">
1637
<a href="#method__upload">_upload</a>
1640
<span class="flag static">static</span>
1644
<li class="index-item method private">
1645
<a href="#method__uploadComplete">_uploadComplete</a>
1648
<span class="flag static">static</span>
1652
<li class="index-item method private">
1653
<a href="#method__xdrReady">_xdrReady</a>
1658
<li class="index-item method private">
1659
<a href="#method_appendData">appendData</a>
1662
<span class="flag static">static</span>
1666
<li class="index-item method">
1667
<a href="#method_complete">complete</a>
1672
<li class="index-item method">
1673
<a href="#method_customTransport">customTransport</a>
1676
<span class="flag static">static</span>
1680
<li class="index-item method">
1681
<a href="#method_defaultTransport">defaultTransport</a>
1684
<span class="flag static">static</span>
1688
<li class="index-item method">
1689
<a href="#method_end">end</a>
1694
<li class="index-item method">
1695
<a href="#method_error">error</a>
1700
<li class="index-item method">
1701
<a href="#method_failure">failure</a>
1706
<li class="index-item method">
1707
<a href="#method_load">load</a>
1712
<li class="index-item method">
1713
<a href="#method_notify">notify</a>
1718
<li class="index-item method">
1719
<a href="#method_progress">progress</a>
1724
<li class="index-item method">
1725
<a href="#method_promote">promote</a>
1728
<span class="flag static">static</span>
1732
<li class="index-item method">
1733
<a href="#method_queue">queue</a>
1736
<span class="flag static">static</span>
1740
<li class="index-item method private">
1741
<a href="#method_remove">remove</a>
1744
<span class="flag static">static</span>
1748
<li class="index-item method">
1749
<a href="#method_request">request</a>
1752
<span class="flag static">static</span>
1756
<li class="index-item method public">
1757
<a href="#method_send">send</a>
1762
<li class="index-item method">
1763
<a href="#method_setHeader">setHeader</a>
1768
<li class="index-item method">
1769
<a href="#method_start">start</a>
1774
<li class="index-item method">
1775
<a href="#method_success">success</a>
1780
<li class="index-item method">
1781
<a href="#method_transport">transport</a>
1786
<li class="index-item method">
1787
<a href="#method_transports.nodejs">transports.nodejs</a>
1790
<span class="flag static">static</span>
1794
<li class="index-item method">
1795
<a href="#method_xdr">xdr</a>
1800
<li class="index-item method protected">
1801
<a href="#method_xdrReady">xdrReady</a>
1804
<span class="flag static">static</span>
1808
<li class="index-item method">
1809
<a href="#method_xdrResponse">xdrResponse</a>
1819
<div class="index-section properties">
1822
<ul class="index-list properties">
1824
<li class="index-item property private">
1825
<a href="#property__cB">_cB</a>
1830
<li class="index-item property">
1831
<a href="#property__default">_default</a>
1834
<span class="flag static">static</span>
1838
<li class="index-item property private">
1839
<a href="#property__headers">_headers</a>
1844
<li class="index-item property private">
1845
<a href="#property__id">_id</a>
1850
<li class="index-item property private">
1851
<a href="#property__q">_q</a>
1854
<span class="flag static">static</span>
1858
<li class="index-item property private">
1859
<a href="#property__qState">_qState</a>
1862
<span class="flag static">static</span>
1866
<li class="index-item property private">
1867
<a href="#property__rS">_rS</a>
1872
<li class="index-item property private">
1873
<a href="#property__timeout">_timeout</a>
1878
<li class="index-item property private">
1879
<a href="#property__transport">_transport</a>
1884
<li class="index-item property">
1885
<a href="#property_delay">delay</a>
1888
<span class="flag static">static</span>
1892
<li class="index-item property">
1893
<a href="#property_transports">transports</a>
1896
<span class="flag static">static</span>
1907
<div class="index-section events">
1910
<ul class="index-list events">
1912
<li class="index-item event">
1913
<a href="#event_io:complete">io:complete</a>
1918
<li class="index-item event">
1919
<a href="#event_io:end">io:end</a>
1924
<li class="index-item event">
1925
<a href="#event_io:failure">io:failure</a>
1930
<li class="index-item event">
1931
<a href="#event_io:progress">io:progress</a>
1936
<li class="index-item event">
1937
<a href="#event_io:start">io:start</a>
1942
<li class="index-item event">
1943
<a href="#event_io:success">io:success</a>
1948
<li class="index-item event">
1949
<a href="#event_io:xdrReady">io:xdrReady</a>
1960
<div id="methods" class="api-class-tabpanel">
1961
<h2 class="off-left">Methods</h2>
1964
<div id="method__abort" class="method item private">
1965
<h3 class="name"><code>_abort</code></h3>
1969
<span class="paren">(</span><ul class="args-list inline commas">
1983
</ul><span class="paren">)</span>
1992
<span class="flag private">private</span>
2005
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
2014
<a href="../files/io_js_io-xdr.js.html#l87"><code>io/js/io-xdr.js:87</code></a>
2024
<div class="description">
2025
<p>Method for intiating an XDR transaction abort.</p>
2029
<div class="params">
2030
<h4>Parameters:</h4>
2032
<ul class="params-list">
2036
<code class="param-name">o</code>
2037
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2042
<div class="param-description">
2044
<li>Transaction object generated by _create() in io-base.</li>
2053
<code class="param-name">c</code>
2054
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2059
<div class="param-description">
2061
<li>configuration object for the transaction.</li>
2078
<div id="method__abort" class="method item private">
2079
<h3 class="name"><code>_abort</code></h3>
2083
<span class="paren">(</span><ul class="args-list inline commas">
2087
<code>transaction</code>
2097
</ul><span class="paren">)</span>
2106
<span class="flag private">private</span>
2119
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
2128
<a href="../files/io_js_io-base.js.html#l510"><code>io/js/io-base.js:510</code></a>
2138
<div class="description">
2139
<p>Terminates a transaction due to an explicit abort or timeout.</p>
2143
<div class="params">
2144
<h4>Parameters:</h4>
2146
<ul class="params-list">
2150
<code class="param-name">transaction</code>
2151
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2156
<div class="param-description">
2157
<p>Transaction object generated by _create().</p>
2165
<code class="param-name">type</code>
2166
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
2171
<div class="param-description">
2172
<p>Identifies timed out or aborted transaction.</p>
2188
<div id="method__cFrame" class="method item private">
2189
<h3 class="name"><code>_cFrame</code></h3>
2193
<span class="paren">(</span><ul class="args-list inline commas">
2213
</ul><span class="paren">)</span>
2222
<span class="flag private">private</span>
2242
<a href="../files/io_js_io-upload-iframe.js.html#l14"><code>io/js/io-upload-iframe.js:14</code></a>
2252
<div class="description">
2253
<p>Creates the iframe transported used in file upload
2254
transactions, and binds the response event handler.</p>
2258
<div class="params">
2259
<h4>Parameters:</h4>
2261
<ul class="params-list">
2265
<code class="param-name">o</code>
2266
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2271
<div class="param-description">
2272
<p>Transaction object generated by _create().</p>
2280
<code class="param-name">c</code>
2281
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2286
<div class="param-description">
2287
<p>Configuration object passed to YUI.io().</p>
2295
<code class="param-name">io</code>
2296
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2301
<div class="param-description">
2318
<div id="method__clearTimeout" class="method item private">
2319
<h3 class="name"><code>_clearTimeout</code></h3>
2323
<span class="paren">(</span><ul class="args-list inline commas">
2331
</ul><span class="paren">)</span>
2340
<span class="flag private">private</span>
2353
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
2362
<a href="../files/io_js_io-base.js.html#l445"><code>io/js/io-base.js:445</code></a>
2372
<div class="description">
2373
<p>Clears the timeout interval started by _startTimeout().</p>
2377
<div class="params">
2378
<h4>Parameters:</h4>
2380
<ul class="params-list">
2384
<code class="param-name">id</code>
2385
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
2390
<div class="param-description">
2392
<li>Transaction id.</li>
2409
<div id="method__clearUploadTimeout" class="method item private">
2410
<h3 class="name"><code>_clearUploadTimeout</code></h3>
2414
<span class="paren">(</span><ul class="args-list inline commas">
2422
</ul><span class="paren">)</span>
2431
<span class="flag private">private</span>
2437
<span class="flag static">static</span>
2453
<a href="../files/io_js_io-upload-iframe.js.html#l158"><code>io/js/io-upload-iframe.js:158</code></a>
2463
<div class="description">
2464
<p>Clears the timeout interval started by _startUploadTimeout().</p>
2468
<div class="params">
2469
<h4>Parameters:</h4>
2471
<ul class="params-list">
2475
<code class="param-name">id</code>
2476
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
2481
<div class="param-description">
2483
<li>Transaction ID.</li>
2500
<div id="method__concat" class="method item private">
2501
<h3 class="name"><code>_concat</code></h3>
2505
<span class="paren">(</span><ul class="args-list inline commas">
2519
</ul><span class="paren">)</span>
2524
<span class="returns-inline">
2525
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
2532
<span class="flag private">private</span>
2545
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
2554
<a href="../files/io_js_io-base.js.html#l380"><code>io/js/io-base.js:380</code></a>
2564
<div class="description">
2565
<p>Method that concatenates string data for HTTP GET transactions.</p>
2569
<div class="params">
2570
<h4>Parameters:</h4>
2572
<ul class="params-list">
2576
<code class="param-name">uri</code>
2577
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
2582
<div class="param-description">
2583
<p>URI or root data.</p>
2591
<code class="param-name">data</code>
2592
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
2597
<div class="param-description">
2598
<p>Data to be concatenated onto URI.</p>
2609
<div class="returns">
2612
<div class="returns-description">
2615
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
2626
<div id="method__create" class="method item private">
2627
<h3 class="name"><code>_create</code></h3>
2631
<span class="paren">(</span><ul class="args-list inline commas">
2645
</ul><span class="paren">)</span>
2650
<span class="returns-inline">
2651
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2658
<span class="flag private">private</span>
2671
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
2680
<a href="../files/io_js_io-base.js.html#l93"><code>io/js/io-base.js:93</code></a>
2690
<div class="description">
2691
<p>Method that creates a unique transaction object for each request.</p>
2695
<div class="params">
2696
<h4>Parameters:</h4>
2698
<ul class="params-list">
2702
<code class="param-name">cfg</code>
2703
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2708
<div class="param-description">
2709
<p>Configuration object subset to determine if
2710
the transaction is an XDR or file upload,
2711
requiring an alternate transport.</p>
2719
<code class="param-name">id</code>
2720
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
2725
<div class="param-description">
2726
<p>Transaction id</p>
2737
<div class="returns">
2740
<div class="returns-description">
2743
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
2745
The transaction object
2755
<div id="method__data" class="method item private">
2756
<h3 class="name"><code>_data</code></h3>
2760
<span class="paren">(</span><ul class="args-list inline commas">
2780
</ul><span class="paren">)</span>
2785
<span class="returns-inline">
2786
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2793
<span class="flag private">private</span>
2806
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
2815
<a href="../files/io_js_io-xdr.js.html#l64"><code>io/js/io-xdr.js:64</code></a>
2825
<div class="description">
2826
<p>Creates a response object for XDR transactions, for success
2827
and failure cases.</p>
2831
<div class="params">
2832
<h4>Parameters:</h4>
2834
<ul class="params-list">
2838
<code class="param-name">o</code>
2839
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2844
<div class="param-description">
2846
<li>Transaction object generated by _create() in io-base.</li>
2855
<code class="param-name">u</code>
2856
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
2861
<div class="param-description">
2863
<li>Configuration xdr.use.</li>
2872
<code class="param-name">d</code>
2873
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
2878
<div class="param-description">
2880
<li>Configuration xdr.dataType.</li>
2892
<div class="returns">
2895
<div class="returns-description">
2898
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
2909
<div id="method__dFrame" class="method item private">
2910
<h3 class="name"><code>_dFrame</code></h3>
2914
<span class="paren">(</span><ul class="args-list inline commas">
2922
</ul><span class="paren">)</span>
2931
<span class="flag private">private</span>
2951
<a href="../files/io_js_io-upload-iframe.js.html#l34"><code>io/js/io-upload-iframe.js:34</code></a>
2961
<div class="description">
2962
<p>Removes the iframe transport used in the file upload
2967
<div class="params">
2968
<h4>Parameters:</h4>
2970
<ul class="params-list">
2974
<code class="param-name">id</code>
2975
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
2980
<div class="param-description">
2981
<p>The transaction ID used in the iframe's creation.</p>
2997
<div id="method__evt" class="method item private">
2998
<h3 class="name"><code>_evt</code></h3>
3002
<span class="paren">(</span><ul class="args-list inline commas">
3006
<code>eventName</code>
3012
<code>transaction</code>
3022
</ul><span class="paren">)</span>
3031
<span class="flag private">private</span>
3044
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
3053
<a href="../files/io_js_io-base.js.html#l164"><code>io/js/io-base.js:164</code></a>
3063
<div class="description">
3064
<p>Method for creating and firing events.</p>
3068
<div class="params">
3069
<h4>Parameters:</h4>
3071
<ul class="params-list">
3075
<code class="param-name">eventName</code>
3076
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
3081
<div class="param-description">
3082
<p>Event to be published.</p>
3090
<code class="param-name">transaction</code>
3091
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3096
<div class="param-description">
3097
<p>Transaction object.</p>
3105
<code class="param-name">config</code>
3106
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3111
<div class="param-description">
3112
<p>Configuration data subset for event subscription.</p>
3128
<div id="method__ieEvt" class="method item private">
3129
<h3 class="name"><code>_ieEvt</code></h3>
3133
<span class="paren">(</span><ul class="args-list inline commas">
3147
</ul><span class="paren">)</span>
3156
<span class="flag private">private</span>
3162
<span class="flag static">static</span>
3171
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
3180
<a href="../files/io_js_io-xdr.js.html#l122"><code>io/js/io-xdr.js:122</code></a>
3190
<div class="description">
3191
<p>Sets event handlers for XDomainRequest transactions.</p>
3195
<div class="params">
3196
<h4>Parameters:</h4>
3198
<ul class="params-list">
3202
<code class="param-name">o</code>
3203
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3208
<div class="param-description">
3210
<li>Transaction object generated by _create() in io-base.</li>
3219
<code class="param-name">c</code>
3220
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3225
<div class="param-description">
3227
<li>configuration object for the transaction.</li>
3244
<div id="method__isInProgress" class="method item private">
3245
<h3 class="name"><code>_isInProgress</code></h3>
3249
<span class="paren">(</span><ul class="args-list inline commas">
3257
</ul><span class="paren">)</span>
3266
<span class="flag private">private</span>
3279
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
3288
<a href="../files/io_js_io-xdr.js.html#l99"><code>io/js/io-xdr.js:99</code></a>
3298
<div class="description">
3299
<p>Method for determining if an XDR transaction has completed
3300
and all data are received.</p>
3304
<div class="params">
3305
<h4>Parameters:</h4>
3307
<ul class="params-list">
3311
<code class="param-name">o</code>
3312
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3317
<div class="param-description">
3319
<li>Transaction object generated by _create() in io-base.</li>
3336
<div id="method__qShift" class="method item private">
3337
<h3 class="name"><code>_qShift</code></h3>
3340
<span class="paren">()</span>
3348
<span class="flag private">private</span>
3354
<span class="flag static">static</span>
3363
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
3372
<a href="../files/io_js_io-queue.js.html#l34"><code>io/js/io-queue.js:34</code></a>
3382
<div class="description">
3383
<p>Method Process the first transaction from the
3384
queue in FIFO order.</p>
3395
<div id="method__removeData" class="method item private">
3396
<h3 class="name"><code>_removeData</code></h3>
3400
<span class="paren">(</span><ul class="args-list inline commas">
3414
</ul><span class="paren">)</span>
3423
<span class="flag private">private</span>
3429
<span class="flag static">static</span>
3445
<a href="../files/io_js_io-upload-iframe.js.html#l82"><code>io/js/io-upload-iframe.js:82</code></a>
3455
<div class="description">
3456
<p>Removes the custom fields created to pass additional POST
3457
data, along with the HTML form fields.</p>
3461
<div class="params">
3462
<h4>Parameters:</h4>
3464
<ul class="params-list">
3468
<code class="param-name">f</code>
3469
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3474
<div class="param-description">
3475
<p>HTML form object.</p>
3483
<code class="param-name">o</code>
3484
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3489
<div class="param-description">
3490
<p>HTML form fields created from configuration.data.</p>
3506
<div id="method__resetAttrs" class="method item private">
3507
<h3 class="name"><code>_resetAttrs</code></h3>
3511
<span class="paren">(</span><ul class="args-list inline commas">
3525
</ul><span class="paren">)</span>
3534
<span class="flag private">private</span>
3540
<span class="flag static">static</span>
3556
<a href="../files/io_js_io-upload-iframe.js.html#l116"><code>io/js/io-upload-iframe.js:116</code></a>
3566
<div class="description">
3567
<p>Reset the HTML form attributes to their original values.</p>
3571
<div class="params">
3572
<h4>Parameters:</h4>
3574
<ul class="params-list">
3578
<code class="param-name">f</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>
3584
<div class="param-description">
3585
<p>HTML form object.</p>
3593
<code class="param-name">a</code>
3594
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3599
<div class="param-description">
3600
<p>Object of original attributes.</p>
3616
<div id="method__result" class="method item private">
3617
<h3 class="name"><code>_result</code></h3>
3621
<span class="paren">(</span><ul class="args-list inline commas">
3625
<code>transaction</code>
3635
</ul><span class="paren">)</span>
3644
<span class="flag private">private</span>
3650
<span class="flag static">static</span>
3659
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
3668
<a href="../files/io_js_io-base.js.html#l457"><code>io/js/io-base.js:457</code></a>
3678
<div class="description">
3679
<p>Method that determines if a transaction response qualifies as success
3680
or failure, based on the response HTTP status code, and fires the
3681
appropriate success or failure events.</p>
3685
<div class="params">
3686
<h4>Parameters:</h4>
3688
<ul class="params-list">
3692
<code class="param-name">transaction</code>
3693
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3698
<div class="param-description">
3699
<p>Transaction object generated by _create().</p>
3707
<code class="param-name">config</code>
3708
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3713
<div class="param-description">
3714
<p>Configuration object passed to io().</p>
3730
<div id="method__retry" class="method item private">
3731
<h3 class="name"><code>_retry</code></h3>
3735
<span class="paren">(</span><ul class="args-list inline commas">
3739
<code>transaction</code>
3755
</ul><span class="paren">)</span>
3764
<span class="flag private">private</span>
3777
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
3786
<a href="../files/io_js_io-base.js.html#l364"><code>io/js/io-base.js:364</code></a>
3796
<div class="description">
3797
<p>Retry an XDR transaction, using the Flash tranport, if the native
3798
transport fails.</p>
3802
<div class="params">
3803
<h4>Parameters:</h4>
3805
<ul class="params-list">
3809
<code class="param-name">transaction</code>
3810
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3815
<div class="param-description">
3816
<p>Transaction object.</p>
3824
<code class="param-name">uri</code>
3825
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
3830
<div class="param-description">
3831
<p>Qualified path to transaction resource.</p>
3839
<code class="param-name">config</code>
3840
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3845
<div class="param-description">
3846
<p>Configuration object for the transaction.</p>
3862
<div id="method__rS" class="method item private">
3863
<h3 class="name"><code>_rS</code></h3>
3867
<span class="paren">(</span><ul class="args-list inline commas">
3871
<code>transaction</code>
3881
</ul><span class="paren">)</span>
3890
<span class="flag private">private</span>
3903
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
3912
<a href="../files/io_js_io-base.js.html#l486"><code>io/js/io-base.js:486</code></a>
3922
<div class="description">
3923
<p>Event handler bound to onreadystatechange.</p>
3927
<div class="params">
3928
<h4>Parameters:</h4>
3930
<ul class="params-list">
3934
<code class="param-name">transaction</code>
3935
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3940
<div class="param-description">
3941
<p>Transaction object generated by _create().</p>
3949
<code class="param-name">config</code>
3950
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
3955
<div class="param-description">
3956
<p>Configuration object passed to YUI.io().</p>
3972
<div id="method__serialize" class="method item private">
3973
<h3 class="name"><code>_serialize</code></h3>
3977
<span class="paren">(</span><ul class="args-list inline commas">
3991
</ul><span class="paren">)</span>
3996
<span class="returns-inline">
3997
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4004
<span class="flag private">private</span>
4010
<span class="flag static">static</span>
4019
<p>Provided by the <a href="../modules/io-form.html">io-form</a> module.</p>
4028
<a href="../files/io_js_io-form.js.html#l12"><code>io/js/io-form.js:12</code></a>
4038
<div class="description">
4039
<p>Method to enumerate through an HTML form's elements collection
4040
and return a string comprised of key-value pairs.</p>
4044
<div class="params">
4045
<h4>Parameters:</h4>
4047
<ul class="params-list">
4051
<code class="param-name">c</code>
4052
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4057
<div class="param-description">
4059
<li>YUI form node or HTML form id.</li>
4068
<code class="param-name">s</code>
4069
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4074
<div class="param-description">
4076
<li>Key-value data defined in the configuration object.</li>
4088
<div class="returns">
4091
<div class="returns-description">
4094
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
4105
<div id="method__setAttrs" class="method item private">
4106
<h3 class="name"><code>_setAttrs</code></h3>
4110
<span class="paren">(</span><ul class="args-list inline commas">
4130
</ul><span class="paren">)</span>
4139
<span class="flag private">private</span>
4145
<span class="flag static">static</span>
4161
<a href="../files/io_js_io-upload-iframe.js.html#l99"><code>io/js/io-upload-iframe.js:99</code></a>
4171
<div class="description">
4172
<p>Sets the appropriate attributes and values to the HTML
4173
form, in preparation of a file upload transaction.</p>
4177
<div class="params">
4178
<h4>Parameters:</h4>
4180
<ul class="params-list">
4184
<code class="param-name">f</code>
4185
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4190
<div class="param-description">
4191
<p>HTML form object.</p>
4199
<code class="param-name">id</code>
4200
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4205
<div class="param-description">
4206
<p>The Transaction ID.</p>
4214
<code class="param-name">uri</code>
4215
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4220
<div class="param-description">
4221
<p>Qualified path to transaction resource.</p>
4237
<div id="method__setHeaders" class="method item private">
4238
<h3 class="name"><code>_setHeaders</code></h3>
4242
<span class="paren">(</span><ul class="args-list inline commas">
4246
<code>transaction</code>
4252
<code>headers</code>
4256
</ul><span class="paren">)</span>
4265
<span class="flag private">private</span>
4278
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
4287
<a href="../files/io_js_io-base.js.html#l410"><code>io/js/io-base.js:410</code></a>
4297
<div class="description">
4298
<p>Method that sets all HTTP headers to be sent in a transaction.</p>
4302
<div class="params">
4303
<h4>Parameters:</h4>
4305
<ul class="params-list">
4309
<code class="param-name">transaction</code>
4310
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4315
<div class="param-description">
4317
<li>XHR instance for the specific transaction.</li>
4326
<code class="param-name">headers</code>
4327
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4332
<div class="param-description">
4334
<li>HTTP headers for the specific transaction, as
4335
defined in the configuration object passed to YUI.io().</li>
4352
<div id="method__size" class="method item private">
4353
<h3 class="name"><code>_size</code></h3>
4356
<span class="paren">()</span>
4360
<span class="returns-inline">
4361
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
4368
<span class="flag private">private</span>
4374
<span class="flag static">static</span>
4383
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
4392
<a href="../files/io_js_io-queue.js.html#l131"><code>io/js/io-queue.js:131</code></a>
4402
<div class="description">
4403
<p>Method to query the current size of the queue.</p>
4409
<div class="returns">
4412
<div class="returns-description">
4415
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>:
4426
<div id="method__startTimeout" class="method item private">
4427
<h3 class="name"><code>_startTimeout</code></h3>
4431
<span class="paren">(</span><ul class="args-list inline commas">
4435
<code>transaction</code>
4441
<code>timeout</code>
4445
</ul><span class="paren">)</span>
4454
<span class="flag private">private</span>
4467
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
4476
<a href="../files/io_js_io-base.js.html#l428"><code>io/js/io-base.js:428</code></a>
4486
<div class="description">
4487
<p>Starts timeout count if the configuration object has a defined
4488
timeout property.</p>
4492
<div class="params">
4493
<h4>Parameters:</h4>
4495
<ul class="params-list">
4499
<code class="param-name">transaction</code>
4500
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4505
<div class="param-description">
4506
<p>Transaction object generated by _create().</p>
4514
<code class="param-name">timeout</code>
4515
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4520
<div class="param-description">
4521
<p>Timeout in milliseconds.</p>
4537
<div id="method__startUploadTimeout" class="method item private">
4538
<h3 class="name"><code>_startUploadTimeout</code></h3>
4542
<span class="paren">(</span><ul class="args-list inline commas">
4556
</ul><span class="paren">)</span>
4565
<span class="flag private">private</span>
4571
<span class="flag static">static</span>
4587
<a href="../files/io_js_io-upload-iframe.js.html#l135"><code>io/js/io-upload-iframe.js:135</code></a>
4597
<div class="description">
4598
<p>Starts timeout count if the configuration object
4599
has a defined timeout property.</p>
4603
<div class="params">
4604
<h4>Parameters:</h4>
4606
<ul class="params-list">
4610
<code class="param-name">o</code>
4611
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4616
<div class="param-description">
4617
<p>Transaction object generated by _create().</p>
4625
<code class="param-name">c</code>
4626
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4631
<div class="param-description">
4632
<p>Configuration object passed to YUI.io().</p>
4648
<div id="method__stop" class="method item private">
4649
<h3 class="name"><code>_stop</code></h3>
4652
<span class="paren">()</span>
4660
<span class="flag private">private</span>
4666
<span class="flag static">static</span>
4675
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
4684
<a href="../files/io_js_io-queue.js.html#l117"><code>io/js/io-queue.js:117</code></a>
4694
<div class="description">
4695
<p>Method for setting queue processing to inactive.
4696
Transaction requests to YUI.io.queue() will be stored in the queue, but
4697
not processed until the queue is reset to "active".</p>
4708
<div id="method__swf" class="method item private">
4709
<h3 class="name"><code>_swf</code></h3>
4713
<span class="paren">(</span><ul class="args-list inline commas">
4733
</ul><span class="paren">)</span>
4742
<span class="flag private">private</span>
4755
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
4764
<a href="../files/io_js_io-xdr.js.html#l42"><code>io/js/io-xdr.js:42</code></a>
4774
<div class="description">
4775
<p>Method that creates the Flash transport swf.</p>
4779
<div class="params">
4780
<h4>Parameters:</h4>
4782
<ul class="params-list">
4786
<code class="param-name">uri</code>
4787
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4792
<div class="param-description">
4794
<li>location of io.swf.</li>
4803
<code class="param-name">yid</code>
4804
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4809
<div class="param-description">
4811
<li>YUI sandbox id.</li>
4820
<code class="param-name">yid</code>
4821
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4826
<div class="param-description">
4828
<li>IO instance id.</li>
4845
<div id="method__upload" class="method item private">
4846
<h3 class="name"><code>_upload</code></h3>
4850
<span class="paren">(</span><ul class="args-list inline commas">
4870
</ul><span class="paren">)</span>
4879
<span class="flag private">private</span>
4885
<span class="flag static">static</span>
4901
<a href="../files/io_js_io-upload-iframe.js.html#l216"><code>io/js/io-upload-iframe.js:216</code></a>
4911
<div class="description">
4912
<p>Uploads HTML form data, inclusive of files/attachments,
4913
using the iframe created in _create to facilitate the transaction.</p>
4917
<div class="params">
4918
<h4>Parameters:</h4>
4920
<ul class="params-list">
4924
<code class="param-name">o</code>
4925
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4930
<div class="param-description">
4931
<p>The transaction object</p>
4939
<code class="param-name">uri</code>
4940
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4945
<div class="param-description">
4946
<p>Qualified path to transaction resource.</p>
4954
<code class="param-name">c</code>
4955
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4960
<div class="param-description">
4961
<p>Configuration object for the transaction.</p>
4977
<div id="method__uploadComplete" class="method item private">
4978
<h3 class="name"><code>_uploadComplete</code></h3>
4982
<span class="paren">(</span><ul class="args-list inline commas">
4996
</ul><span class="paren">)</span>
5005
<span class="flag private">private</span>
5011
<span class="flag static">static</span>
5027
<a href="../files/io_js_io-upload-iframe.js.html#l172"><code>io/js/io-upload-iframe.js:172</code></a>
5037
<div class="description">
5038
<p>Bound to the iframe's Load event and processes
5039
the response data.</p>
5043
<div class="params">
5044
<h4>Parameters:</h4>
5046
<ul class="params-list">
5050
<code class="param-name">o</code>
5051
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5056
<div class="param-description">
5057
<p>The transaction object</p>
5065
<code class="param-name">c</code>
5066
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5071
<div class="param-description">
5072
<p>Configuration object for the transaction.</p>
5088
<div id="method__xdrReady" class="method item private">
5089
<h3 class="name"><code>_xdrReady</code></h3>
5093
<span class="paren">(</span><ul class="args-list inline commas">
5107
</ul><span class="paren">)</span>
5116
<span class="flag private">private</span>
5129
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
5138
<a href="../files/io_js_io-xdr.js.html#l245"><code>io/js/io-xdr.js:245</code></a>
5148
<div class="description">
5149
<p>Fires event "io:xdrReady"</p>
5153
<div class="params">
5154
<h4>Parameters:</h4>
5156
<ul class="params-list">
5160
<code class="param-name">yid</code>
5161
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
5166
<div class="param-description">
5168
<li>YUI sandbox id.</li>
5177
<code class="param-name">uid</code>
5178
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
5183
<div class="param-description">
5185
<li>IO instance id.</li>
5202
<div id="method_appendData" class="method item private">
5203
<h3 class="name"><code>appendData</code></h3>
5207
<span class="paren">(</span><ul class="args-list inline commas">
5221
</ul><span class="paren">)</span>
5226
<span class="returns-inline">
5227
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
5234
<span class="flag private">private</span>
5240
<span class="flag static">static</span>
5256
<a href="../files/io_js_io-upload-iframe.js.html#l49"><code>io/js/io-upload-iframe.js:49</code></a>
5266
<div class="description">
5267
<p>Parses the POST data object and creates hidden form elements
5268
for each key-value, and appends them to the HTML form object.</p>
5272
<div class="params">
5273
<h4>Parameters:</h4>
5275
<ul class="params-list">
5279
<code class="param-name">f</code>
5280
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5285
<div class="param-description">
5286
<p>HTML form object.</p>
5294
<code class="param-name">s</code>
5295
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
5300
<div class="param-description">
5301
<p>The key-value POST data.</p>
5312
<div class="returns">
5315
<div class="returns-description">
5318
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
5320
o Array of created fields.
5330
<div id="method_complete" class="method item">
5331
<h3 class="name"><code>complete</code></h3>
5335
<span class="paren">(</span><ul class="args-list inline commas">
5339
<code>transaction</code>
5349
</ul><span class="paren">)</span>
5369
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
5378
<a href="../files/io_js_io-base.js.html#l242"><code>io/js/io-base.js:242</code></a>
5388
<div class="description">
5389
<p>Fires event "io:complete" and creates, fires a
5390
transaction-specific "complete" event, if config.on.complete is
5395
<div class="params">
5396
<h4>Parameters:</h4>
5398
<ul class="params-list">
5402
<code class="param-name">transaction</code>
5403
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5408
<div class="param-description">
5409
<p>Transaction object.</p>
5417
<code class="param-name">config</code>
5418
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5423
<div class="param-description">
5424
<p>Configuration object for the transaction.</p>
5440
<div id="method_customTransport" class="method item">
5441
<h3 class="name"><code>customTransport</code></h3>
5445
<span class="paren">(</span><ul class="args-list inline commas">
5453
</ul><span class="paren">)</span>
5466
<span class="flag static">static</span>
5475
<p>Provided by the <a href="../modules/io.html">io</a> module.</p>
5484
<a href="../files/io_js_transports.js.html#l52"><code>io/js/transports.js:52</code></a>
5494
<div class="description">
5495
<p>Create a custom transport of type and return it's object</p>
5499
<div class="params">
5500
<h4>Parameters:</h4>
5502
<ul class="params-list">
5506
<code class="param-name">id</code>
5507
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
5512
<div class="param-description">
5513
<p>The id of the transport to create.</p>
5529
<div id="method_defaultTransport" class="method item">
5530
<h3 class="name"><code>defaultTransport</code></h3>
5534
<span class="paren">(</span><ul class="args-list inline commas">
5538
<code class="optional">[id]</code>
5542
</ul><span class="paren">)</span>
5547
<span class="returns-inline">
5548
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5559
<span class="flag static">static</span>
5568
<p>Provided by the <a href="../modules/io.html">io</a> module.</p>
5577
<a href="../files/io_js_transports.js.html#l14"><code>io/js/transports.js:14</code></a>
5587
<div class="description">
5592
<div class="params">
5593
<h4>Parameters:</h4>
5595
<ul class="params-list">
5599
<code class="param-name optional">[id]</code>
5600
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
5601
<span class="flag optional" title="This parameter is optional.">optional</span>
5606
<div class="param-description">
5607
<p>The transport to set as the default, if empty a new transport is created.</p>
5618
<div class="returns">
5621
<div class="returns-description">
5624
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
5626
The transport object with a <code>send</code> method
5636
<div id="method_end" class="method item">
5637
<h3 class="name"><code>end</code></h3>
5641
<span class="paren">(</span><ul class="args-list inline commas">
5645
<code>transaction</code>
5655
</ul><span class="paren">)</span>
5675
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
5684
<a href="../files/io_js_io-base.js.html#l261"><code>io/js/io-base.js:261</code></a>
5694
<div class="description">
5695
<p>Fires event "io:end" and creates, fires a transaction-specific "end"
5696
event, if config.on.end is defined.</p>
5700
<div class="params">
5701
<h4>Parameters:</h4>
5703
<ul class="params-list">
5707
<code class="param-name">transaction</code>
5708
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5713
<div class="param-description">
5714
<p>Transaction object.</p>
5722
<code class="param-name">config</code>
5723
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5728
<div class="param-description">
5729
<p>Configuration object for the transaction.</p>
5745
<div id="method_error" class="method item">
5746
<h3 class="name"><code>error</code></h3>
5750
<span class="paren">(</span><ul class="args-list inline commas">
5754
<code>transaction</code>
5770
</ul><span class="paren">)</span>
5790
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
5799
<a href="../files/io_js_io-base.js.html#l349"><code>io/js/io-base.js:349</code></a>
5809
<div class="description">
5810
<p>Fires event "io:failure" and creates, fires a transaction-specific
5811
"failure" event -- for XMLHttpRequest file upload -- if
5812
config.on.failure is defined.</p>
5816
<div class="params">
5817
<h4>Parameters:</h4>
5819
<ul class="params-list">
5823
<code class="param-name">transaction</code>
5824
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5829
<div class="param-description">
5830
<p>Transaction object.</p>
5838
<code class="param-name">error</code>
5839
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5844
<div class="param-description">
5853
<code class="param-name">config</code>
5854
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5859
<div class="param-description">
5860
<p>Configuration object for the transaction.</p>
5876
<div id="method_failure" class="method item">
5877
<h3 class="name"><code>failure</code></h3>
5881
<span class="paren">(</span><ul class="args-list inline commas">
5885
<code>transaction</code>
5895
</ul><span class="paren">)</span>
5915
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
5924
<a href="../files/io_js_io-base.js.html#l296"><code>io/js/io-base.js:296</code></a>
5934
<div class="description">
5935
<p>Fires event "io:failure" and creates, fires a transaction-specific
5936
"failure" event, if config.on.failure is defined.</p>
5940
<div class="params">
5941
<h4>Parameters:</h4>
5943
<ul class="params-list">
5947
<code class="param-name">transaction</code>
5948
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5953
<div class="param-description">
5954
<p>Transaction object.</p>
5962
<code class="param-name">config</code>
5963
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5968
<div class="param-description">
5969
<p>Configuration object for the transaction.</p>
5985
<div id="method_load" class="method item">
5986
<h3 class="name"><code>load</code></h3>
5990
<span class="paren">(</span><ul class="args-list inline commas">
5994
<code>transaction</code>
6010
</ul><span class="paren">)</span>
6030
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
6039
<a href="../files/io_js_io-base.js.html#l334"><code>io/js/io-base.js:334</code></a>
6049
<div class="description">
6050
<p>Fires event "io:complete" and creates, fires a transaction-specific
6051
"complete" event -- for XMLHttpRequest file upload -- if
6052
config.on.complete is defined.</p>
6056
<div class="params">
6057
<h4>Parameters:</h4>
6059
<ul class="params-list">
6063
<code class="param-name">transaction</code>
6064
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6069
<div class="param-description">
6070
<p>Transaction object.</p>
6078
<code class="param-name">load</code>
6079
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6084
<div class="param-description">
6093
<code class="param-name">config</code>
6094
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6099
<div class="param-description">
6100
<p>Configuration object for the transaction.</p>
6116
<div id="method_notify" class="method item">
6117
<h3 class="name"><code>notify</code></h3>
6121
<span class="paren">(</span><ul class="args-list inline commas">
6131
<code>transaction</code>
6141
</ul><span class="paren">)</span>
6161
<p>Provided by the <a href="../modules/io.html">io</a> module.</p>
6170
<a href="../files/io_js_transports.js.html#l67"><code>io/js/transports.js:67</code></a>
6180
<div class="description">
6181
<p>Fired from the notify method of the transport which in turn fires
6182
the event on the IO object.</p>
6186
<div class="params">
6187
<h4>Parameters:</h4>
6189
<ul class="params-list">
6193
<code class="param-name">event</code>
6194
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6199
<div class="param-description">
6200
<p>The name of the event</p>
6208
<code class="param-name">transaction</code>
6209
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6214
<div class="param-description">
6215
<p>The transaction object</p>
6223
<code class="param-name">config</code>
6224
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6229
<div class="param-description">
6230
<p>The configuration object for this transaction</p>
6246
<div id="method_progress" class="method item">
6247
<h3 class="name"><code>progress</code></h3>
6251
<span class="paren">(</span><ul class="args-list inline commas">
6255
<code>transaction</code>
6261
<code>progress</code>
6271
</ul><span class="paren">)</span>
6291
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
6300
<a href="../files/io_js_io-base.js.html#l314"><code>io/js/io-base.js:314</code></a>
6310
<div class="description">
6311
<p>Fires event "io:progress" and creates, fires a transaction-specific
6312
"progress" event -- for XMLHttpRequest file upload -- if
6313
config.on.progress is defined.</p>
6317
<div class="params">
6318
<h4>Parameters:</h4>
6320
<ul class="params-list">
6324
<code class="param-name">transaction</code>
6325
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6330
<div class="param-description">
6331
<p>Transaction object.</p>
6339
<code class="param-name">progress</code>
6340
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6345
<div class="param-description">
6354
<code class="param-name">config</code>
6355
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6360
<div class="param-description">
6361
<p>Configuration object for the transaction.</p>
6377
<div id="method_promote" class="method item">
6378
<h3 class="name"><code>promote</code></h3>
6381
<span class="paren">()</span>
6393
<span class="flag static">static</span>
6402
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
6411
<a href="../files/io_js_io-queue.js.html#l85"><code>io/js/io-queue.js:85</code></a>
6421
<div class="description">
6422
<p>Method for promoting a transaction to the top of the queue.</p>
6433
<div id="method_queue" class="method item">
6434
<h3 class="name"><code>queue</code></h3>
6437
<span class="paren">()</span>
6441
<span class="returns-inline">
6442
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6453
<span class="flag static">static</span>
6462
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
6471
<a href="../files/io_js_io-queue.js.html#l51"><code>io/js/io-queue.js:51</code></a>
6481
<div class="description">
6482
<p>Method for queueing a transaction before the request is sent to the
6483
resource, to ensure sequential processing.</p>
6489
<div class="returns">
6492
<div class="returns-description">
6495
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
6506
<div id="method_remove" class="method item private">
6507
<h3 class="name"><code>remove</code></h3>
6510
<span class="paren">()</span>
6518
<span class="flag private">private</span>
6524
<span class="flag static">static</span>
6533
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
6542
<a href="../files/io_js_io-queue.js.html#l95"><code>io/js/io-queue.js:95</code></a>
6552
<div class="description">
6553
<p>Method for removing a specific, pending transaction from
6565
<div id="method_request" class="method item">
6566
<h3 class="name"><code>request</code></h3>
6569
<span class="paren">()</span>
6581
<span class="flag static">static</span>
6590
<p>Provided by the <a href="../modules/io.html">io</a> module.</p>
6599
<a href="../files/io_js_io-nodejs.js.html#l3"><code>io/js/io-nodejs.js:3</code></a>
6609
<div class="description">
6610
<p>Passthru to the NodeJS <a href="https://github.com/mikeal/request">request</a> module.
6611
This method is return of <code>require('request')</code> so you can use it inside NodeJS without
6612
the IO abstraction.</p>
6623
<div id="method_send" class="method item public">
6624
<h3 class="name"><code>send</code></h3>
6628
<span class="paren">(</span><ul class="args-list inline commas">
6648
</ul><span class="paren">)</span>
6653
<span class="returns-inline">
6654
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6661
<span class="flag public">public</span>
6674
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
6683
<a href="../files/io_js_io-base.js.html#l525"><code>io/js/io-base.js:525</code></a>
6693
<div class="description">
6694
<p>Requests a transaction. <code>send()</code> is implemented as <code>Y.io()</code>. Each
6695
transaction may include a configuration object. Its properties are:</p>
6699
<dd>HTTP method verb (e.g., GET or POST). If this property is not
6700
not defined, the default value will be GET.</dd>
6703
<dd>This is the name-value string that will be sent as the
6704
transaction data. If the request is HTTP GET, the data become
6705
part of querystring. If HTTP POST, the data are sent in the
6709
<dd>Defines the transport to be used for cross-domain requests.
6710
By setting this property, the transaction will use the specified
6711
transport instead of XMLHttpRequest. The properties of the
6712
transport object are:
6715
<dd>The transport to be used: 'flash' or 'native'</dd>
6717
<dd>Set the value to 'XML' if that is the expected response
6722
<dd>Form serialization configuration object. Its properties are:
6725
<dd>Node object or id of HTML form</dd>
6726
<dt>useDisabled</dt>
6727
<dd><code>true</code> to also serialize disabled form field values
6728
(defaults to <code>false</code>)</dd>
6732
<dd>Assigns transaction event subscriptions. Available events are:
6735
<dd>Fires when a request is sent to a resource.</dd>
6737
<dd>Fires when the transaction is complete.</dd>
6739
<dd>Fires when the HTTP response status is within the 2xx
6742
<dd>Fires when the HTTP response status is outside the 2xx
6743
range, if an exception occurs, if the transation is aborted,
6744
or if the transaction exceeds a configured <code>timeout</code>.</dd>
6746
<dd>Fires at the conclusion of the transaction
6747
lifecycle, after <code>success</code> or <code>failure</code>.</dd>
6750
<p>Callback functions for <code>start</code> and <code>end</code> receive the id of the
6751
transaction as a first argument. For <code>complete</code>, <code>success</code>, and
6752
<code>failure</code>, callbacks receive the id and the response object
6753
(usually the XMLHttpRequest instance). If the <code>arguments</code>
6754
property was included in the configuration object passed to
6755
<code>Y.io()</code>, the configured data will be passed to all callbacks as
6756
the last argument.</p>
6760
<dd>Pass <code>true</code> to make a same-domain transaction synchronous.
6761
<strong>CAVEAT</strong>: This will negatively impact the user
6762
experience. Have a <em>very</em> good reason if you intend to use
6766
<dd>The "`this'" object for all configured event handlers. If a
6767
specific context is needed for individual callbacks, bind the
6768
callback to a context using <code>Y.bind()</code>.</dd>
6771
<dd>Object map of transaction headers to send to the server. The
6772
object keys are the header names and the values are the header
6776
<dd>Millisecond threshold for the transaction before being
6777
automatically aborted.</dd>
6780
<dd>User-defined data passed to all registered event handlers.
6781
This value is available as the second argument in the "start" and
6782
"end" event handlers. It is the third argument in the "complete",
6783
"success", and "failure" event handlers. <strong>Be sure to quote
6784
this property name in the transaction configuration as
6785
"arguments" is a reserved word in JavaScript</strong> (e.g.
6786
<code>Y.io({ ..., "arguments": stuff })</code>).</dd>
6791
<div class="params">
6792
<h4>Parameters:</h4>
6794
<ul class="params-list">
6798
<code class="param-name">uri</code>
6799
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6804
<div class="param-description">
6805
<p>Qualified path to transaction resource.</p>
6813
<code class="param-name">config</code>
6814
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6819
<div class="param-description">
6820
<p>Configuration object for the transaction.</p>
6828
<code class="param-name">id</code>
6829
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
6834
<div class="param-description">
6835
<p>Transaction id, if already set.</p>
6846
<div class="returns">
6849
<div class="returns-description">
6852
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
6863
<div id="method_setHeader" class="method item">
6864
<h3 class="name"><code>setHeader</code></h3>
6868
<span class="paren">(</span><ul class="args-list inline commas">
6882
</ul><span class="paren">)</span>
6902
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
6911
<a href="../files/io_js_io-base.js.html#l394"><code>io/js/io-base.js:394</code></a>
6921
<div class="description">
6922
<p>Stores default client headers for all transactions. If a label is
6923
passed with no value argument, the header will be deleted.</p>
6927
<div class="params">
6928
<h4>Parameters:</h4>
6930
<ul class="params-list">
6934
<code class="param-name">name</code>
6935
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6940
<div class="param-description">
6949
<code class="param-name">value</code>
6950
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6955
<div class="param-description">
6956
<p>HTTP header value</p>
6972
<div id="method_start" class="method item">
6973
<h3 class="name"><code>start</code></h3>
6977
<span class="paren">(</span><ul class="args-list inline commas">
6981
<code>transaction</code>
6991
</ul><span class="paren">)</span>
7011
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
7020
<a href="../files/io_js_io-base.js.html#l226"><code>io/js/io-base.js:226</code></a>
7030
<div class="description">
7031
<p>Fires event "io:start" and creates, fires a transaction-specific
7032
start event, if <code>config.on.start</code> is defined.</p>
7036
<div class="params">
7037
<h4>Parameters:</h4>
7039
<ul class="params-list">
7043
<code class="param-name">transaction</code>
7044
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7049
<div class="param-description">
7050
<p>Transaction object.</p>
7058
<code class="param-name">config</code>
7059
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7064
<div class="param-description">
7065
<p>Configuration object for the transaction.</p>
7081
<div id="method_success" class="method item">
7082
<h3 class="name"><code>success</code></h3>
7086
<span class="paren">(</span><ul class="args-list inline commas">
7090
<code>transaction</code>
7100
</ul><span class="paren">)</span>
7120
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
7129
<a href="../files/io_js_io-base.js.html#l278"><code>io/js/io-base.js:278</code></a>
7139
<div class="description">
7140
<p>Fires event "io:success" and creates, fires a transaction-specific
7141
"success" event, if config.on.success is defined.</p>
7145
<div class="params">
7146
<h4>Parameters:</h4>
7148
<ul class="params-list">
7152
<code class="param-name">transaction</code>
7153
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7158
<div class="param-description">
7159
<p>Transaction object.</p>
7167
<code class="param-name">config</code>
7168
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7173
<div class="param-description">
7174
<p>Configuration object for the transaction.</p>
7190
<div id="method_transport" class="method item">
7191
<h3 class="name"><code>transport</code></h3>
7195
<span class="paren">(</span><ul class="args-list inline commas">
7203
</ul><span class="paren">)</span>
7223
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
7232
<a href="../files/io_js_io-xdr.js.html#l257"><code>io/js/io-xdr.js:257</code></a>
7242
<div class="description">
7243
<p>Initializes the desired transport.</p>
7247
<div class="params">
7248
<h4>Parameters:</h4>
7250
<ul class="params-list">
7254
<code class="param-name">o</code>
7255
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7260
<div class="param-description">
7262
<li>object of transport configurations.</li>
7279
<div id="method_transports.nodejs" class="method item">
7280
<h3 class="name"><code>transports.nodejs</code></h3>
7283
<span class="paren">()</span>
7287
<span class="returns-inline">
7288
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7299
<span class="flag static">static</span>
7308
<p>Provided by the <a href="../modules/io.html">io</a> module.</p>
7317
<a href="../files/io_js_io-nodejs.js.html#l16"><code>io/js/io-nodejs.js:16</code></a>
7327
<div class="description">
7328
<p>NodeJS IO transport, uses the NodeJS <a href="https://github.com/mikeal/request">request</a>
7329
module under the hood to perform all network IO.</p>
7335
<div class="returns">
7338
<div class="returns-description">
7341
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
7343
This object contains only a <code>send</code> method that accepts a
7344
<code>transaction object</code>, <code>uri</code> and the <code>config object</code>.
7351
<div class="example">
7354
<div class="example-content">
7355
<pre class="code"><code class="prettyprint">Y.io('https://somedomain.com/url', {
7358
//Extra request module config options.
7364
'content-type': 'application/json',
7365
body: JSON.stringify({
7371
'content_type': 'text/plain'
7377
body: 'I am an attachment'
7382
success: function(id, e) {
7383
Y.log(e.responseText);
7394
<div id="method_xdr" class="method item">
7395
<h3 class="name"><code>xdr</code></h3>
7399
<span class="paren">(</span><ul class="args-list inline commas">
7419
</ul><span class="paren">)</span>
7439
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
7448
<a href="../files/io_js_io-xdr.js.html#l154"><code>io/js/io-xdr.js:154</code></a>
7458
<div class="description">
7459
<p>Method for accessing the transport's interface for making a
7460
cross-domain transaction.</p>
7464
<div class="params">
7465
<h4>Parameters:</h4>
7467
<ul class="params-list">
7471
<code class="param-name">uri</code>
7472
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7477
<div class="param-description">
7479
<li>qualified path to transaction resource.</li>
7488
<code class="param-name">o</code>
7489
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7494
<div class="param-description">
7496
<li>Transaction object generated by _create() in io-base.</li>
7505
<code class="param-name">c</code>
7506
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7511
<div class="param-description">
7513
<li>configuration object for the transaction.</li>
7530
<div id="method_xdrReady" class="method item protected">
7531
<h3 class="name"><code>xdrReady</code></h3>
7535
<span class="paren">(</span><ul class="args-list inline commas">
7549
</ul><span class="paren">)</span>
7558
<span class="flag protected">protected</span>
7564
<span class="flag static">static</span>
7573
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
7582
<a href="../files/io_js_io-xdr.js.html#l271"><code>io/js/io-xdr.js:271</code></a>
7592
<div class="description">
7593
<p>Fires event "io:xdrReady"</p>
7597
<div class="params">
7598
<h4>Parameters:</h4>
7600
<ul class="params-list">
7604
<code class="param-name">yid</code>
7605
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
7610
<div class="param-description">
7612
<li>YUI sandbox id.</li>
7621
<code class="param-name">uid</code>
7622
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
7627
<div class="param-description">
7629
<li>IO instance id.</li>
7646
<div id="method_xdrResponse" class="method item">
7647
<h3 class="name"><code>xdrResponse</code></h3>
7651
<span class="paren">(</span><ul class="args-list inline commas">
7671
</ul><span class="paren">)</span>
7676
<span class="returns-inline">
7677
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7695
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
7704
<a href="../files/io_js_io-xdr.js.html#l205"><code>io/js/io-xdr.js:205</code></a>
7714
<div class="description">
7715
<p>Response controller for cross-domain requests when using the
7716
Flash transport or IE8's XDomainRequest object.</p>
7720
<div class="params">
7721
<h4>Parameters:</h4>
7723
<ul class="params-list">
7727
<code class="param-name">e</code>
7728
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7733
<div class="param-description">
7742
<code class="param-name">o</code>
7743
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7748
<div class="param-description">
7749
<p>Transaction object generated by _create() in io-base.</p>
7757
<code class="param-name">c</code>
7758
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7763
<div class="param-description">
7764
<p>Configuration object for the transaction.</p>
7775
<div class="returns">
7778
<div class="returns-description">
7781
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
7796
<div id="properties" class="api-class-tabpanel">
7797
<h2 class="off-left">Properties</h2>
7800
<div id="property__cB" class="property item private">
7801
<h3 class="name"><code>_cB</code></h3>
7802
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7807
<span class="flag private">private</span>
7818
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
7827
<a href="../files/io_js_io-xdr.js.html#l15"><code>io/js/io-xdr.js:15</code></a>
7836
<div class="description">
7837
<p>Map of stored configuration objects when using
7838
Flash as the transport for cross-domain requests.</p>
7849
<div id="property__default" class="property item">
7850
<h3 class="name"><code>_default</code></h3>
7851
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7860
<span class="flag static">static</span>
7867
<p>Provided by the <a href="../modules/io.html">io</a> module.</p>
7876
<a href="../files/io_js_transports.js.html#l7"><code>io/js/transports.js:7</code></a>
7885
<div class="description">
7886
<p>The ID of the default IO transport, defaults to <code>xhr</code></p>
7897
<div id="property__headers" class="property item private">
7898
<h3 class="name"><code>_headers</code></h3>
7899
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7904
<span class="flag private">private</span>
7915
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
7924
<a href="../files/io_js_io-base.js.html#l51"><code>io/js/io-base.js:51</code></a>
7933
<div class="description">
7934
<p>Object of IO HTTP headers sent with each transaction.</p>
7945
<div id="property__id" class="property item private">
7946
<h3 class="name"><code>_id</code></h3>
7947
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
7952
<span class="flag private">private</span>
7963
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
7972
<a href="../files/io_js_io-base.js.html#l42"><code>io/js/io-base.js:42</code></a>
7981
<div class="description">
7982
<p>A counter that increments for each transaction.</p>
7993
<div id="property__q" class="property item private">
7994
<h3 class="name"><code>_q</code></h3>
7995
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8000
<span class="flag private">private</span>
8006
<span class="flag static">static</span>
8013
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
8022
<a href="../files/io_js_io-queue.js.html#l11"><code>io/js/io-queue.js:11</code></a>
8031
<div class="description">
8032
<p>Array of transactions queued for processing</p>
8043
<div id="property__qState" class="property item private">
8044
<h3 class="name"><code>_qState</code></h3>
8045
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
8050
<span class="flag private">private</span>
8056
<span class="flag static">static</span>
8063
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
8072
<a href="../files/io_js_io-queue.js.html#l22"><code>io/js/io-queue.js:22</code></a>
8081
<div class="description">
8082
<p>Property to determine whether the queue is set to
8083
1 (active) or 0 (inactive). When inactive, transactions
8084
will be stored in the queue until the queue is set to active.</p>
8095
<div id="property__rS" class="property item private">
8096
<h3 class="name"><code>_rS</code></h3>
8097
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8102
<span class="flag private">private</span>
8113
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
8122
<a href="../files/io_js_io-xdr.js.html#l25"><code>io/js/io-xdr.js:25</code></a>
8131
<div class="description">
8132
<p>Map of transaction simulated readyState values
8133
when XDomainRequest is the transport.</p>
8144
<div id="property__timeout" class="property item private">
8145
<h3 class="name"><code>_timeout</code></h3>
8146
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8151
<span class="flag private">private</span>
8162
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
8171
<a href="../files/io_js_io-base.js.html#l62"><code>io/js/io-base.js:62</code></a>
8180
<div class="description">
8181
<p>Object that stores timeout values for any transaction with a defined
8182
"timeout" configuration property.</p>
8193
<div id="property__transport" class="property item private">
8194
<h3 class="name"><code>_transport</code></h3>
8195
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8200
<span class="flag private">private</span>
8211
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
8220
<a href="../files/io_js_io-xdr.js.html#l113"><code>io/js/io-xdr.js:113</code></a>
8229
<div class="description">
8230
<p>Map of io transports.</p>
8241
<div id="property_delay" class="property item">
8242
<h3 class="name"><code>delay</code></h3>
8243
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
8252
<span class="flag static">static</span>
8259
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
8268
<a href="../files/io_js_io-xdr.js.html#l297"><code>io/js/io-xdr.js:297</code></a>
8277
<div class="description">
8278
<p>Delay value to calling the Flash transport, in the
8279
event io.swf has not finished loading. Once the E<em>XDR</em>READY
8280
event is fired, this value will be set to 0.</p>
8291
<div id="property_transports" class="property item">
8292
<h3 class="name"><code>transports</code></h3>
8293
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8302
<span class="flag static">static</span>
8309
<p>Provided by the <a href="../modules/io.html">io</a> module.</p>
8318
<a href="../files/io_js_transports.js.html#l34"><code>io/js/transports.js:34</code></a>
8327
<div class="description">
8328
<p>An object hash of custom transports available to IO</p>
8345
<div id="events" class="api-class-tabpanel">
8346
<h2 class="off-left">Events</h2>
8349
<div id="event_io:complete" class="events item">
8350
<h3 class="name"><code>io:complete</code></h3>
8351
<span class="type"></span>
8365
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
8374
<a href="../files/io_js_io-base.js.html#l252"><code>io/js/io-base.js:252</code></a>
8383
<div class="description">
8384
<p>Signals the completion of the request-response phase of a
8385
transaction. Response status and data are accessible, if
8386
available, in this event.</p>
8396
<div id="event_io:end" class="events item">
8397
<h3 class="name"><code>io:end</code></h3>
8398
<span class="type"></span>
8412
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
8421
<a href="../files/io_js_io-base.js.html#l270"><code>io/js/io-base.js:270</code></a>
8430
<div class="description">
8431
<p>Signals the end of the transaction lifecycle.</p>
8441
<div id="event_io:failure" class="events item">
8442
<h3 class="name"><code>io:failure</code></h3>
8443
<span class="type"></span>
8457
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
8466
<a href="../files/io_js_io-base.js.html#l305"><code>io/js/io-base.js:305</code></a>
8475
<div class="description">
8476
<p>Signals an HTTP response with status outside of the 2xx range.
8477
Fires after io:complete.</p>
8487
<div id="event_io:progress" class="events item">
8488
<h3 class="name"><code>io:progress</code></h3>
8489
<span class="type"></span>
8503
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
8512
<a href="../files/io_js_io-base.js.html#l325"><code>io/js/io-base.js:325</code></a>
8521
<div class="description">
8522
<p>Signals the interactive state during a file upload transaction.
8523
This event fires after io:start and before io:complete.</p>
8533
<div id="event_io:start" class="events item">
8534
<h3 class="name"><code>io:start</code></h3>
8535
<span class="type"></span>
8549
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
8558
<a href="../files/io_js_io-base.js.html#l235"><code>io/js/io-base.js:235</code></a>
8567
<div class="description">
8568
<p>Signals the start of an IO request.</p>
8578
<div id="event_io:success" class="events item">
8579
<h3 class="name"><code>io:success</code></h3>
8580
<span class="type"></span>
8594
<p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
8603
<a href="../files/io_js_io-base.js.html#l287"><code>io/js/io-base.js:287</code></a>
8612
<div class="description">
8613
<p>Signals an HTTP response with status in the 2xx range.
8614
Fires after io:complete.</p>
8624
<div id="event_io:xdrReady" class="events item">
8625
<h3 class="name"><code>io:xdrReady</code></h3>
8626
<span class="type"></span>
8640
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
8649
<a href="../files/io_js_io-xdr.js.html#l9"><code>io/js/io-xdr.js:9</code></a>
8658
<div class="description">
8659
<p>Fires when the XDR transport is ready for use.</p>
8680
<script src="../assets/vendor/prettify/prettify-min.js"></script>
8681
<script>prettyPrint();</script>
8682
<script src="../assets/js/yui-prettify.js"></script>
8683
<script src="../assets/../api.js"></script>
8684
<script src="../assets/js/api-filter.js"></script>
8685
<script src="../assets/js/api-list.js"></script>
8686
<script src="../assets/js/api-search.js"></script>
8687
<script src="../assets/js/apidocs.js"></script>