--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/cm/media/js/lib/yui/yui_3.10.3/api/classes/YUI.html Tue Jul 16 14:29:46 2013 +0200
@@ -0,0 +1,13582 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <title>YUI - YUI 3</title>
+ <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
+ <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
+ <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
+ <link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
+ <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
+</head>
+<body class="yui3-skin-sam">
+
+<div id="doc">
+ <div id="hd" class="yui3-g header">
+ <div class="yui3-u-3-4">
+
+ <h1><img src="../assets/css/logo.png" title="YUI 3"></h1>
+
+ </div>
+ <div class="yui3-u-1-4 version">
+ <em>API Docs for: 3.10.3</em>
+ </div>
+ </div>
+ <div id="bd" class="yui3-g">
+
+ <div class="yui3-u-1-4">
+ <div id="docs-sidebar" class="sidebar apidocs">
+ <div id="api-list">
+ <h2 class="off-left">APIs</h2>
+ <div id="api-tabview" class="tabview">
+ <ul class="tabs">
+ <li><a href="#api-classes">Classes</a></li>
+ <li><a href="#api-modules">Modules</a></li>
+ </ul>
+
+ <div id="api-tabview-filter">
+ <input type="search" id="api-filter" placeholder="Type to filter APIs">
+ </div>
+
+ <div id="api-tabview-panel">
+ <ul id="api-classes" class="apis classes">
+
+ <li><a href="../classes/Anim.html">Anim</a></li>
+
+ <li><a href="../classes/App.html">App</a></li>
+
+ <li><a href="../classes/App.Base.html">App.Base</a></li>
+
+ <li><a href="../classes/App.Content.html">App.Content</a></li>
+
+ <li><a href="../classes/App.Transitions.html">App.Transitions</a></li>
+
+ <li><a href="../classes/App.TransitionsNative.html">App.TransitionsNative</a></li>
+
+ <li><a href="../classes/AreaSeries.html">AreaSeries</a></li>
+
+ <li><a href="../classes/AreaSplineSeries.html">AreaSplineSeries</a></li>
+
+ <li><a href="../classes/Array.html">Array</a></li>
+
+ <li><a href="../classes/ArrayList.html">ArrayList</a></li>
+
+ <li><a href="../classes/ArraySort.html">ArraySort</a></li>
+
+ <li><a href="../classes/AsyncQueue.html">AsyncQueue</a></li>
+
+ <li><a href="../classes/Attribute.html">Attribute</a></li>
+
+ <li><a href="../classes/AttributeCore.html">AttributeCore</a></li>
+
+ <li><a href="../classes/AttributeEvents.html">AttributeEvents</a></li>
+
+ <li><a href="../classes/AttributeExtras.html">AttributeExtras</a></li>
+
+ <li><a href="../classes/AttributeLite.html">AttributeLite</a></li>
+
+ <li><a href="../classes/AttributeObservable.html">AttributeObservable</a></li>
+
+ <li><a href="../classes/AutoComplete.html">AutoComplete</a></li>
+
+ <li><a href="../classes/AutoCompleteBase.html">AutoCompleteBase</a></li>
+
+ <li><a href="../classes/AutoCompleteFilters.html">AutoCompleteFilters</a></li>
+
+ <li><a href="../classes/AutoCompleteHighlighters.html">AutoCompleteHighlighters</a></li>
+
+ <li><a href="../classes/AutoCompleteList.html">AutoCompleteList</a></li>
+
+ <li><a href="../classes/Axis.html">Axis</a></li>
+
+ <li><a href="../classes/AxisBase.html">AxisBase</a></li>
+
+ <li><a href="../classes/BarSeries.html">BarSeries</a></li>
+
+ <li><a href="../classes/Base.html">Base</a></li>
+
+ <li><a href="../classes/BaseCore.html">BaseCore</a></li>
+
+ <li><a href="../classes/BaseObservable.html">BaseObservable</a></li>
+
+ <li><a href="../classes/BottomAxisLayout.html">BottomAxisLayout</a></li>
+
+ <li><a href="../classes/Button.html">Button</a></li>
+
+ <li><a href="../classes/ButtonCore.html">ButtonCore</a></li>
+
+ <li><a href="../classes/ButtonGroup.html">ButtonGroup</a></li>
+
+ <li><a href="../classes/Cache.html">Cache</a></li>
+
+ <li><a href="../classes/CacheOffline.html">CacheOffline</a></li>
+
+ <li><a href="../classes/Calendar.html">Calendar</a></li>
+
+ <li><a href="../classes/CalendarBase.html">CalendarBase</a></li>
+
+ <li><a href="../classes/CandlestickSeries.html">CandlestickSeries</a></li>
+
+ <li><a href="../classes/CanvasCircle.html">CanvasCircle</a></li>
+
+ <li><a href="../classes/CanvasDrawing.html">CanvasDrawing</a></li>
+
+ <li><a href="../classes/CanvasEllipse.html">CanvasEllipse</a></li>
+
+ <li><a href="../classes/CanvasGraphic.html">CanvasGraphic</a></li>
+
+ <li><a href="../classes/CanvasPath.html">CanvasPath</a></li>
+
+ <li><a href="../classes/CanvasPieSlice.html">CanvasPieSlice</a></li>
+
+ <li><a href="../classes/CanvasRect.html">CanvasRect</a></li>
+
+ <li><a href="../classes/CanvasShape.html">CanvasShape</a></li>
+
+ <li><a href="../classes/CartesianChart.html">CartesianChart</a></li>
+
+ <li><a href="../classes/CartesianSeries.html">CartesianSeries</a></li>
+
+ <li><a href="../classes/CategoryAxis.html">CategoryAxis</a></li>
+
+ <li><a href="../classes/CategoryAxisBase.html">CategoryAxisBase</a></li>
+
+ <li><a href="../classes/CategoryImpl.html">CategoryImpl</a></li>
+
+ <li><a href="../classes/Chart.html">Chart</a></li>
+
+ <li><a href="../classes/ChartBase.html">ChartBase</a></li>
+
+ <li><a href="../classes/ChartLegend.html">ChartLegend</a></li>
+
+ <li><a href="../classes/Circle.html">Circle</a></li>
+
+ <li><a href="../classes/CircleGroup.html">CircleGroup</a></li>
+
+ <li><a href="../classes/ClassNameManager.html">ClassNameManager</a></li>
+
+ <li><a href="../classes/ClickableRail.html">ClickableRail</a></li>
+
+ <li><a href="../classes/Color.html">Color</a></li>
+
+ <li><a href="../classes/Color.Harmony.html">Color.Harmony</a></li>
+
+ <li><a href="../classes/Color.HSL.html">Color.HSL</a></li>
+
+ <li><a href="../classes/Color.HSV.html">Color.HSV</a></li>
+
+ <li><a href="../classes/ColumnSeries.html">ColumnSeries</a></li>
+
+ <li><a href="../classes/ComboSeries.html">ComboSeries</a></li>
+
+ <li><a href="../classes/ComboSplineSeries.html">ComboSplineSeries</a></li>
+
+ <li><a href="../classes/config.html">config</a></li>
+
+ <li><a href="../classes/Console.html">Console</a></li>
+
+ <li><a href="../classes/Controller.html">Controller</a></li>
+
+ <li><a href="../classes/Cookie.html">Cookie</a></li>
+
+ <li><a href="../classes/CurveUtil.html">CurveUtil</a></li>
+
+ <li><a href="../classes/CustomEvent.html">CustomEvent</a></li>
+
+ <li><a href="../classes/DataSchema.Array.html">DataSchema.Array</a></li>
+
+ <li><a href="../classes/DataSchema.Base.html">DataSchema.Base</a></li>
+
+ <li><a href="../classes/DataSchema.JSON.html">DataSchema.JSON</a></li>
+
+ <li><a href="../classes/DataSchema.Text.html">DataSchema.Text</a></li>
+
+ <li><a href="../classes/DataSchema.XML.html">DataSchema.XML</a></li>
+
+ <li><a href="../classes/DataSource.Function.html">DataSource.Function</a></li>
+
+ <li><a href="../classes/DataSource.Get.html">DataSource.Get</a></li>
+
+ <li><a href="../classes/DataSource.IO.html">DataSource.IO</a></li>
+
+ <li><a href="../classes/DataSource.Local.html">DataSource.Local</a></li>
+
+ <li><a href="../classes/DataSourceArraySchema.html">DataSourceArraySchema</a></li>
+
+ <li><a href="../classes/DataSourceCache.html">DataSourceCache</a></li>
+
+ <li><a href="../classes/DataSourceCacheExtension.html">DataSourceCacheExtension</a></li>
+
+ <li><a href="../classes/DataSourceJSONSchema.html">DataSourceJSONSchema</a></li>
+
+ <li><a href="../classes/DataSourceTextSchema.html">DataSourceTextSchema</a></li>
+
+ <li><a href="../classes/DataSourceXMLSchema.html">DataSourceXMLSchema</a></li>
+
+ <li><a href="../classes/DataTable.html">DataTable</a></li>
+
+ <li><a href="../classes/DataTable.Base.html">DataTable.Base</a></li>
+
+ <li><a href="../classes/DataTable.BodyView.html">DataTable.BodyView</a></li>
+
+ <li><a href="../classes/DataTable.BodyView.Formatters.html">DataTable.BodyView.Formatters</a></li>
+
+ <li><a href="../classes/DataTable.ColumnWidths.html">DataTable.ColumnWidths</a></li>
+
+ <li><a href="../classes/DataTable.Core.html">DataTable.Core</a></li>
+
+ <li><a href="../classes/DataTable.HeaderView.html">DataTable.HeaderView</a></li>
+
+ <li><a href="../classes/DataTable.Message.html">DataTable.Message</a></li>
+
+ <li><a href="../classes/DataTable.Mutable.html">DataTable.Mutable</a></li>
+
+ <li><a href="../classes/DataTable.Scrollable.html">DataTable.Scrollable</a></li>
+
+ <li><a href="../classes/DataTable.Sortable.html">DataTable.Sortable</a></li>
+
+ <li><a href="../classes/DataTable.TableView.html">DataTable.TableView</a></li>
+
+ <li><a href="../classes/Date.html">Date</a></li>
+
+ <li><a href="../classes/DD.DDM.html">DD.DDM</a></li>
+
+ <li><a href="../classes/DD.Delegate.html">DD.Delegate</a></li>
+
+ <li><a href="../classes/DD.Drag.html">DD.Drag</a></li>
+
+ <li><a href="../classes/DD.Drop.html">DD.Drop</a></li>
+
+ <li><a href="../classes/DD.Scroll.html">DD.Scroll</a></li>
+
+ <li><a href="../classes/Dial.html">Dial</a></li>
+
+ <li><a href="../classes/Do.html">Do</a></li>
+
+ <li><a href="../classes/Do.AlterArgs.html">Do.AlterArgs</a></li>
+
+ <li><a href="../classes/Do.AlterReturn.html">Do.AlterReturn</a></li>
+
+ <li><a href="../classes/Do.Error.html">Do.Error</a></li>
+
+ <li><a href="../classes/Do.Halt.html">Do.Halt</a></li>
+
+ <li><a href="../classes/Do.Method.html">Do.Method</a></li>
+
+ <li><a href="../classes/Do.Prevent.html">Do.Prevent</a></li>
+
+ <li><a href="../classes/DOM.html">DOM</a></li>
+
+ <li><a href="../classes/DOMEventFacade.html">DOMEventFacade</a></li>
+
+ <li><a href="../classes/Drawing.html">Drawing</a></li>
+
+ <li><a href="../classes/Easing.html">Easing</a></li>
+
+ <li><a href="../classes/EditorBase.html">EditorBase</a></li>
+
+ <li><a href="../classes/EditorSelection.html">EditorSelection</a></li>
+
+ <li><a href="../classes/Ellipse.html">Ellipse</a></li>
+
+ <li><a href="../classes/EllipseGroup.html">EllipseGroup</a></li>
+
+ <li><a href="../classes/Escape.html">Escape</a></li>
+
+ <li><a href="../classes/Event.html">Event</a></li>
+
+ <li><a href="../classes/EventFacade.html">EventFacade</a></li>
+
+ <li><a href="../classes/EventHandle.html">EventHandle</a></li>
+
+ <li><a href="../classes/EventTarget.html">EventTarget</a></li>
+
+ <li><a href="../classes/ExecCommand.html">ExecCommand</a></li>
+
+ <li><a href="../classes/Features.html">Features</a></li>
+
+ <li><a href="../classes/File.html">File</a></li>
+
+ <li><a href="../classes/FileFlash.html">FileFlash</a></li>
+
+ <li><a href="../classes/FileHTML5.html">FileHTML5</a></li>
+
+ <li><a href="../classes/Fills.html">Fills</a></li>
+
+ <li><a href="../classes/Frame.html">Frame</a></li>
+
+ <li><a href="../classes/Get.html">Get</a></li>
+
+ <li><a href="../classes/Get.Transaction.html">Get.Transaction</a></li>
+
+ <li><a href="../classes/GetNodeJS.html">GetNodeJS</a></li>
+
+ <li><a href="../classes/Graph.html">Graph</a></li>
+
+ <li><a href="../classes/Graphic.html">Graphic</a></li>
+
+ <li><a href="../classes/GraphicBase.html">GraphicBase</a></li>
+
+ <li><a href="../classes/Gridlines.html">Gridlines</a></li>
+
+ <li><a href="../classes/GroupDiamond.html">GroupDiamond</a></li>
+
+ <li><a href="../classes/GroupRect.html">GroupRect</a></li>
+
+ <li><a href="../classes/Handlebars.html">Handlebars</a></li>
+
+ <li><a href="../classes/Highlight.html">Highlight</a></li>
+
+ <li><a href="../classes/Histogram.html">Histogram</a></li>
+
+ <li><a href="../classes/HistoryBase.html">HistoryBase</a></li>
+
+ <li><a href="../classes/HistoryHash.html">HistoryHash</a></li>
+
+ <li><a href="../classes/HistoryHTML5.html">HistoryHTML5</a></li>
+
+ <li><a href="../classes/HorizontalLegendLayout.html">HorizontalLegendLayout</a></li>
+
+ <li><a href="../classes/ImgLoadGroup.html">ImgLoadGroup</a></li>
+
+ <li><a href="../classes/ImgLoadImgObj.html">ImgLoadImgObj</a></li>
+
+ <li><a href="../classes/Intl.html">Intl</a></li>
+
+ <li><a href="../classes/IO.html">IO</a></li>
+
+ <li><a href="../classes/JSON.html">JSON</a></li>
+
+ <li><a href="../classes/JSONPRequest.html">JSONPRequest</a></li>
+
+ <li><a href="../classes/Lang.html">Lang</a></li>
+
+ <li><a href="../classes/LazyModelList.html">LazyModelList</a></li>
+
+ <li><a href="../classes/LeftAxisLayout.html">LeftAxisLayout</a></li>
+
+ <li><a href="../classes/Lines.html">Lines</a></li>
+
+ <li><a href="../classes/LineSeries.html">LineSeries</a></li>
+
+ <li><a href="../classes/Loader.html">Loader</a></li>
+
+ <li><a href="../classes/MarkerSeries.html">MarkerSeries</a></li>
+
+ <li><a href="../classes/Matrix.html">Matrix</a></li>
+
+ <li><a href="../classes/MatrixUtil.html">MatrixUtil</a></li>
+
+ <li><a href="../classes/Model.html">Model</a></li>
+
+ <li><a href="../classes/ModelList.html">ModelList</a></li>
+
+ <li><a href="../classes/ModelSync.REST.html">ModelSync.REST</a></li>
+
+ <li><a href="../classes/Node.html">Node</a></li>
+
+ <li><a href="../classes/NodeList.html">NodeList</a></li>
+
+ <li><a href="../classes/Number.html">Number</a></li>
+
+ <li><a href="../classes/NumericAxis.html">NumericAxis</a></li>
+
+ <li><a href="../classes/NumericAxisBase.html">NumericAxisBase</a></li>
+
+ <li><a href="../classes/NumericImpl.html">NumericImpl</a></li>
+
+ <li><a href="../classes/Object.html">Object</a></li>
+
+ <li><a href="../classes/OHLCSeries.html">OHLCSeries</a></li>
+
+ <li><a href="../classes/Overlay.html">Overlay</a></li>
+
+ <li><a href="../classes/Panel.html">Panel</a></li>
+
+ <li><a href="../classes/Parallel.html">Parallel</a></li>
+
+ <li><a href="../classes/Path.html">Path</a></li>
+
+ <li><a href="../classes/PieChart.html">PieChart</a></li>
+
+ <li><a href="../classes/PieSeries.html">PieSeries</a></li>
+
+ <li><a href="../classes/Pjax.html">Pjax</a></li>
+
+ <li><a href="../classes/PjaxBase.html">PjaxBase</a></li>
+
+ <li><a href="../classes/PjaxContent.html">PjaxContent</a></li>
+
+ <li><a href="../classes/Plots.html">Plots</a></li>
+
+ <li><a href="../classes/Plugin.Align.html">Plugin.Align</a></li>
+
+ <li><a href="../classes/Plugin.AutoComplete.html">Plugin.AutoComplete</a></li>
+
+ <li><a href="../classes/Plugin.Base.html">Plugin.Base</a></li>
+
+ <li><a href="../classes/Plugin.Button.html">Plugin.Button</a></li>
+
+ <li><a href="../classes/Plugin.Cache.html">Plugin.Cache</a></li>
+
+ <li><a href="../classes/Plugin.CalendarNavigator.html">Plugin.CalendarNavigator</a></li>
+
+ <li><a href="../classes/Plugin.ConsoleFilters.html">Plugin.ConsoleFilters</a></li>
+
+ <li><a href="../classes/Plugin.CreateLinkBase.html">Plugin.CreateLinkBase</a></li>
+
+ <li><a href="../classes/Plugin.DataTableDataSource.html">Plugin.DataTableDataSource</a></li>
+
+ <li><a href="../classes/Plugin.DDConstrained.html">Plugin.DDConstrained</a></li>
+
+ <li><a href="../classes/Plugin.DDNodeScroll.html">Plugin.DDNodeScroll</a></li>
+
+ <li><a href="../classes/Plugin.DDProxy.html">Plugin.DDProxy</a></li>
+
+ <li><a href="../classes/Plugin.DDWindowScroll.html">Plugin.DDWindowScroll</a></li>
+
+ <li><a href="../classes/Plugin.Drag.html">Plugin.Drag</a></li>
+
+ <li><a href="../classes/Plugin.Drop.html">Plugin.Drop</a></li>
+
+ <li><a href="../classes/Plugin.EditorBidi.html">Plugin.EditorBidi</a></li>
+
+ <li><a href="../classes/Plugin.EditorBR.html">Plugin.EditorBR</a></li>
+
+ <li><a href="../classes/Plugin.EditorLists.html">Plugin.EditorLists</a></li>
+
+ <li><a href="../classes/Plugin.EditorPara.html">Plugin.EditorPara</a></li>
+
+ <li><a href="../classes/Plugin.EditorParaBase.html">Plugin.EditorParaBase</a></li>
+
+ <li><a href="../classes/Plugin.EditorParaIE.html">Plugin.EditorParaIE</a></li>
+
+ <li><a href="../classes/Plugin.EditorTab.html">Plugin.EditorTab</a></li>
+
+ <li><a href="../classes/Plugin.ExecCommand.html">Plugin.ExecCommand</a></li>
+
+ <li><a href="../classes/Plugin.Flick.html">Plugin.Flick</a></li>
+
+ <li><a href="../classes/Plugin.Host.html">Plugin.Host</a></li>
+
+ <li><a href="../classes/plugin.NodeFocusManager.html">plugin.NodeFocusManager</a></li>
+
+ <li><a href="../classes/Plugin.NodeFX.html">Plugin.NodeFX</a></li>
+
+ <li><a href="../classes/plugin.NodeMenuNav.html">plugin.NodeMenuNav</a></li>
+
+ <li><a href="../classes/Plugin.Pjax.html">Plugin.Pjax</a></li>
+
+ <li><a href="../classes/Plugin.Resize.html">Plugin.Resize</a></li>
+
+ <li><a href="../classes/Plugin.ResizeConstrained.html">Plugin.ResizeConstrained</a></li>
+
+ <li><a href="../classes/Plugin.ResizeProxy.html">Plugin.ResizeProxy</a></li>
+
+ <li><a href="../classes/Plugin.ScrollInfo.html">Plugin.ScrollInfo</a></li>
+
+ <li><a href="../classes/Plugin.ScrollViewList.html">Plugin.ScrollViewList</a></li>
+
+ <li><a href="../classes/Plugin.ScrollViewPaginator.html">Plugin.ScrollViewPaginator</a></li>
+
+ <li><a href="../classes/Plugin.ScrollViewScrollbars.html">Plugin.ScrollViewScrollbars</a></li>
+
+ <li><a href="../classes/Plugin.Shim.html">Plugin.Shim</a></li>
+
+ <li><a href="../classes/Plugin.SortScroll.html">Plugin.SortScroll</a></li>
+
+ <li><a href="../classes/Plugin.Tree.Lazy.html">Plugin.Tree.Lazy</a></li>
+
+ <li><a href="../classes/Plugin.WidgetAnim.html">Plugin.WidgetAnim</a></li>
+
+ <li><a href="../classes/Pollable.html">Pollable</a></li>
+
+ <li><a href="../classes/Promise.html">Promise</a></li>
+
+ <li><a href="../classes/Promise.Resolver.html">Promise.Resolver</a></li>
+
+ <li><a href="../classes/QueryString.html">QueryString</a></li>
+
+ <li><a href="../classes/Queue.html">Queue</a></li>
+
+ <li><a href="../classes/RangeSeries.html">RangeSeries</a></li>
+
+ <li><a href="../classes/Record.html">Record</a></li>
+
+ <li><a href="../classes/Recordset.html">Recordset</a></li>
+
+ <li><a href="../classes/RecordsetFilter.html">RecordsetFilter</a></li>
+
+ <li><a href="../classes/RecordsetIndexer.html">RecordsetIndexer</a></li>
+
+ <li><a href="../classes/RecordsetSort.html">RecordsetSort</a></li>
+
+ <li><a href="../classes/Rect.html">Rect</a></li>
+
+ <li><a href="../classes/Renderer.html">Renderer</a></li>
+
+ <li><a href="../classes/Resize.html">Resize</a></li>
+
+ <li><a href="../classes/RightAxisLayout.html">RightAxisLayout</a></li>
+
+ <li><a href="../classes/Router.html">Router</a></li>
+
+ <li><a href="../classes/ScrollView.html">ScrollView</a></li>
+
+ <li><a href="../classes/Selector.html">Selector</a></li>
+
+ <li><a href="../classes/SeriesBase.html">SeriesBase</a></li>
+
+ <li><a href="../classes/Shape.html">Shape</a></li>
+
+ <li><a href="../classes/ShapeGroup.html">ShapeGroup</a></li>
+
+ <li><a href="../classes/Slider.html">Slider</a></li>
+
+ <li><a href="../classes/SliderBase.html">SliderBase</a></li>
+
+ <li><a href="../classes/SliderValueRange.html">SliderValueRange</a></li>
+
+ <li><a href="../classes/soon.html">soon</a></li>
+
+ <li><a href="../classes/Sortable.html">Sortable</a></li>
+
+ <li><a href="../classes/SplineSeries.html">SplineSeries</a></li>
+
+ <li><a href="../classes/StackedAreaSeries.html">StackedAreaSeries</a></li>
+
+ <li><a href="../classes/StackedAreaSplineSeries.html">StackedAreaSplineSeries</a></li>
+
+ <li><a href="../classes/StackedAxis.html">StackedAxis</a></li>
+
+ <li><a href="../classes/StackedAxisBase.html">StackedAxisBase</a></li>
+
+ <li><a href="../classes/StackedBarSeries.html">StackedBarSeries</a></li>
+
+ <li><a href="../classes/StackedColumnSeries.html">StackedColumnSeries</a></li>
+
+ <li><a href="../classes/StackedComboSeries.html">StackedComboSeries</a></li>
+
+ <li><a href="../classes/StackedComboSplineSeries.html">StackedComboSplineSeries</a></li>
+
+ <li><a href="../classes/StackedImpl.html">StackedImpl</a></li>
+
+ <li><a href="../classes/StackedLineSeries.html">StackedLineSeries</a></li>
+
+ <li><a href="../classes/StackedMarkerSeries.html">StackedMarkerSeries</a></li>
+
+ <li><a href="../classes/StackedSplineSeries.html">StackedSplineSeries</a></li>
+
+ <li><a href="../classes/StackingUtil.html">StackingUtil</a></li>
+
+ <li><a href="../classes/State.html">State</a></li>
+
+ <li><a href="../classes/StyleSheet.html">StyleSheet</a></li>
+
+ <li><a href="../classes/Subscriber.html">Subscriber</a></li>
+
+ <li><a href="../classes/SVGCircle.html">SVGCircle</a></li>
+
+ <li><a href="../classes/SVGDrawing.html">SVGDrawing</a></li>
+
+ <li><a href="../classes/SVGEllipse.html">SVGEllipse</a></li>
+
+ <li><a href="../classes/SVGGraphic.html">SVGGraphic</a></li>
+
+ <li><a href="../classes/SVGPath.html">SVGPath</a></li>
+
+ <li><a href="../classes/SVGPieSlice.html">SVGPieSlice</a></li>
+
+ <li><a href="../classes/SVGRect.html">SVGRect</a></li>
+
+ <li><a href="../classes/SVGShape.html">SVGShape</a></li>
+
+ <li><a href="../classes/SWF.html">SWF</a></li>
+
+ <li><a href="../classes/SWFDetect.html">SWFDetect</a></li>
+
+ <li><a href="../classes/SyntheticEvent.html">SyntheticEvent</a></li>
+
+ <li><a href="../classes/SyntheticEvent.Notifier.html">SyntheticEvent.Notifier</a></li>
+
+ <li><a href="../classes/SynthRegistry.html">SynthRegistry</a></li>
+
+ <li><a href="../classes/Tab.html">Tab</a></li>
+
+ <li><a href="../classes/TabView.html">TabView</a></li>
+
+ <li><a href="../classes/Template.html">Template</a></li>
+
+ <li><a href="../classes/Template.Micro.html">Template.Micro</a></li>
+
+ <li><a href="../classes/Test.ArrayAssert.html">Test.ArrayAssert</a></li>
+
+ <li><a href="../classes/Test.Assert.html">Test.Assert</a></li>
+
+ <li><a href="../classes/Test.AssertionError.html">Test.AssertionError</a></li>
+
+ <li><a href="../classes/Test.ComparisonFailure.html">Test.ComparisonFailure</a></li>
+
+ <li><a href="../classes/Test.Console.html">Test.Console</a></li>
+
+ <li><a href="../classes/Test.CoverageFormat.html">Test.CoverageFormat</a></li>
+
+ <li><a href="../classes/Test.DateAssert.html">Test.DateAssert</a></li>
+
+ <li><a href="../classes/Test.EventTarget.html">Test.EventTarget</a></li>
+
+ <li><a href="../classes/Test.Mock.html">Test.Mock</a></li>
+
+ <li><a href="../classes/Test.Mock.Value.html">Test.Mock.Value</a></li>
+
+ <li><a href="../classes/Test.ObjectAssert.html">Test.ObjectAssert</a></li>
+
+ <li><a href="../classes/Test.Reporter.html">Test.Reporter</a></li>
+
+ <li><a href="../classes/Test.Results.html">Test.Results</a></li>
+
+ <li><a href="../classes/Test.Runner.html">Test.Runner</a></li>
+
+ <li><a href="../classes/Test.ShouldError.html">Test.ShouldError</a></li>
+
+ <li><a href="../classes/Test.ShouldFail.html">Test.ShouldFail</a></li>
+
+ <li><a href="../classes/Test.TestCase.html">Test.TestCase</a></li>
+
+ <li><a href="../classes/Test.TestFormat.html">Test.TestFormat</a></li>
+
+ <li><a href="../classes/Test.TestNode.html">Test.TestNode</a></li>
+
+ <li><a href="../classes/Test.TestRunner.html">Test.TestRunner</a></li>
+
+ <li><a href="../classes/Test.TestSuite.html">Test.TestSuite</a></li>
+
+ <li><a href="../classes/Test.UnexpectedError.html">Test.UnexpectedError</a></li>
+
+ <li><a href="../classes/Test.UnexpectedValue.html">Test.UnexpectedValue</a></li>
+
+ <li><a href="../classes/Test.Wait.html">Test.Wait</a></li>
+
+ <li><a href="../classes/Text.AccentFold.html">Text.AccentFold</a></li>
+
+ <li><a href="../classes/Text.WordBreak.html">Text.WordBreak</a></li>
+
+ <li><a href="../classes/TimeAxis.html">TimeAxis</a></li>
+
+ <li><a href="../classes/TimeAxisBase.html">TimeAxisBase</a></li>
+
+ <li><a href="../classes/TimeImpl.html">TimeImpl</a></li>
+
+ <li><a href="../classes/ToggleButton.html">ToggleButton</a></li>
+
+ <li><a href="../classes/TopAxisLayout.html">TopAxisLayout</a></li>
+
+ <li><a href="../classes/Transition.html">Transition</a></li>
+
+ <li><a href="../classes/Tree.html">Tree</a></li>
+
+ <li><a href="../classes/Tree.Labelable.html">Tree.Labelable</a></li>
+
+ <li><a href="../classes/Tree.Node.html">Tree.Node</a></li>
+
+ <li><a href="../classes/Tree.Node.Labelable.html">Tree.Node.Labelable</a></li>
+
+ <li><a href="../classes/Tree.Node.Openable.html">Tree.Node.Openable</a></li>
+
+ <li><a href="../classes/Tree.Node.Selectable.html">Tree.Node.Selectable</a></li>
+
+ <li><a href="../classes/Tree.Node.Sortable.html">Tree.Node.Sortable</a></li>
+
+ <li><a href="../classes/Tree.Openable.html">Tree.Openable</a></li>
+
+ <li><a href="../classes/Tree.Selectable.html">Tree.Selectable</a></li>
+
+ <li><a href="../classes/Tree.Sortable.html">Tree.Sortable</a></li>
+
+ <li><a href="../classes/UA.html">UA</a></li>
+
+ <li><a href="../classes/Uploader.html">Uploader</a></li>
+
+ <li><a href="../classes/Uploader.Queue.html">Uploader.Queue</a></li>
+
+ <li><a href="../classes/UploaderFlash.html">UploaderFlash</a></li>
+
+ <li><a href="../classes/UploaderHTML5.html">UploaderHTML5</a></li>
+
+ <li><a href="../classes/ValueChange.html">ValueChange</a></li>
+
+ <li><a href="../classes/VerticalLegendLayout.html">VerticalLegendLayout</a></li>
+
+ <li><a href="../classes/View.html">View</a></li>
+
+ <li><a href="../classes/View.NodeMap.html">View.NodeMap</a></li>
+
+ <li><a href="../classes/VMLCircle.html">VMLCircle</a></li>
+
+ <li><a href="../classes/VMLDrawing.html">VMLDrawing</a></li>
+
+ <li><a href="../classes/VMLEllipse.html">VMLEllipse</a></li>
+
+ <li><a href="../classes/VMLGraphic.html">VMLGraphic</a></li>
+
+ <li><a href="../classes/VMLPath.html">VMLPath</a></li>
+
+ <li><a href="../classes/VMLPieSlice.html">VMLPieSlice</a></li>
+
+ <li><a href="../classes/VMLRect.html">VMLRect</a></li>
+
+ <li><a href="../classes/VMLShape.html">VMLShape</a></li>
+
+ <li><a href="../classes/Widget.html">Widget</a></li>
+
+ <li><a href="../classes/WidgetAutohide.html">WidgetAutohide</a></li>
+
+ <li><a href="../classes/WidgetButtons.html">WidgetButtons</a></li>
+
+ <li><a href="../classes/WidgetChild.html">WidgetChild</a></li>
+
+ <li><a href="../classes/WidgetModality.html">WidgetModality</a></li>
+
+ <li><a href="../classes/WidgetParent.html">WidgetParent</a></li>
+
+ <li><a href="../classes/WidgetPosition.html">WidgetPosition</a></li>
+
+ <li><a href="../classes/WidgetPositionAlign.html">WidgetPositionAlign</a></li>
+
+ <li><a href="../classes/WidgetPositionConstrain.html">WidgetPositionConstrain</a></li>
+
+ <li><a href="../classes/WidgetStack.html">WidgetStack</a></li>
+
+ <li><a href="../classes/WidgetStdMod.html">WidgetStdMod</a></li>
+
+ <li><a href="../classes/XML.html">XML</a></li>
+
+ <li><a href="../classes/YQL.html">YQL</a></li>
+
+ <li><a href="../classes/YQLRequest.html">YQLRequest</a></li>
+
+ <li><a href="../classes/YUI.html">YUI</a></li>
+
+ <li><a href="../classes/YUI~substitute.html">YUI~substitute</a></li>
+
+ </ul>
+
+ <ul id="api-modules" class="apis modules">
+
+ <li><a href="../modules/align-plugin.html">align-plugin</a></li>
+
+ <li><a href="../modules/anim.html">anim</a></li>
+
+ <li><a href="../modules/anim-base.html">anim-base</a></li>
+
+ <li><a href="../modules/anim-color.html">anim-color</a></li>
+
+ <li><a href="../modules/anim-curve.html">anim-curve</a></li>
+
+ <li><a href="../modules/anim-easing.html">anim-easing</a></li>
+
+ <li><a href="../modules/anim-node-plugin.html">anim-node-plugin</a></li>
+
+ <li><a href="../modules/anim-scroll.html">anim-scroll</a></li>
+
+ <li><a href="../modules/anim-shape.html">anim-shape</a></li>
+
+ <li><a href="../modules/anim-shape-transform.html">anim-shape-transform</a></li>
+
+ <li><a href="../modules/anim-xy.html">anim-xy</a></li>
+
+ <li><a href="../modules/app.html">app</a></li>
+
+ <li><a href="../modules/app-base.html">app-base</a></li>
+
+ <li><a href="../modules/app-content.html">app-content</a></li>
+
+ <li><a href="../modules/app-transitions.html">app-transitions</a></li>
+
+ <li><a href="../modules/app-transitions-native.html">app-transitions-native</a></li>
+
+ <li><a href="../modules/array-extras.html">array-extras</a></li>
+
+ <li><a href="../modules/array-invoke.html">array-invoke</a></li>
+
+ <li><a href="../modules/arraylist.html">arraylist</a></li>
+
+ <li><a href="../modules/arraylist-add.html">arraylist-add</a></li>
+
+ <li><a href="../modules/arraylist-filter.html">arraylist-filter</a></li>
+
+ <li><a href="../modules/arraysort.html">arraysort</a></li>
+
+ <li><a href="../modules/async-queue.html">async-queue</a></li>
+
+ <li><a href="../modules/attribute.html">attribute</a></li>
+
+ <li><a href="../modules/attribute-base.html">attribute-base</a></li>
+
+ <li><a href="../modules/attribute-complex.html">attribute-complex</a></li>
+
+ <li><a href="../modules/attribute-core.html">attribute-core</a></li>
+
+ <li><a href="../modules/attribute-extras.html">attribute-extras</a></li>
+
+ <li><a href="../modules/attribute-observable.html">attribute-observable</a></li>
+
+ <li><a href="../modules/autocomplete.html">autocomplete</a></li>
+
+ <li><a href="../modules/autocomplete-base.html">autocomplete-base</a></li>
+
+ <li><a href="../modules/autocomplete-filters.html">autocomplete-filters</a></li>
+
+ <li><a href="../modules/autocomplete-filters-accentfold.html">autocomplete-filters-accentfold</a></li>
+
+ <li><a href="../modules/autocomplete-highlighters.html">autocomplete-highlighters</a></li>
+
+ <li><a href="../modules/autocomplete-highlighters-accentfold.html">autocomplete-highlighters-accentfold</a></li>
+
+ <li><a href="../modules/autocomplete-list.html">autocomplete-list</a></li>
+
+ <li><a href="../modules/autocomplete-list-keys.html">autocomplete-list-keys</a></li>
+
+ <li><a href="../modules/autocomplete-plugin.html">autocomplete-plugin</a></li>
+
+ <li><a href="../modules/autocomplete-sources.html">autocomplete-sources</a></li>
+
+ <li><a href="../modules/axis.html">axis</a></li>
+
+ <li><a href="../modules/axis-base.html">axis-base</a></li>
+
+ <li><a href="../modules/axis-category.html">axis-category</a></li>
+
+ <li><a href="../modules/axis-category-base.html">axis-category-base</a></li>
+
+ <li><a href="../modules/axis-numeric.html">axis-numeric</a></li>
+
+ <li><a href="../modules/axis-numeric-base.html">axis-numeric-base</a></li>
+
+ <li><a href="../modules/axis-stacked.html">axis-stacked</a></li>
+
+ <li><a href="../modules/axis-stacked-base.html">axis-stacked-base</a></li>
+
+ <li><a href="../modules/axis-time.html">axis-time</a></li>
+
+ <li><a href="../modules/axis-time-base.html">axis-time-base</a></li>
+
+ <li><a href="../modules/base.html">base</a></li>
+
+ <li><a href="../modules/base-base.html">base-base</a></li>
+
+ <li><a href="../modules/base-build.html">base-build</a></li>
+
+ <li><a href="../modules/base-core.html">base-core</a></li>
+
+ <li><a href="../modules/base-observable.html">base-observable</a></li>
+
+ <li><a href="../modules/base-pluginhost.html">base-pluginhost</a></li>
+
+ <li><a href="../modules/button.html">button</a></li>
+
+ <li><a href="../modules/button-core.html">button-core</a></li>
+
+ <li><a href="../modules/button-group.html">button-group</a></li>
+
+ <li><a href="../modules/button-plugin.html">button-plugin</a></li>
+
+ <li><a href="../modules/cache.html">cache</a></li>
+
+ <li><a href="../modules/cache-base.html">cache-base</a></li>
+
+ <li><a href="../modules/cache-offline.html">cache-offline</a></li>
+
+ <li><a href="../modules/cache-plugin.html">cache-plugin</a></li>
+
+ <li><a href="../modules/calendar.html">calendar</a></li>
+
+ <li><a href="../modules/calendar-base.html">calendar-base</a></li>
+
+ <li><a href="../modules/calendarnavigator.html">calendarnavigator</a></li>
+
+ <li><a href="../modules/charts.html">charts</a></li>
+
+ <li><a href="../modules/charts-base.html">charts-base</a></li>
+
+ <li><a href="../modules/charts-legend.html">charts-legend</a></li>
+
+ <li><a href="../modules/classnamemanager.html">classnamemanager</a></li>
+
+ <li><a href="../modules/clickable-rail.html">clickable-rail</a></li>
+
+ <li><a href="../modules/collection.html">collection</a></li>
+
+ <li><a href="../modules/color.html">color</a></li>
+
+ <li><a href="../modules/color-base.html">color-base</a></li>
+
+ <li><a href="../modules/color-harmony.html">color-harmony</a></li>
+
+ <li><a href="../modules/color-hsl.html">color-hsl</a></li>
+
+ <li><a href="../modules/color-hsv.html">color-hsv</a></li>
+
+ <li><a href="../modules/console.html">console</a></li>
+
+ <li><a href="../modules/console-filters.html">console-filters</a></li>
+
+ <li><a href="../modules/cookie.html">cookie</a></li>
+
+ <li><a href="../modules/createlink-base.html">createlink-base</a></li>
+
+ <li><a href="../modules/dataschema.html">dataschema</a></li>
+
+ <li><a href="../modules/dataschema-array.html">dataschema-array</a></li>
+
+ <li><a href="../modules/dataschema-base.html">dataschema-base</a></li>
+
+ <li><a href="../modules/dataschema-json.html">dataschema-json</a></li>
+
+ <li><a href="../modules/dataschema-text.html">dataschema-text</a></li>
+
+ <li><a href="../modules/dataschema-xml.html">dataschema-xml</a></li>
+
+ <li><a href="../modules/datasource.html">datasource</a></li>
+
+ <li><a href="../modules/datasource-arrayschema.html">datasource-arrayschema</a></li>
+
+ <li><a href="../modules/datasource-cache.html">datasource-cache</a></li>
+
+ <li><a href="../modules/datasource-function.html">datasource-function</a></li>
+
+ <li><a href="../modules/datasource-get.html">datasource-get</a></li>
+
+ <li><a href="../modules/datasource-io.html">datasource-io</a></li>
+
+ <li><a href="../modules/datasource-jsonschema.html">datasource-jsonschema</a></li>
+
+ <li><a href="../modules/datasource-local.html">datasource-local</a></li>
+
+ <li><a href="../modules/datasource-polling.html">datasource-polling</a></li>
+
+ <li><a href="../modules/datasource-textschema.html">datasource-textschema</a></li>
+
+ <li><a href="../modules/datasource-xmlschema.html">datasource-xmlschema</a></li>
+
+ <li><a href="../modules/datatable.html">datatable</a></li>
+
+ <li><a href="../modules/datatable-base.html">datatable-base</a></li>
+
+ <li><a href="../modules/datatable-body.html">datatable-body</a></li>
+
+ <li><a href="../modules/datatable-column-widths.html">datatable-column-widths</a></li>
+
+ <li><a href="../modules/datatable-core.html">datatable-core</a></li>
+
+ <li><a href="../modules/datatable-datasource.html">datatable-datasource</a></li>
+
+ <li><a href="../modules/datatable-formatters.html">datatable-formatters</a></li>
+
+ <li><a href="../modules/datatable-head.html">datatable-head</a></li>
+
+ <li><a href="../modules/datatable-message.html">datatable-message</a></li>
+
+ <li><a href="../modules/datatable-mutable.html">datatable-mutable</a></li>
+
+ <li><a href="../modules/datatable-scroll.html">datatable-scroll</a></li>
+
+ <li><a href="../modules/datatable-sort.html">datatable-sort</a></li>
+
+ <li><a href="../modules/datatable-table.html">datatable-table</a></li>
+
+ <li><a href="../modules/datatype.html">datatype</a></li>
+
+ <li><a href="../modules/datatype-date.html">datatype-date</a></li>
+
+ <li><a href="../modules/datatype-date-format.html">datatype-date-format</a></li>
+
+ <li><a href="../modules/datatype-date-math.html">datatype-date-math</a></li>
+
+ <li><a href="../modules/datatype-date-parse.html">datatype-date-parse</a></li>
+
+ <li><a href="../modules/datatype-number.html">datatype-number</a></li>
+
+ <li><a href="../modules/datatype-number-format.html">datatype-number-format</a></li>
+
+ <li><a href="../modules/datatype-number-parse.html">datatype-number-parse</a></li>
+
+ <li><a href="../modules/datatype-xml.html">datatype-xml</a></li>
+
+ <li><a href="../modules/datatype-xml-format.html">datatype-xml-format</a></li>
+
+ <li><a href="../modules/datatype-xml-parse.html">datatype-xml-parse</a></li>
+
+ <li><a href="../modules/dd.html">dd</a></li>
+
+ <li><a href="../modules/dd-constrain.html">dd-constrain</a></li>
+
+ <li><a href="../modules/dd-ddm.html">dd-ddm</a></li>
+
+ <li><a href="../modules/dd-ddm-base.html">dd-ddm-base</a></li>
+
+ <li><a href="../modules/dd-ddm-drop.html">dd-ddm-drop</a></li>
+
+ <li><a href="../modules/dd-delegate.html">dd-delegate</a></li>
+
+ <li><a href="../modules/dd-drag.html">dd-drag</a></li>
+
+ <li><a href="../modules/dd-drop.html">dd-drop</a></li>
+
+ <li><a href="../modules/dd-drop-plugin.html">dd-drop-plugin</a></li>
+
+ <li><a href="../modules/dd-gestures.html">dd-gestures</a></li>
+
+ <li><a href="../modules/dd-plugin.html">dd-plugin</a></li>
+
+ <li><a href="../modules/dd-proxy.html">dd-proxy</a></li>
+
+ <li><a href="../modules/dd-scroll.html">dd-scroll</a></li>
+
+ <li><a href="../modules/dial.html">dial</a></li>
+
+ <li><a href="../modules/dom.html">dom</a></li>
+
+ <li><a href="../modules/dom-base.html">dom-base</a></li>
+
+ <li><a href="../modules/dom-screen.html">dom-screen</a></li>
+
+ <li><a href="../modules/dom-style.html">dom-style</a></li>
+
+ <li><a href="../modules/dump.html">dump</a></li>
+
+ <li><a href="../modules/editor.html">editor</a></li>
+
+ <li><a href="../modules/editor-base.html">editor-base</a></li>
+
+ <li><a href="../modules/editor-bidi.html">editor-bidi</a></li>
+
+ <li><a href="../modules/editor-br.html">editor-br</a></li>
+
+ <li><a href="../modules/editor-lists.html">editor-lists</a></li>
+
+ <li><a href="../modules/editor-para.html">editor-para</a></li>
+
+ <li><a href="../modules/editor-para-base.html">editor-para-base</a></li>
+
+ <li><a href="../modules/editor-para-ie.html">editor-para-ie</a></li>
+
+ <li><a href="../modules/editor-tab.html">editor-tab</a></li>
+
+ <li><a href="../modules/escape.html">escape</a></li>
+
+ <li><a href="../modules/event.html">event</a></li>
+
+ <li><a href="../modules/event-base.html">event-base</a></li>
+
+ <li><a href="../modules/event-contextmenu.html">event-contextmenu</a></li>
+
+ <li><a href="../modules/event-custom.html">event-custom</a></li>
+
+ <li><a href="../modules/event-custom-base.html">event-custom-base</a></li>
+
+ <li><a href="../modules/event-custom-complex.html">event-custom-complex</a></li>
+
+ <li><a href="../modules/event-delegate.html">event-delegate</a></li>
+
+ <li><a href="../modules/event-flick.html">event-flick</a></li>
+
+ <li><a href="../modules/event-focus.html">event-focus</a></li>
+
+ <li><a href="../modules/event-gestures.html">event-gestures</a></li>
+
+ <li><a href="../modules/event-hover.html">event-hover</a></li>
+
+ <li><a href="../modules/event-key.html">event-key</a></li>
+
+ <li><a href="../modules/event-mouseenter.html">event-mouseenter</a></li>
+
+ <li><a href="../modules/event-mousewheel.html">event-mousewheel</a></li>
+
+ <li><a href="../modules/event-move.html">event-move</a></li>
+
+ <li><a href="../modules/event-outside.html">event-outside</a></li>
+
+ <li><a href="../modules/event-resize.html">event-resize</a></li>
+
+ <li><a href="../modules/event-simulate.html">event-simulate</a></li>
+
+ <li><a href="../modules/event-synthetic.html">event-synthetic</a></li>
+
+ <li><a href="../modules/event-tap.html">event-tap</a></li>
+
+ <li><a href="../modules/event-touch.html">event-touch</a></li>
+
+ <li><a href="../modules/event-valuechange.html">event-valuechange</a></li>
+
+ <li><a href="../modules/exec-command.html">exec-command</a></li>
+
+ <li><a href="../modules/features.html">features</a></li>
+
+ <li><a href="../modules/file.html">file</a></li>
+
+ <li><a href="../modules/file-flash.html">file-flash</a></li>
+
+ <li><a href="../modules/file-html5.html">file-html5</a></li>
+
+ <li><a href="../modules/frame.html">frame</a></li>
+
+ <li><a href="../modules/gesture-simulate.html">gesture-simulate</a></li>
+
+ <li><a href="../modules/get.html">get</a></li>
+
+ <li><a href="../modules/get-nodejs.html">get-nodejs</a></li>
+
+ <li><a href="../modules/graphics.html">graphics</a></li>
+
+ <li><a href="../modules/graphics-group.html">graphics-group</a></li>
+
+ <li><a href="../modules/handlebars.html">handlebars</a></li>
+
+ <li><a href="../modules/handlebars-base.html">handlebars-base</a></li>
+
+ <li><a href="../modules/handlebars-compiler.html">handlebars-compiler</a></li>
+
+ <li><a href="../modules/highlight.html">highlight</a></li>
+
+ <li><a href="../modules/highlight-accentfold.html">highlight-accentfold</a></li>
+
+ <li><a href="../modules/highlight-base.html">highlight-base</a></li>
+
+ <li><a href="../modules/history.html">history</a></li>
+
+ <li><a href="../modules/history-base.html">history-base</a></li>
+
+ <li><a href="../modules/history-hash.html">history-hash</a></li>
+
+ <li><a href="../modules/history-hash-ie.html">history-hash-ie</a></li>
+
+ <li><a href="../modules/history-html5.html">history-html5</a></li>
+
+ <li><a href="../modules/imageloader.html">imageloader</a></li>
+
+ <li><a href="../modules/intl.html">intl</a></li>
+
+ <li><a href="../modules/io.html">io</a></li>
+
+ <li><a href="../modules/io-base.html">io-base</a></li>
+
+ <li><a href="../modules/io-form.html">io-form</a></li>
+
+ <li><a href="../modules/io-nodejs.html">io-nodejs</a></li>
+
+ <li><a href="../modules/io-queue.html">io-queue</a></li>
+
+ <li><a href="../modules/io-upload-iframe.html">io-upload-iframe</a></li>
+
+ <li><a href="../modules/io-xdr.html">io-xdr</a></li>
+
+ <li><a href="../modules/json.html">json</a></li>
+
+ <li><a href="../modules/json-parse.html">json-parse</a></li>
+
+ <li><a href="../modules/json-stringify.html">json-stringify</a></li>
+
+ <li><a href="../modules/jsonp.html">jsonp</a></li>
+
+ <li><a href="../modules/jsonp-url.html">jsonp-url</a></li>
+
+ <li><a href="../modules/lazy-model-list.html">lazy-model-list</a></li>
+
+ <li><a href="../modules/loader.html">loader</a></li>
+
+ <li><a href="../modules/loader-base.html">loader-base</a></li>
+
+ <li><a href="../modules/loader-yui3.html">loader-yui3</a></li>
+
+ <li><a href="../modules/matrix.html">matrix</a></li>
+
+ <li><a href="../modules/model.html">model</a></li>
+
+ <li><a href="../modules/model-list.html">model-list</a></li>
+
+ <li><a href="../modules/model-sync-rest.html">model-sync-rest</a></li>
+
+ <li><a href="../modules/node.html">node</a></li>
+
+ <li><a href="../modules/node-base.html">node-base</a></li>
+
+ <li><a href="../modules/node-core.html">node-core</a></li>
+
+ <li><a href="../modules/node-data.html">node-data</a></li>
+
+ <li><a href="../modules/node-event-delegate.html">node-event-delegate</a></li>
+
+ <li><a href="../modules/node-event-html5.html">node-event-html5</a></li>
+
+ <li><a href="../modules/node-event-simulate.html">node-event-simulate</a></li>
+
+ <li><a href="../modules/node-flick.html">node-flick</a></li>
+
+ <li><a href="../modules/node-focusmanager.html">node-focusmanager</a></li>
+
+ <li><a href="../modules/node-load.html">node-load</a></li>
+
+ <li><a href="../modules/node-menunav.html">node-menunav</a></li>
+
+ <li><a href="../modules/node-pluginhost.html">node-pluginhost</a></li>
+
+ <li><a href="../modules/node-screen.html">node-screen</a></li>
+
+ <li><a href="../modules/node-scroll-info.html">node-scroll-info</a></li>
+
+ <li><a href="../modules/node-style.html">node-style</a></li>
+
+ <li><a href="../modules/oop.html">oop</a></li>
+
+ <li><a href="../modules/overlay.html">overlay</a></li>
+
+ <li><a href="../modules/panel.html">panel</a></li>
+
+ <li><a href="../modules/parallel.html">parallel</a></li>
+
+ <li><a href="../modules/pjax.html">pjax</a></li>
+
+ <li><a href="../modules/pjax-base.html">pjax-base</a></li>
+
+ <li><a href="../modules/pjax-content.html">pjax-content</a></li>
+
+ <li><a href="../modules/pjax-plugin.html">pjax-plugin</a></li>
+
+ <li><a href="../modules/plugin.html">plugin</a></li>
+
+ <li><a href="../modules/pluginhost.html">pluginhost</a></li>
+
+ <li><a href="../modules/pluginhost-base.html">pluginhost-base</a></li>
+
+ <li><a href="../modules/pluginhost-config.html">pluginhost-config</a></li>
+
+ <li><a href="../modules/promise.html">promise</a></li>
+
+ <li><a href="../modules/querystring.html">querystring</a></li>
+
+ <li><a href="../modules/querystring-parse.html">querystring-parse</a></li>
+
+ <li><a href="../modules/querystring-parse-simple.html">querystring-parse-simple</a></li>
+
+ <li><a href="../modules/querystring-stringify.html">querystring-stringify</a></li>
+
+ <li><a href="../modules/querystring-stringify-simple.html">querystring-stringify-simple</a></li>
+
+ <li><a href="../modules/queue-promote.html">queue-promote</a></li>
+
+ <li><a href="../modules/range-slider.html">range-slider</a></li>
+
+ <li><a href="../modules/recordset.html">recordset</a></li>
+
+ <li><a href="../modules/recordset-base.html">recordset-base</a></li>
+
+ <li><a href="../modules/recordset-filter.html">recordset-filter</a></li>
+
+ <li><a href="../modules/recordset-indexer.html">recordset-indexer</a></li>
+
+ <li><a href="../modules/recordset-sort.html">recordset-sort</a></li>
+
+ <li><a href="../modules/resize.html">resize</a></li>
+
+ <li><a href="../modules/resize-contrain.html">resize-contrain</a></li>
+
+ <li><a href="../modules/resize-plugin.html">resize-plugin</a></li>
+
+ <li><a href="../modules/resize-proxy.html">resize-proxy</a></li>
+
+ <li><a href="../modules/rollup.html">rollup</a></li>
+
+ <li><a href="../modules/router.html">router</a></li>
+
+ <li><a href="../modules/scrollview.html">scrollview</a></li>
+
+ <li><a href="../modules/scrollview-base.html">scrollview-base</a></li>
+
+ <li><a href="../modules/scrollview-base-ie.html">scrollview-base-ie</a></li>
+
+ <li><a href="../modules/scrollview-list.html">scrollview-list</a></li>
+
+ <li><a href="../modules/scrollview-paginator.html">scrollview-paginator</a></li>
+
+ <li><a href="../modules/scrollview-scrollbars.html">scrollview-scrollbars</a></li>
+
+ <li><a href="../modules/selection.html">selection</a></li>
+
+ <li><a href="../modules/selector-css2.html">selector-css2</a></li>
+
+ <li><a href="../modules/selector-css3.html">selector-css3</a></li>
+
+ <li><a href="../modules/selector-native.html">selector-native</a></li>
+
+ <li><a href="../modules/series-area.html">series-area</a></li>
+
+ <li><a href="../modules/series-area-stacked.html">series-area-stacked</a></li>
+
+ <li><a href="../modules/series-areaspline.html">series-areaspline</a></li>
+
+ <li><a href="../modules/series-areaspline-stacked.html">series-areaspline-stacked</a></li>
+
+ <li><a href="../modules/series-bar.html">series-bar</a></li>
+
+ <li><a href="../modules/series-bar-stacked.html">series-bar-stacked</a></li>
+
+ <li><a href="../modules/series-base.html">series-base</a></li>
+
+ <li><a href="../modules/series-candlestick.html">series-candlestick</a></li>
+
+ <li><a href="../modules/series-cartesian.html">series-cartesian</a></li>
+
+ <li><a href="../modules/series-column.html">series-column</a></li>
+
+ <li><a href="../modules/series-column-stacked.html">series-column-stacked</a></li>
+
+ <li><a href="../modules/series-combo.html">series-combo</a></li>
+
+ <li><a href="../modules/series-combo-stacked.html">series-combo-stacked</a></li>
+
+ <li><a href="../modules/series-combospline.html">series-combospline</a></li>
+
+ <li><a href="../modules/series-combospline-stacked.html">series-combospline-stacked</a></li>
+
+ <li><a href="../modules/series-curve-util.html">series-curve-util</a></li>
+
+ <li><a href="../modules/series-fill-util.html">series-fill-util</a></li>
+
+ <li><a href="../modules/series-histogram.html">series-histogram</a></li>
+
+ <li><a href="../modules/series-line.html">series-line</a></li>
+
+ <li><a href="../modules/series-line-stacked.html">series-line-stacked</a></li>
+
+ <li><a href="../modules/series-line-util.html">series-line-util</a></li>
+
+ <li><a href="../modules/series-marker.html">series-marker</a></li>
+
+ <li><a href="../modules/series-marker-stacked.html">series-marker-stacked</a></li>
+
+ <li><a href="../modules/series-ohlc.html">series-ohlc</a></li>
+
+ <li><a href="../modules/series-pie.html">series-pie</a></li>
+
+ <li><a href="../modules/series-plot-util.html">series-plot-util</a></li>
+
+ <li><a href="../modules/series-range.html">series-range</a></li>
+
+ <li><a href="../modules/series-spline.html">series-spline</a></li>
+
+ <li><a href="../modules/series-spline-stacked.html">series-spline-stacked</a></li>
+
+ <li><a href="../modules/series-stacked.html">series-stacked</a></li>
+
+ <li><a href="../modules/shim-plugin.html">shim-plugin</a></li>
+
+ <li><a href="../modules/slider.html">slider</a></li>
+
+ <li><a href="../modules/slider-base.html">slider-base</a></li>
+
+ <li><a href="../modules/slider-value-range.html">slider-value-range</a></li>
+
+ <li><a href="../modules/sortable.html">sortable</a></li>
+
+ <li><a href="../modules/sortable-scroll.html">sortable-scroll</a></li>
+
+ <li><a href="../modules/stylesheet.html">stylesheet</a></li>
+
+ <li><a href="../modules/substitute.html">substitute</a></li>
+
+ <li><a href="../modules/swf.html">swf</a></li>
+
+ <li><a href="../modules/swfdetect.html">swfdetect</a></li>
+
+ <li><a href="../modules/tabview.html">tabview</a></li>
+
+ <li><a href="../modules/template.html">template</a></li>
+
+ <li><a href="../modules/template-base.html">template-base</a></li>
+
+ <li><a href="../modules/template-micro.html">template-micro</a></li>
+
+ <li><a href="../modules/test.html">test</a></li>
+
+ <li><a href="../modules/test-console.html">test-console</a></li>
+
+ <li><a href="../modules/text.html">text</a></li>
+
+ <li><a href="../modules/text-accentfold.html">text-accentfold</a></li>
+
+ <li><a href="../modules/text-wordbreak.html">text-wordbreak</a></li>
+
+ <li><a href="../modules/timers.html">timers</a></li>
+
+ <li><a href="../modules/transition.html">transition</a></li>
+
+ <li><a href="../modules/transition-timer.html">transition-timer</a></li>
+
+ <li><a href="../modules/tree.html">tree</a></li>
+
+ <li><a href="../modules/tree-labelable.html">tree-labelable</a></li>
+
+ <li><a href="../modules/tree-lazy.html">tree-lazy</a></li>
+
+ <li><a href="../modules/tree-node.html">tree-node</a></li>
+
+ <li><a href="../modules/tree-openable.html">tree-openable</a></li>
+
+ <li><a href="../modules/tree-selectable.html">tree-selectable</a></li>
+
+ <li><a href="../modules/tree-sortable.html">tree-sortable</a></li>
+
+ <li><a href="../modules/uploader.html">uploader</a></li>
+
+ <li><a href="../modules/uploader-flash.html">uploader-flash</a></li>
+
+ <li><a href="../modules/uploader-html5.html">uploader-html5</a></li>
+
+ <li><a href="../modules/uploader-queue.html">uploader-queue</a></li>
+
+ <li><a href="../modules/view.html">view</a></li>
+
+ <li><a href="../modules/view-node-map.html">view-node-map</a></li>
+
+ <li><a href="../modules/widget.html">widget</a></li>
+
+ <li><a href="../modules/widget-anim.html">widget-anim</a></li>
+
+ <li><a href="../modules/widget-autohide.html">widget-autohide</a></li>
+
+ <li><a href="../modules/widget-base.html">widget-base</a></li>
+
+ <li><a href="../modules/widget-base-ie.html">widget-base-ie</a></li>
+
+ <li><a href="../modules/widget-buttons.html">widget-buttons</a></li>
+
+ <li><a href="../modules/widget-child.html">widget-child</a></li>
+
+ <li><a href="../modules/widget-htmlparser.html">widget-htmlparser</a></li>
+
+ <li><a href="../modules/widget-locale.html">widget-locale</a></li>
+
+ <li><a href="../modules/widget-modality.html">widget-modality</a></li>
+
+ <li><a href="../modules/widget-parent.html">widget-parent</a></li>
+
+ <li><a href="../modules/widget-position.html">widget-position</a></li>
+
+ <li><a href="../modules/widget-position-align.html">widget-position-align</a></li>
+
+ <li><a href="../modules/widget-position-constrain.html">widget-position-constrain</a></li>
+
+ <li><a href="../modules/widget-skin.html">widget-skin</a></li>
+
+ <li><a href="../modules/widget-stack.html">widget-stack</a></li>
+
+ <li><a href="../modules/widget-stdmod.html">widget-stdmod</a></li>
+
+ <li><a href="../modules/widget-uievents.html">widget-uievents</a></li>
+
+ <li><a href="../modules/yql.html">yql</a></li>
+
+ <li><a href="../modules/yql-jsonp.html">yql-jsonp</a></li>
+
+ <li><a href="../modules/yql-nodejs.html">yql-nodejs</a></li>
+
+ <li><a href="../modules/yql-winjs.html">yql-winjs</a></li>
+
+ <li><a href="../modules/yui.html">yui</a></li>
+
+ <li><a href="../modules/yui-base.html">yui-base</a></li>
+
+ <li><a href="../modules/yui-later.html">yui-later</a></li>
+
+ <li><a href="../modules/yui-log.html">yui-log</a></li>
+
+ <li><a href="../modules/yui-throttle.html">yui-throttle</a></li>
+
+ </ul>
+ </div>
+ </div>
+</div>
+
+ </div>
+ </div>
+ <div class="yui3-u-3-4">
+ <div id="api-options">
+ Show:
+ <label for="api-show-inherited">
+ <input type="checkbox" id="api-show-inherited" checked>
+ Inherited
+ </label>
+
+ <label for="api-show-protected">
+ <input type="checkbox" id="api-show-protected">
+ Protected
+ </label>
+
+ <label for="api-show-private">
+ <input type="checkbox" id="api-show-private">
+ Private
+ </label>
+ <label for="api-show-deprecated">
+ <input type="checkbox" id="api-show-deprecated">
+ Deprecated
+ </label>
+
+ </div>
+
+
+ <div class="apidocs">
+ <div id="docs-main">
+ <div class="content">
+ <h1>YUI Class</h1>
+<div class="box meta">
+
+ <div class="uses">
+ Uses
+ <ul class="inline commas">
+
+ <li><a href="EventTarget.html">EventTarget</a></li>
+
+ </ul>
+ </div>
+
+
+
+
+
+ <div class="foundat">
+ Defined in: <a href="../files/yui_js_yui.js.html#l16"><code>yui/js/yui.js:16</code></a>
+ </div>
+
+
+
+
+ Module: <a href="../modules/yui-base.html">yui-base</a><br>
+ Parent Module: <a href="../modules/yui.html">yui</a>
+
+
+
+
+</div>
+
+
+
+<div class="box intro">
+ <p>The YUI global namespace object. This is the constructor for all YUI instances.</p>
+
+<p>This is a self-instantiable factory function, meaning you don't need to precede
+it with the <code>new</code> operator. You can invoke it directly like this:</p>
+
+<pre class="code prettyprint"><code>YUI().use('*', function (Y) {
+ // Y is a new YUI instance.
+});
+</code></pre>
+
+<p>But it also works like this:</p>
+
+<pre class="code prettyprint"><code>var Y = YUI();
+</code></pre>
+
+<p>The <code>YUI</code> constructor accepts an optional config object, like this:</p>
+
+<pre class="code prettyprint"><code>YUI({
+ debug: true,
+ combine: false
+}).use('node', function (Y) {
+ // Y.Node is ready to use.
+});
+</code></pre>
+
+<p>See the API docs for the <a href="config.html">Config</a> class for the complete
+list of supported configuration properties accepted by the YUI constuctor.</p>
+
+<p>If a global <code>YUI</code> object is already defined, the existing YUI object will not be
+overwritten, to ensure that defined namespaces are preserved.</p>
+
+<p>Each YUI instance has full custom event support, but only if the event system is
+available.</p>
+</div>
+
+
+ <div class="constructor">
+ <h2>Constructor</h2>
+ <div id="method_YUI" class="method item">
+ <h3 class="name"><code>YUI</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code class="optional">[config]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l16"><code>yui/js/yui.js:16</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[config]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+ <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+
+
+ <div class="param-description">
+ <p>Zero or more optional configuration objects. Config
+ values are stored in the <code>Y.config</code> property. See the
+ <a href="config.html">Config</a> docs for the list of supported properties.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+ </div>
+
+
+<div id="classdocs" class="tabview">
+ <ul class="api-class-tabs">
+ <li class="api-class-tab index"><a href="#index">Index</a></li>
+
+
+ <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
+
+
+ <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
+
+
+
+ <li class="api-class-tab events"><a href="#events">Events</a></li>
+
+ </ul>
+
+ <div>
+ <div id="index" class="api-class-tabpanel index">
+ <h2 class="off-left">Item Index</h2>
+
+
+ <div class="index-section methods">
+ <h3>Methods</h3>
+
+ <ul class="index-list methods">
+
+ <li class="index-item method private">
+ <a href="#method__attach">_attach</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__config">_config</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__delayCallback">_delayCallback</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__getFullType">_getFullType</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__getLoadHook">_getLoadHook</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__getType">_getType</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__init">_init</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__monitor">_monitor</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__notify">_notify</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__parseType">_parseType</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__publish">_publish</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__setup">_setup</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__use">_use</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_add">add</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_addTarget">addTarget</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_after">after</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_aggregate">aggregate</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_all">all</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_applyConfig">applyConfig</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_applyConfig">applyConfig</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_applyTo">applyTo</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_assert">assert</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_augment">augment</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_batch">batch</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_before">before</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_bind">bind</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_bubble">bubble</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_cached">cached</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_clone">clone</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_delegate">delegate</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_destroy">destroy</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_detach">detach</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_detachAll">detachAll</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_dump">dump</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_each">each</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_error">error</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_extend">extend</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_fail">fail</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_fire">fire</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_getEvent">getEvent</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_getLocation">getLocation</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_getTargets">getTargets</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_guid">guid</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_header">header</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_instanceOf">instanceOf</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_io">io</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_jsonp">jsonp</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_later">later</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_log">log</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_merge">merge</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_message">message</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_mix">mix</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_namespace">namespace</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_on">on</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_once">once</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_onceAfter">onceAfter</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_one">one</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_parseType">parseType</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_publish">publish</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_rbind">rbind</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_removeTarget">removeTarget</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_setLoadHook">setLoadHook</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_some">some</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_soon">soon</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_stamp">stamp</a>
+
+
+
+ </li>
+
+ <li class="index-item method deprecated inherited">
+ <a href="#method_subscribe">subscribe</a>
+
+
+
+ <span class="flag deprecated">deprecated</span>
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_throttle">throttle</a>
+
+
+
+ </li>
+
+ <li class="index-item method deprecated inherited">
+ <a href="#method_unsubscribe">unsubscribe</a>
+
+
+
+ <span class="flag deprecated">deprecated</span>
+
+ </li>
+
+ <li class="index-item method deprecated inherited">
+ <a href="#method_unsubscribeAll">unsubscribeAll</a>
+
+
+
+ <span class="flag deprecated">deprecated</span>
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_use">use</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_when">when</a>
+
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="index-section properties">
+ <h3>Properties</h3>
+
+ <ul class="index-list properties">
+
+ <li class="index-item property">
+ <a href="#property_Global">Global</a>
+
+
+
+ </li>
+
+ <li class="index-item property">
+ <a href="#property_GlobalConfig">GlobalConfig</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item property">
+ <a href="#property_meta">meta</a>
+
+
+
+ </li>
+
+ <li class="index-item property">
+ <a href="#property_version">version</a>
+
+
+
+ </li>
+
+ <li class="index-item property">
+ <a href="#property_YUI_config">YUI_config</a>
+
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+ <div class="index-section events">
+ <h3>Events</h3>
+
+ <ul class="index-list events">
+
+ <li class="index-item event">
+ <a href="#event_available">available</a>
+
+
+
+ </li>
+
+ <li class="index-item event">
+ <a href="#event_contentready">contentready</a>
+
+
+
+ </li>
+
+ <li class="index-item event">
+ <a href="#event_domready">domready</a>
+
+
+
+ </li>
+
+ <li class="index-item event">
+ <a href="#event_flick">flick</a>
+
+
+
+ </li>
+
+ <li class="index-item event">
+ <a href="#event_gesturemove">gesturemove</a>
+
+
+
+ </li>
+
+ <li class="index-item event">
+ <a href="#event_gesturemoveend">gesturemoveend</a>
+
+
+
+ </li>
+
+ <li class="index-item event">
+ <a href="#event_gesturemovestart">gesturemovestart</a>
+
+
+
+ </li>
+
+ <li class="index-item event">
+ <a href="#event_hashchange">hashchange</a>
+
+
+
+ </li>
+
+ <li class="index-item event">
+ <a href="#event_key">key</a>
+
+
+
+ </li>
+
+ <li class="index-item event">
+ <a href="#event_mousewheel">mousewheel</a>
+
+
+
+ </li>
+
+ <li class="index-item event">
+ <a href="#event_valuechange">valuechange</a>
+
+
+
+ </li>
+
+ <li class="index-item event">
+ <a href="#event_windowresize">windowresize</a>
+
+
+
+ </li>
+
+ </ul>
+ </div>
+
+ </div>
+
+
+ <div id="methods" class="api-class-tabpanel">
+ <h2 class="off-left">Methods</h2>
+
+
+ <div id="method__attach" class="method item private">
+ <h3 class="name"><code>_attach</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>r</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[moot=false]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l649"><code>yui/js/yui.js:649</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Executes the callback function associated with each required module,
+attaching the module to this YUI instance.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">r</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The array of modules to attach</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[moot=false]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>If <code>true</code>, don't throw a warning if the module
+ is not attached.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__config" class="method item private">
+ <h3 class="name"><code>_config</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l303"><code>yui/js/yui.js:303</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Old way to apply a config to this instance (calls <code>applyConfig</code> under the
+hood).</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The config to apply</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__delayCallback" class="method item private">
+ <h3 class="name"><code>_delayCallback</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>cb</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>until</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l808"><code>yui/js/yui.js:808</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Delays the <code>use</code> callback until another event has taken place such as
+<code>window.onload</code>, <code>domready</code>, <code>contentready</code>, or <code>available</code>.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">cb</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The original <code>use</code> callback.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">until</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Either an event name ('load', 'domready', etc.)
+ or an object containing event/args keys for contentready/available.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>:
+
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getFullType" class="method item private inherited">
+ <h3 class="name"><code>_getFullType</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method__getFullType">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l586"><code>event-custom/js/event-target.js:586</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns the fully qualified type, given a short type string.
+That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.</p>
+
+<p>NOTE: This method, unlike _getType, does no checking of the value passed in, and
+is designed to be used with the low level _publish() method, for critical path
+implementations which need to fast-track publish for performance reasons.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The short type to prefix</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ The prefixed type, if a prefix is set, otherwise the type passed in
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getLoadHook" class="method item private">
+ <h3 class="name"><code>_getLoadHook</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>data</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>path</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l1513"><code>yui/js/yui.js:1513</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Load hook for <code>Y.Get.script</code> in Node.js, see <code>YUI.setLoadHook</code></p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">data</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The content of the file</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">path</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The file path of the file</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__getType" class="method item private inherited">
+ <h3 class="name"><code>_getType</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method__getType">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l36"><code>event-custom/js/event-target.js:36</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>If the instance has a prefix attribute and the
+event type is not prefixed, the instance prefix is
+applied to the supplied type.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__init" class="method item private">
+ <h3 class="name"><code>_init</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l315"><code>yui/js/yui.js:315</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Initializes this YUI instance.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__monitor" class="method item private inherited">
+ <h3 class="name"><code>_monitor</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>what</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>eventType</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method__monitor">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l658"><code>event-custom/js/event-target.js:658</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>This is the entry point for the event monitoring system.
+You can monitor 'attach', 'detach', 'fire', and 'publish'.
+When configured, these events generate an event. click ->
+click<em>attach, click</em>detach, click_publish -- these can
+be subscribed to like other events to monitor the event
+system. Inividual published events can have monitoring
+turned on or off (publish can't be turned off before it
+it published) by setting the events 'monitor' config.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">what</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>'attach', 'detach', 'fire', or 'publish'</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">eventType</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The prefixed name of the event being monitored, or the CustomEvent object.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Information about the event interaction, such as
+ fire() args, subscription category, publish config</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__notify" class="method item private">
+ <h3 class="name"><code>_notify</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>callback</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>response</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>args</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l959"><code>yui/js/yui.js:959</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Handles Loader notifications about attachment/load errors.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">callback</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Callback to pass to <code>Y.config.loadErrorFn</code>.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">response</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Response returned from Loader.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Arguments passed from Loader.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__parseType" class="method item private inherited">
+ <h3 class="name"><code>_parseType</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method__parseType">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l52"><code>event-custom/js/event-target.js:52</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns an array with the detach key (if provided),
+and the prefixed event name from _getType
+Y.on('detachcategory| menu:click', fn)</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__publish" class="method item private inherited">
+ <h3 class="name"><code>_publish</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>fullType</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>etOpts</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>ceOpts</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method__publish">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l610"><code>event-custom/js/event-target.js:610</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The low level event publish implementation. It expects all the massaging to have been done
+outside of this method. e.g. the <code>type</code> to <code>fullType</code> conversion. It's designed to be a fast
+path publish, which can be used by critical code paths to improve performance.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">fullType</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The prefixed type of the event to publish.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">etOpts</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The EventTarget specific configuration to mix into the published event.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">ceOpts</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The publish specific configuration to mix into the published event.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
+
+ The published event. If called without <code>etOpts</code> or <code>ceOpts</code>, this will
+be the default <code>CustomEvent</code> instance, and can be configured independently.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__setup" class="method item private">
+ <h3 class="name"><code>_setup</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l502"><code>yui/js/yui.js:502</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Finishes the instance setup. Attaches whatever YUI modules were defined
+at the time that this instance was created.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__use" class="method item private">
+ <h3 class="name"><code>_use</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>args</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[callback]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l988"><code>yui/js/yui.js:988</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Called from the <code>use</code> method queue to ensure that only one set of loading
+logic is performed at a time.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+ <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+
+
+ <div class="param-description">
+ <p>One or more modules to attach.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[callback]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Function to call once all required modules have
+ been attached.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_add" class="method item">
+ <h3 class="name"><code>add</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>version</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[config]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/YUI.html" class="crosslink">YUI</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l565"><code>yui/js/yui.js:565</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Registers a YUI module and makes it available for use in a <code>YUI().use()</code> call or
+as a dependency for other modules.</p>
+
+<p>The easiest way to create a first-class YUI module is to use
+<a href="http://yui.github.com/shifter/">Shifter</a>, the YUI component build
+tool.</p>
+
+<p>Shifter will automatically wrap your module code in a <code>YUI.add()</code> call along
+with any configuration info required for the module.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Module name.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Function containing module code. This function will be
+ executed whenever the module is attached to a specific YUI instance.</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">Y</code>
+ <span class="type"><a href="../classes/YUI.html" class="crosslink">YUI</a></span>
+
+
+ <div class="param-description">
+ <p>The YUI instance to which this module is attached.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+ <div class="param-description">
+ <p>Name of the module</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">version</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Module version number. This is currently used only for
+ informational purposes, and is not used internally by YUI.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[config]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Module config.</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[requires]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Array of other module names that must be
+ attached before this module can be attached.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[optional]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Array of optional module names that should
+ be attached before this module is attached if they've already been
+ loaded. If the <code>loadOptional</code> YUI option is <code>true</code>, optional modules
+ that have not yet been loaded will be loaded just as if they were hard
+ requirements.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[use]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Array of module names that are included within
+ or otherwise provided by this module, and which should be attached
+ automatically when this module is attached. This makes it possible to
+ create "virtual rollup" modules that simply attach a collection of other
+ modules or submodules.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/YUI.html" class="crosslink">YUI</a></span>:
+
+ This YUI instance.
+
+ </div>
+ </div>
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>YUI.add('davglass', function (Y) {
+ Y.davglass = function () {
+ Y.log('Dav was here!');
+ };
+}, '3.4.0', {
+ requires: ['harley-davidson', 'mt-dew']
+});
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="method_addTarget" class="method item inherited">
+ <h3 class="name"><code>addTarget</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_addTarget">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-facade.js.html#l455"><code>event-custom/js/event-facade.js:455</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Registers another EventTarget as a bubble target. Bubble order
+is determined by the order registered. Multiple targets can
+be specified.</p>
+
+<p>Events can only bubble if emitFacade is true.</p>
+
+<p>Included in the event-custom-complex submodule.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the target to add</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_after" class="method item">
+ <h3 class="name"><code>after</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[context]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[args*]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_after">
+ EventTarget
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l1009"><code>event-custom/js/event-target.js:1009</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Like <code>on()</code>, this method creates a subscription to a custom event or to the
+execution of a method on an object.</p>
+
+<p>For events, <code>after()</code> subscribers are executed after the event's
+<code>defaultFn</code> unless <code>e.preventDefault()</code> was called from an <code>on()</code> subscriber.</p>
+
+<p>See the <a href="#methods_on"><code>on()</code> method</a> for additional subscription
+options.</p>
+
+<p>NOTE: The subscription signature shown is for events, not for function
+injection. See <a href="../classes/Do.html#methods_after"><code>Y.Do.after</code></a>
+for that signature.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The custom event name</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute in response to the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[context]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Override <code>this</code> object in callback</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[args*]</code>
+ <span class="type">Any</span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to supply to the subscriber</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
+
+ A subscription handle capable of detaching the
+ subscription
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_aggregate" class="method item">
+ <h3 class="name"><code>aggregate</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>receiver</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>supplier</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[overwrite=false]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[whitelist]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/oop.html">oop</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/oop_js_oop.js.html#l137"><code>oop/js/oop.js:137</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Copies object properties from the supplier to the receiver. If the target has
+the property, and the property is an object, the target object will be
+augmented with the supplier's value.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">receiver</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Object to receive the augmentation.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">supplier</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Object that supplies the properties with which to
+ augment the receiver.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[overwrite=false]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>If <code>true</code>, properties already on the receiver
+ will be overwritten if found on the supplier.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[whitelist]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Whitelist. If supplied, only properties in this
+ list will be applied to the receiver.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ Augmented object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_all" class="method item">
+ <h3 class="name"><code>all</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>selector</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/NodeList.html" class="crosslink">NodeList</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/node-core.html">node-core</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/node_js_node-core.js.html#l243"><code>node/js/node-core.js:243</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Retrieves a NodeList based on the given CSS selector.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">selector</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The CSS selector to test against.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/NodeList.html" class="crosslink">NodeList</a></span>:
+
+ A NodeList instance for the matching HTMLCollection/Array.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_applyConfig" class="method item">
+ <h3 class="name"><code>applyConfig</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l255"><code>yui/js/yui.js:255</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.2.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Applies a new configuration object to the config of this YUI instance. This
+will merge new group/module definitions, and will also update the loader
+cache if necessary. Updating <code>Y.config</code> directly will not update the cache.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the configuration object.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_applyConfig" class="method item">
+ <h3 class="name"><code>applyConfig</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l1429"><code>yui/js/yui.js:1429</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Applies a configuration to all YUI instances in this execution context.</p>
+
+<p>The main use case for this method is in "mashups" where several third-party
+scripts need to write to a global YUI config, but cannot share a single
+centrally-managed config object. This way they can all call
+<code>YUI.applyConfig({})</code> instead of overwriting the single global config.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Configuration object to apply.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>YUI.applyConfig({
+ modules: {
+ davglass: {
+ fullpath: './davglass.js'
+ }
+ }
+});
+
+YUI.applyConfig({
+ modules: {
+ foo: {
+ fullpath: './foo.js'
+ }
+ }
+});
+
+YUI().use('davglass', function (Y) {
+ // Module davglass will be available here.
+});
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="method_applyTo" class="method item">
+ <h3 class="name"><code>applyTo</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>id</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>method</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>args</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type">Mixed</span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l531"><code>yui/js/yui.js:531</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Executes the named method on the specified YUI instance if that method is
+whitelisted.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">id</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>YUI instance id.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">method</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Name of the method to execute. For example:
+ 'Object.keys'.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Arguments to apply to the method.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type">Mixed</span>:
+
+ Return value from the applied method, or <code>null</code> if the
+ specified instance was not found or the method was not whitelisted.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_assert" class="method item">
+ <h3 class="name"><code>assert</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>condition</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>message</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/test.html">test</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/test_js_YTestWrapAfter.js.html#l29"><code>test/js/YTestWrapAfter.js:29</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Asserts that a given condition is true. If not, then a Y.Assert.Error object is thrown
+and the test fails.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">condition</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The condition to test.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">message</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The message to display if the assertion fails.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_augment" class="method item">
+ <h3 class="name"><code>augment</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>receiver</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>supplier</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[overwrite=false]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[whitelist]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[args]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/oop.html">oop</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/oop_js_oop.js.html#l31"><code>oop/js/oop.js:31</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Augments the <em>receiver</em> with prototype properties from the <em>supplier</em>. The
+receiver may be a constructor function or an object. The supplier must be a
+constructor function.</p>
+
+<p>If the <em>receiver</em> is an object, then the <em>supplier</em> constructor will be called
+immediately after <em>receiver</em> is augmented, with <em>receiver</em> as the <code>this</code> object.</p>
+
+<p>If the <em>receiver</em> is a constructor function, then all prototype methods of
+<em>supplier</em> that are copied to <em>receiver</em> will be sequestered, and the
+<em>supplier</em> constructor will not be called immediately. The first time any
+sequestered method is called on the <em>receiver</em>'s prototype, all sequestered
+methods will be immediately copied to the <em>receiver</em>'s prototype, the
+<em>supplier</em>'s constructor will be executed, and finally the newly unsequestered
+method that was called will be executed.</p>
+
+<p>This sequestering logic sounds like a bunch of complicated voodoo, but it makes
+it cheap to perform frequent augmentation by ensuring that suppliers'
+constructors are only called if a supplied method is actually used. If none of
+the supplied methods is ever used, then there's no need to take the performance
+hit of calling the <em>supplier</em>'s constructor.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">receiver</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Object or function to be augmented.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">supplier</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Function that supplies the prototype properties with
+ which to augment the <em>receiver</em>.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[overwrite=false]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>If <code>true</code>, properties already on the receiver
+ will be overwritten if found on the supplier's prototype.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[whitelist]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>An array of property names. If specified,
+ only the whitelisted prototype properties will be applied to the receiver, and
+ all others will be ignored.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[args]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | Any</span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Argument or array of arguments to pass to the
+ supplier's constructor when initializing.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>:
+
+ Augmented object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_batch" class="method item">
+ <h3 class="name"><code>batch</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>operation</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/Promise.html" class="crosslink">Promise</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/pluginhost-base.html">pluginhost-base</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/promise_js_batch.js.html#l3"><code>promise/js/batch.js:3</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns a new promise that will be resolved when all operations have completed.
+Takes both any numer of values as arguments. If an argument is a not a promise,
+it will be wrapped in a new promise, same as in <code>Y.when()</code>.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">operation</code>
+ <span class="type">Any</span>
+
+
+
+ <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+
+
+ <div class="param-description">
+ <p>Any number of Y.Promise objects or regular JS values</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/Promise.html" class="crosslink">Promise</a></span>:
+
+ Promise to be fulfilled when all provided promises are
+ resolved
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_before" class="method item inherited">
+ <h3 class="name"><code>before</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_before">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l870"><code>event-custom/js/event-target.js:870</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Executes the callback before a DOM event, custom event
+or method. If the first argument is a function, it
+is assumed the target is a method. For DOM and custom
+events, this is an alias for Y.on.</p>
+
+<p>For DOM and custom events:
+type, callback, context, 0-n arguments</p>
+
+<p>For methods:
+callback, object (method host), methodName, context, 0-n arguments</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ detach handle
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_bind" class="method item">
+ <h3 class="name"><code>bind</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>f</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>c</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>args</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/oop.html">oop</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/oop_js_oop.js.html#l355"><code>oop/js/oop.js:355</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns a function that will execute the supplied function in the
+supplied object's context, optionally adding any additional
+supplied parameters to the beginning of the arguments collection the
+supplied to the function.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">f</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the function to bind, or a function name
+to execute on the context object.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">c</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the execution context.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type">Any</span>
+
+
+
+ <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+
+
+ <div class="param-description">
+ <p>0..n arguments to include before the arguments the
+function is executed with.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>:
+
+ the wrapped function.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_bubble" class="method item inherited">
+ <h3 class="name"><code>bubble</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>evt</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_bubble">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-facade.js.html#l507"><code>event-custom/js/event-facade.js:507</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Propagate an event. Requires the event-custom-complex module.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">evt</code>
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the custom event to propagate</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ the aggregated return value from Event.Custom.fire
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_cached" class="method item">
+ <h3 class="name"><code>cached</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>source</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[cache={}]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[refetch]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui-core.js.html#l15"><code>yui/js/yui-core.js:15</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns a wrapper for a function which caches the return value of that function,
+keyed off of the combined string representation of the argument values provided
+when the wrapper is called.</p>
+
+<p>Calling this function again with the same arguments will return the cached value
+rather than executing the wrapped function.</p>
+
+<p>Note that since the cache is keyed off of the string representation of arguments
+passed to the wrapper function, arguments that aren't strings and don't provide
+a meaningful <code>toString()</code> method may result in unexpected caching behavior. For
+example, the objects <code>{}</code> and <code>{foo: 'bar'}</code> would both be converted to the
+string <code>[object Object]</code> when used as a cache key.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">source</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The function to memoize.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[cache={}]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Object in which to store cached values. You may seed
+ this object with pre-existing cached values if desired.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[refetch]</code>
+ <span class="type">Any</span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>If supplied, this value is compared with the cached value
+ using a <code>==</code> comparison. If the values are equal, the wrapped function is
+ executed again even though a cached value exists.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>:
+
+ Wrapped function.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_clone" class="method item">
+ <h3 class="name"><code>clone</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>safe</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>f</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>c</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>owner</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>cloned</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/oop.html">oop</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/oop_js_oop.js.html#l233"><code>oop/js/oop.js:233</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Deep object/array copy. Function clones are actually wrappers around the
+original function. Array-like objects are treated as arrays. Primitives are
+returned untouched. Optionally, a function can be provided to handle other data
+types, filter keys, validate values, etc.</p>
+
+<p><strong>Note:</strong> Cloning a non-trivial object is a reasonably heavy operation, due to
+the need to recursively iterate down non-primitive properties. Clone should be
+used only when a deep clone down to leaf level properties is explicitly
+required. This method will also</p>
+
+<p>In many cases (for example, when trying to isolate objects used as hashes for
+configuration properties), a shallow copy, using <code>Y.merge()</code> is normally
+sufficient. If more than one level of isolation is required, <code>Y.merge()</code> can be
+used selectively at each level which needs to be isolated from the original
+without going all the way to leaf properties.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>what to clone.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">safe</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>if true, objects will not have prototype items from the
+ source. If false, they will. In this case, the original is initially
+ protected, but the clone is not completely immune from changes to the source
+ object prototype. Also, cloned prototype items that are deleted from the
+ clone will result in the value of the source prototype being exposed. If
+ operating on a non-safe clone, items should be nulled out rather than
+ deleted.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">f</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional function to apply to each item in a collection; it
+ will be executed prior to applying the value to the new object.
+ Return false to prevent the copy.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">c</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional execution context for f.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">owner</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Owner object passed when clone is iterating an object.
+ Used to set up context for cloned functions.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">cloned</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>hash of previously cloned objects to avoid multiple
+ clones.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ the cloned object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_delegate" class="method item">
+ <h3 class="name"><code>delegate</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>el</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>filter</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>context</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>args</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-delegate.html">event-delegate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_delegate.js.html#l311"><code>event/js/delegate.js:311</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Sets up event delegation on a container element. The delegated event
+will use a supplied filter to test if the callback should be executed.
+This filter can be either a selector string or a function that returns
+a Node to use as the currentTarget for the event.</p>
+
+<p>The event object for the delegated event is supplied to the callback
+function. It is modified slightly in order to support all properties
+that may be needed for event delegation. 'currentTarget' is set to
+the element that matched the selector string filter or the Node returned
+from the filter function. 'container' is set to the element that the
+listener is delegated from (this normally would be the 'currentTarget').</p>
+
+<p>Filter functions will be called with the arguments that would be passed to
+the callback function, including the event object as the first parameter.
+The function should return false (or a falsey value) if the success criteria
+aren't met, and the Node to use as the event's currentTarget and 'this'
+object if they are.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the event type to delegate</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the callback function to execute. This function
+will be provided the event object for the delegated event.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">el</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the element that is the delegation container</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">filter</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>a selector that must match the target of the
+event or a function that returns a Node or false.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">context</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional argument that specifies what 'this' refers to.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+ <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to pass on to the callback function.
+These arguments will be added after the event object.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
+
+ the detach handle
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_destroy" class="method item">
+ <h3 class="name"><code>destroy</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l1390"><code>yui/js/yui.js:1390</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.3.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Destroys this YUI instance.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method_detach" class="method item inherited">
+ <h3 class="name"><code>detach</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>context</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_detach">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l346"><code>event-custom/js/event-target.js:346</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Detach one or more listeners the from the specified event</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Either the handle to the subscriber or the
+ type of event. If the type
+ is not specified, it will attempt to remove
+ the listener from all hosted events.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The subscribed function to unsubscribe, if not
+ supplied, all subscribers will be removed.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">context</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The custom object passed to subscribe. This is
+ optional, but if supplied will be used to
+ disambiguate multiple listeners that are the same
+ (e.g., you subscribe many object using a function
+ that lives on the prototype)</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:
+
+ the host
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_detachAll" class="method item inherited">
+ <h3 class="name"><code>detachAll</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_detachAll">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l469"><code>event-custom/js/event-target.js:469</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes all listeners from the specified event. If the event type
+is not specified, all listeners from all hosted custom events will
+be removed.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The type, or name of the event</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_dump" class="method item">
+ <h3 class="name"><code>dump</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>d</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/dump.html">dump</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/dump_js_dump.js.html#l18"><code>dump/js/dump.js:18</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns a simple string representation of the object or array.
+Other types of objects will be returned unprocessed. Arrays
+are expected to be indexed.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The object to dump.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">d</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>How deep to recurse child objects, default 3.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ the dump result.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_each" class="method item">
+ <h3 class="name"><code>each</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>f</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>c</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>proto</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/YUI.html" class="crosslink">YUI</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/oop.html">oop</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/oop_js_oop.js.html#l197"><code>oop/js/oop.js:197</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Executes the supplied function for each item in
+a collection. Supports arrays, objects, and
+NodeLists</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the object to iterate.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">f</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the function to execute. This function
+receives the value, key, and object as parameters.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">c</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the execution context for the function.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">proto</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>if true, prototype properties are
+iterated on objects.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/YUI.html" class="crosslink">YUI</a></span>:
+
+ the YUI instance.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_error" class="method item">
+ <h3 class="name"><code>error</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>msg</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[e]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[src]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l1298"><code>yui/js/yui.js:1298</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Reports an error.</p>
+
+<p>The reporting mechanism is controlled by the <code>throwFail</code> configuration
+attribute. If <code>throwFail</code> is falsy, the message is logged. If <code>throwFail</code> is
+truthy, a JS exception is thrown.</p>
+
+<p>If an <code>errorFn</code> is specified in the config it must return <code>true</code> to indicate
+that the exception was handled and keep it from being thrown.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">msg</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Error message.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[e]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>JavaScript error object or an error string.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[src]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Source of the error (such as the name of the module in
+ which the error occurred).</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_extend" class="method item">
+ <h3 class="name"><code>extend</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>r</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>s</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>px</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>sx</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/oop.html">oop</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/oop_js_oop.js.html#l156"><code>oop/js/oop.js:156</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Utility to set up the prototype, constructor and superclass properties to
+support an inheritance strategy that can chain constructors and methods.
+Static members will not be inherited.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">r</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the object to modify.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">s</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the object to inherit.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">px</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>prototype properties to add/override.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">sx</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>static properties to add/override.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ the extended object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_fail" class="method item">
+ <h3 class="name"><code>fail</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>message</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/test.html">test</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/test_js_YTestWrapAfter.js.html#l45"><code>test/js/YTestWrapAfter.js:45</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Forces an assertion error to occur. Shortcut for Y.Assert.fail().</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">message</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>(Optional) The message to display with the failure.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_fire" class="method item inherited">
+ <h3 class="name"><code>fire</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>arguments</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_fire">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l695"><code>event-custom/js/event-target.js:695</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Fire a custom event by name. The callback functions will be executed
+from the context specified when the event was created, and with the
+following parameters.</p>
+
+<p>If the custom event object hasn't been created, then the event hasn't
+been published and it has no subscribers. For performance sake, we
+immediate exit in this case. This means the event won't bubble, so
+if the intention is that a bubble target be notified, the event must
+be published on this object first.</p>
+
+<p>The first argument is the event type, and any additional arguments are
+passed to the listeners as parameters. If the first of these is an
+object literal, and the event is configured to emit an event facade,
+that object is mixed into the event facade and the facade is provided
+in place of the original object.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The type of the event, or an object that contains
+a 'type' property.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">arguments</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object*</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>an arbitrary set of parameters to pass to
+the handler. If the first of these is an object literal and the event is
+configured to emit an event facade, the event facade will replace that
+parameter after the properties the object literal contains are copied to
+the event facade.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:
+
+ the event host
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_getEvent" class="method item inherited">
+ <h3 class="name"><code>getEvent</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>prefixed</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l814"><code>event-custom/js/event-target.js:814</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns the custom event of the provided type has been created, a
+falsy value otherwise</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the type, or name of the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">prefixed</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>if true, the type is prefixed already</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
+
+ the custom event or null
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_getLocation" class="method item">
+ <h3 class="name"><code>getLocation</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type">Location</span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui-core.js.html#l57"><code>yui/js/yui-core.js:57</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Returns the <code>location</code> object from the window/frame in which this YUI instance
+operates, or <code>undefined</code> when executing in a non-browser environment
+(e.g. Node.js).</p>
+
+<p>It is <em>not</em> recommended to hold references to the <code>window.location</code> object
+outside of the scope of a function in which its properties are being accessed or
+its methods are being called. This is because of a nasty bug/issue that exists
+in both Safari and MobileSafari browsers:
+<a href="https://bugs.webkit.org/show_bug.cgi?id=34679">WebKit Bug 34679</a>.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type">Location</span>:
+
+ The <code>location</code> object from the window/frame in which this YUI
+ instance operates.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_getTargets" class="method item inherited">
+ <h3 class="name"><code>getTargets</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-facade.js.html#l479"><code>event-custom/js/event-facade.js:479</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns an array of bubble targets for this object.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ EventTarget[]
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_guid" class="method item">
+ <h3 class="name"><code>guid</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code class="optional">[pre]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l1333"><code>yui/js/yui.js:1333</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Generates an id string that is unique among all YUI instances in this
+execution context.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[pre]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Prefix.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Unique id.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_header" class="method item">
+ <h3 class="name"><code>header</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>value</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/io_js_io-base.js.html#l895"><code>io/js/io-base.js:895</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Method for setting and deleting IO HTTP headers to be sent with every
+request.</p>
+
+<p>Hosted as a property on the <code>io</code> function (e.g. <code>Y.io.header</code>).</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>HTTP header</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">value</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>HTTP header value</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_instanceOf" class="method item">
+ <h3 class="name"><code>instanceOf</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l1406"><code>yui/js/yui.js:1406</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.3.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Safe <code>instanceof</code> wrapper that works around a memory leak in IE when the
+object being tested is <code>window</code> or <code>document</code>.</p>
+
+<p>Unless you are testing objects that may be <code>window</code> or <code>document</code>, you
+should use the native <code>instanceof</code> operator instead of this method.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Object to check.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Class to check against.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_io" class="method item">
+ <h3 class="name"><code>io</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>config</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/io-base.html">io-base</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/io_js_io-base.js.html#l783"><code>io/js/io-base.js:783</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Method for initiating an ajax call. The first argument is the url end
+point for the call. The second argument is an object to configure the
+transaction and attach event subscriptions. The configuration object
+supports the following properties:</p>
+
+<dl>
+ <dt>method</dt>
+ <dd>HTTP method verb (e.g., GET or POST). If this property is not
+ not defined, the default value will be GET.</dd>
+
+ <dt>data</dt>
+ <dd>This is the name-value string that will be sent as the
+ transaction data. If the request is HTTP GET, the data become
+ part of querystring. If HTTP POST, the data are sent in the
+ message body.</dd>
+
+ <dt>xdr</dt>
+ <dd>Defines the transport to be used for cross-domain requests.
+ By setting this property, the transaction will use the specified
+ transport instead of XMLHttpRequest. The properties of the
+ transport object are:
+ <dl>
+ <dt>use</dt>
+ <dd>The transport to be used: 'flash' or 'native'</dd>
+ <dt>dataType</dt>
+ <dd>Set the value to 'XML' if that is the expected response
+ content type.</dd>
+ </dl></dd>
+
+ <dt>form</dt>
+ <dd>Form serialization configuration object. Its properties are:
+ <dl>
+ <dt>id</dt>
+ <dd>Node object or id of HTML form</dd>
+ <dt>useDisabled</dt>
+ <dd><code>true</code> to also serialize disabled form field values
+ (defaults to <code>false</code>)</dd>
+ </dl></dd>
+
+ <dt>on</dt>
+ <dd>Assigns transaction event subscriptions. Available events are:
+ <dl>
+ <dt>start</dt>
+ <dd>Fires when a request is sent to a resource.</dd>
+ <dt>complete</dt>
+ <dd>Fires when the transaction is complete.</dd>
+ <dt>success</dt>
+ <dd>Fires when the HTTP response status is within the 2xx
+ range.</dd>
+ <dt>failure</dt>
+ <dd>Fires when the HTTP response status is outside the 2xx
+ range, if an exception occurs, if the transation is aborted,
+ or if the transaction exceeds a configured <code>timeout</code>.</dd>
+ <dt>end</dt>
+ <dd>Fires at the conclusion of the transaction
+ lifecycle, after <code>success</code> or <code>failure</code>.</dd>
+ </dl>
+
+ <p>Callback functions for <code>start</code> and <code>end</code> receive the id of the
+ transaction as a first argument. For <code>complete</code>, <code>success</code>, and
+ <code>failure</code>, callbacks receive the id and the response object
+ (usually the XMLHttpRequest instance). If the <code>arguments</code>
+ property was included in the configuration object passed to
+ <code>Y.io()</code>, the configured data will be passed to all callbacks as
+ the last argument.</p>
+ </dd>
+
+ <dt>sync</dt>
+ <dd>Pass <code>true</code> to make a same-domain transaction synchronous.
+ <strong>CAVEAT</strong>: This will negatively impact the user
+ experience. Have a <em>very</em> good reason if you intend to use
+ this.</dd>
+
+ <dt>context</dt>
+ <dd>The "`this'" object for all configured event handlers. If a
+ specific context is needed for individual callbacks, bind the
+ callback to a context using <code>Y.bind()</code>.</dd>
+
+ <dt>headers</dt>
+ <dd>Object map of transaction headers to send to the server. The
+ object keys are the header names and the values are the header
+ values.</dd>
+
+ <dt>timeout</dt>
+ <dd>Millisecond threshold for the transaction before being
+ automatically aborted.</dd>
+
+ <dt>arguments</dt>
+ <dd>User-defined data passed to all registered event handlers.
+ This value is available as the second argument in the "start" and
+ "end" event handlers. It is the third argument in the "complete",
+ "success", and "failure" event handlers. <strong>Be sure to quote
+ this property name in the transaction configuration as
+ "arguments" is a reserved word in JavaScript</strong> (e.g.
+ <code>Y.io({ ..., "arguments": stuff })</code>).</dd>
+</dl>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>qualified path to transaction resource.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">config</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>configuration object for the transaction.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_jsonp" class="method item">
+ <h3 class="name"><code>jsonp</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>c</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>args</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/JSONPRequest.html" class="crosslink">JSONPRequest</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/jsonp.html">jsonp</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/jsonp_js_jsonp.js.html#l232"><code>jsonp/js/jsonp.js:232</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the url of the JSONP service with the {callback}
+ placeholder where the callback function name typically goes.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">c</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Callback function accepting the JSON payload
+ as its argument, or a configuration object (see above).</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type">Any</span>
+
+
+
+ <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+
+
+ <div class="param-description">
+ <p>additional arguments to pass to send()</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/JSONPRequest.html" class="crosslink">JSONPRequest</a></span>:
+
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_later" class="method item">
+ <h3 class="name"><code>later</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>when</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>data</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>periodic</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/yui-later.html">yui-later</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui-later.js.html#l11"><code>yui/js/yui-later.js:11</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Executes the supplied function in the context of the supplied
+object 'when' milliseconds later. Executes the function a
+single time unless periodic is set to true.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">when</code>
+ <span class="type">Int</span>
+
+
+
+
+ <div class="param-description">
+ <p>the number of milliseconds to wait until the fn
+is executed.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the context object.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the function to execute or the name of
+the method in the 'o' object to execute.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">data</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>[Array] data that is provided to the function. This
+accepts either a single item or an array. If an array is provided,
+the function is executed with one parameter for each array item.
+If you need to pass a single array parameter, it needs to be wrapped
+in an array [myarray].</p>
+
+<p>Note: native methods in IE may not have the call and apply methods.
+In this case, it will work, but you are limited to four arguments.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">periodic</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>if true, executes continuously at supplied
+interval until canceled.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ a timer object. Call the cancel() method on this
+object to stop the timer.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_log" class="method item">
+ <h3 class="name"><code>log</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>msg</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>cat</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>src</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>silent</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/YUI.html" class="crosslink">YUI</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/yui-log.html">yui-log</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui-log.js.html#l18"><code>yui/js/yui-log.js:18</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>If the 'debug' config is true, a 'yui:log' event will be
+dispatched, which the Console widget and anything else
+can consume. If the 'useBrowserConsole' config is true, it will
+write to the browser console if available. YUI-specific log
+messages will only be present in the -debug versions of the
+JS files. The build system is supposed to remove log statements
+from the raw and minified versions of the files.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">msg</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The message to log.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">cat</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The log category for the message. Default
+ categories are "info", "warn", "error", time".
+ Custom categories can be used as well. (opt).</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">src</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The source of the the message (opt).</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">silent</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>If true, the log event won't fire.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/YUI.html" class="crosslink">YUI</a></span>:
+
+ YUI instance.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_merge" class="method item">
+ <h3 class="name"><code>merge</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>objects</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui-core.js.html#l86"><code>yui/js/yui-core.js:86</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns a new object containing all of the properties of all the supplied
+objects. The properties from later objects will overwrite those in earlier
+objects.</p>
+
+<p>Passing in a single object will create a shallow copy of it. For a deep copy,
+use <code>clone()</code>.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">objects</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+ <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+
+
+ <div class="param-description">
+ <p>One or more objects to merge.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ A new merged object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_message" class="method item">
+ <h3 class="name"><code>message</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>msg</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>cat</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>src</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>silent</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/YUI.html" class="crosslink">YUI</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/yui-log.html">yui-log</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui-log.js.html#l100"><code>yui/js/yui-log.js:100</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Write a system message. This message will be preserved in the
+minified and raw versions of the YUI files, unlike log statements.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">msg</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The message to log.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">cat</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The log category for the message. Default
+ categories are "info", "warn", "error", time".
+ Custom categories can be used as well. (opt).</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">src</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The source of the the message (opt).</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">silent</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>If true, the log event won't fire.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/YUI.html" class="crosslink">YUI</a></span>:
+
+ YUI instance.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_mix" class="method item">
+ <h3 class="name"><code>mix</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>receiver</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>supplier</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[overwrite=false]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[whitelist]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[mode=0]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[merge=false]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="../classes/YUI.html" class="crosslink">YUI</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui-core.js.html#l118"><code>yui/js/yui-core.js:118</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Mixes <em>supplier</em>'s properties into <em>receiver</em>.</p>
+
+<p>Properties on <em>receiver</em> or <em>receiver</em>'s prototype will not be overwritten or
+shadowed unless the <em>overwrite</em> parameter is <code>true</code>, and will not be merged
+unless the <em>merge</em> parameter is <code>true</code>.</p>
+
+<p>In the default mode (0), only properties the supplier owns are copied (prototype
+properties are not copied). The following copying modes are available:</p>
+
+<ul>
+<li><code>0</code>: <em>Default</em>. Object to object.</li>
+<li><code>1</code>: Prototype to prototype.</li>
+<li><code>2</code>: Prototype to prototype and object to object.</li>
+<li><code>3</code>: Prototype to object.</li>
+<li><code>4</code>: Object to prototype.</li>
+</ul>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">receiver</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The object or function to receive the mixed
+ properties.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">supplier</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The object or function supplying the
+ properties to be mixed.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[overwrite=false]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>If <code>true</code>, properties that already exist
+ on the receiver will be overwritten with properties from the supplier.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[whitelist]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>An array of property names to copy. If
+ specified, only the whitelisted properties will be copied, and all others
+ will be ignored.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[mode=0]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Mix mode to use. See above for available modes.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[merge=false]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>If <code>true</code>, objects and arrays that already
+ exist on the receiver will have the corresponding object/array from the
+ supplier merged into them, rather than being skipped or overwritten. When
+ both <em>overwrite</em> and <em>merge</em> are <code>true</code>, <em>merge</em> takes precedence.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="../classes/YUI.html" class="crosslink">YUI</a></span>:
+
+ The receiver, or the YUI instance if the
+ specified receiver is falsy.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_namespace" class="method item">
+ <h3 class="name"><code>namespace</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>namespace</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l1233"><code>yui/js/yui.js:1233</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Utility method for safely creating namespaces if they don't already exist.
+May be called statically on the YUI global object or as a method on a YUI
+instance.</p>
+
+<p>When called statically, a namespace will be created on the YUI global
+object:</p>
+
+<pre class="code prettyprint"><code>// Create <code>YUI.your.namespace.here</code> as nested objects, preserving any
+// objects that already exist instead of overwriting them.
+YUI.namespace('your.namespace.here');
+</code></pre>
+
+<p>When called as a method on a YUI instance, a namespace will be created on
+that instance:</p>
+
+<pre class="code prettyprint"><code>// Creates <code>Y.property.package</code>.
+Y.namespace('property.package');
+</code></pre>
+
+<p>Dots in the input string cause <code>namespace</code> to create nested objects for each
+token. If any part of the requested namespace already exists, the current
+object will be left in place and will not be overwritten. This allows
+multiple calls to <code>namespace</code> to preserve existing namespaced properties.</p>
+
+<p>If the first token in the namespace string is "YAHOO", that token is
+discarded. This is legacy behavior for backwards compatibility with YUI 2.</p>
+
+<p>Be careful with namespace tokens. Reserved words may work in some browsers
+and not others. For instance, the following will fail in some browsers
+because the supported version of JavaScript reserves the word "long":</p>
+
+<pre class="code prettyprint"><code>Y.namespace('really.long.nested.namespace');
+</code></pre>
+
+<p>Note: If you pass multiple arguments to create multiple namespaces, only the
+last one created is returned from this function.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">namespace</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+ <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+
+
+ <div class="param-description">
+ <p>One or more namespaces to create.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ Reference to the last namespace object created.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_on" class="method item">
+ <h3 class="name"><code>on</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[context]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[arg*]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_on">
+ EventTarget
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l911"><code>event-custom/js/event-target.js:911</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p><code>Y.on()</code> can do many things:</p>
+
+<ul>
+ <li>Subscribe to custom events <code>publish</code>ed and <code>fire</code>d from Y</li>
+ <li>Subscribe to custom events <code>publish</code>ed with <code>broadcast</code> 1 or 2 and
+ <code>fire</code>d from any object in the YUI instance sandbox</li>
+ <li>Subscribe to DOM events</li>
+ <li>Subscribe to the execution of a method on any object, effectively
+ treating that method as an event</li>
+</ul>
+
+<p>For custom event subscriptions, pass the custom event name as the first argument
+and callback as the second. The <code>this</code> object in the callback will be <code>Y</code> unless
+an override is passed as the third argument.</p>
+
+<pre class="code prettyprint"><code>Y.on('io:complete', function () {
+ Y.MyApp.updateStatus('Transaction complete');
+});
+</code></pre>
+
+<p>To subscribe to DOM events, pass the name of a DOM event as the first argument
+and a CSS selector string as the third argument after the callback function.
+Alternately, the third argument can be a <code>Node</code>, <code>NodeList</code>, <code>HTMLElement</code>,
+array, or simply omitted (the default is the <code>window</code> object).</p>
+
+<pre class="code prettyprint"><code>Y.on('click', function (e) {
+ e.preventDefault();
+
+ // proceed with ajax form submission
+ var url = this.get('action');
+ ...
+}, '#my-form');
+</code></pre>
+
+<p>The <code>this</code> object in DOM event callbacks will be the <code>Node</code> targeted by the CSS
+selector or other identifier.</p>
+
+<p><code>on()</code> subscribers for DOM events or custom events <code>publish</code>ed with a
+<code>defaultFn</code> can prevent the default behavior with <code>e.preventDefault()</code> from the
+event object passed as the first parameter to the subscription callback.</p>
+
+<p>To subscribe to the execution of an object method, pass arguments corresponding to the call signature for
+<a href="../classes/Do.html#methods_before"><code>Y.Do.before(...)</code></a>.</p>
+
+<p>NOTE: The formal parameter list below is for events, not for function
+injection. See <code>Y.Do.before</code> for that signature.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>DOM or custom event name</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute in response to the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[context]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Override <code>this</code> object in callback</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[arg*]</code>
+ <span class="type">Any</span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to supply to the subscriber</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
+
+ A subscription handle capable of detaching the
+ subscription
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_once" class="method item">
+ <h3 class="name"><code>once</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[context]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[arg*]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_once">
+ EventTarget
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l968"><code>event-custom/js/event-target.js:968</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Listen for an event one time. Equivalent to <code>on()</code>, except that
+the listener is immediately detached when executed.</p>
+
+<p>See the <a href="#methods_on"><code>on()</code> method</a> for additional subscription
+options.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>DOM or custom event name</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute in response to the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[context]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Override <code>this</code> object in callback</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[arg*]</code>
+ <span class="type">Any</span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to supply to the subscriber</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
+
+ A subscription handle capable of detaching the
+ subscription
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_onceAfter" class="method item">
+ <h3 class="name"><code>onceAfter</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[context]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[arg*]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_onceAfter">
+ EventTarget
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l986"><code>event-custom/js/event-target.js:986</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Listen for an event one time. Equivalent to <code>once()</code>, except, like <code>after()</code>,
+the subscription callback executes after all <code>on()</code> subscribers and the event's
+<code>defaultFn</code> (if configured) have executed. Like <code>after()</code> if any <code>on()</code> phase
+subscriber calls <code>e.preventDefault()</code>, neither the <code>defaultFn</code> nor the <code>after()</code>
+subscribers will execute.</p>
+
+<p>The listener is immediately detached when executed.</p>
+
+<p>See the <a href="#methods_on"><code>on()</code> method</a> for additional subscription
+options.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The custom event name</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute in response to the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[context]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Override <code>this</code> object in callback</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[arg*]</code>
+ <span class="type">Any</span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to supply to the subscriber</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
+
+ A subscription handle capable of detaching the
+ subscription
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_one" class="method item">
+ <h3 class="name"><code>one</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>node</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | null</span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/node-core.html">node-core</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/node_js_node-core.js.html#l252"><code>node/js/node-core.js:252</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns a single Node instance bound to the node or the
+first element matching the given selector. Returns null if no match found.
+<strong>Note:</strong> For chaining purposes you may want to
+use <code>Y.all</code>, which returns a NodeList when no match is found.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">node</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>a node or Selector</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | null</span>:
+
+ a Node instance or null if no match found.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_parseType" class="method item inherited">
+ <h3 class="name"><code>parseType</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[pre=this._yuievt.config.prefix]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_parseType">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l168"><code>event-custom/js/event-target.js:168</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.3.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Takes the type parameter passed to 'on' and parses out the
+various pieces that could be included in the type. If the
+event type is passed without a prefix, it will be expanded
+to include the prefix one is supplied or the event target
+is configured with a default prefix.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the type</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[pre=this._yuievt.config.prefix]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>the prefix</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
+
+ an array containing:
+ * the detach category, if supplied,
+ * the prefixed event type,
+ * whether or not this is an after listener,
+ * the supplied event type
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_publish" class="method item inherited">
+ <h3 class="name"><code>publish</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>opts</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_publish">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l493"><code>event-custom/js/event-target.js:493</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Creates a new custom event of the specified type. If a custom event
+by that name already exists, it will not be re-created. In either
+case the custom event is returned.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the type, or name of the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">opts</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional config params. Valid properties are:</p>
+
+<p><ul>
+ <li>
+ 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)
+ </li>
+ <li>
+ 'bubbles': whether or not this event bubbles (true)
+ Events can only bubble if emitFacade is true.
+ </li>
+ <li>
+ 'context': the default execution context for the listeners (this)
+ </li>
+ <li>
+ 'defaultFn': the default function to execute when this event fires if preventDefault was not called
+ </li>
+ <li>
+ 'emitFacade': whether or not this event emits a facade (false)
+ </li>
+ <li>
+ 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
+ </li>
+ <li>
+ 'fireOnce': if an event is configured to fire once, new subscribers after
+ the fire will be notified immediately.
+ </li>
+ <li>
+ 'async': fireOnce event listeners will fire synchronously if the event has already
+ fired unless async is true.
+ </li>
+ <li>
+ 'preventable': whether or not preventDefault() has an effect (true)
+ </li>
+ <li>
+ 'preventedFn': a function that is executed when preventDefault is called
+ </li>
+ <li>
+ 'queuable': whether or not this event can be queued during bubbling (false)
+ </li>
+ <li>
+ 'silent': if silent is true, debug messages are not provided for this event.
+ </li>
+ <li>
+ 'stoppedFn': a function that is executed when stopPropagation is called
+ </li></p>
+
+<p><li>
+ 'monitored': specifies whether or not this event should send notifications about
+ when the event has been attached, detached, or published.
+ </li>
+ <li>
+ 'type': the event type (valid option if not provided as the first parameter to publish)
+ </li>
+ </ul></p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
+
+ the custom event
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_rbind" class="method item">
+ <h3 class="name"><code>rbind</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>f</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>c</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>args</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/oop.html">oop</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/oop_js_oop.js.html#l380"><code>oop/js/oop.js:380</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns a function that will execute the supplied function in the
+supplied object's context, optionally adding any additional
+supplied parameters to the end of the arguments the function
+is executed with.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">f</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the function to bind, or a function name
+to execute on the context object.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">c</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the execution context.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type">Any</span>
+
+
+
+ <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+
+
+ <div class="param-description">
+ <p>0..n arguments to append to the end of
+arguments collection supplied to the function.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>:
+
+ the wrapped function.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_removeTarget" class="method item inherited">
+ <h3 class="name"><code>removeTarget</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-facade.js.html#l489"><code>event-custom/js/event-facade.js:489</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes a bubble target</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the target to remove</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_setLoadHook" class="method item">
+ <h3 class="name"><code>setLoadHook</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l1497"><code>yui/js/yui.js:1497</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Set a method to be called when <code>Get.script</code> is called in Node.js
+<code>Get</code> will open the file, then pass it's content and it's path
+to this method before attaching it. Commonly used for code coverage
+instrumentation. <strong>Calling this multiple times will only
+attach the last hook method</strong>. This method is only
+available in Node.js.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The function to set</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">data</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+ <div class="param-description">
+ <p>The content of the file</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">path</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+ <div class="param-description">
+ <p>The file path of the file</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_some" class="method item">
+ <h3 class="name"><code>some</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>f</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>c</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>proto</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/oop.html">oop</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/oop_js_oop.js.html#l214"><code>oop/js/oop.js:214</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Executes the supplied function for each item in
+a collection. The operation stops if the function
+returns true. Supports arrays, objects, and
+NodeLists.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the object to iterate.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">f</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the function to execute. This function
+receives the value, key, and object as parameters.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">c</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the execution context for the function.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">proto</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>if true, prototype properties are
+iterated on objects.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ true if the function ever returns true,
+false otherwise.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_soon" class="method item">
+ <h3 class="name"><code>soon</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>callbackFunction</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/timers.html">timers</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/timers_js_timers.js.html#l10"><code>timers/js/timers.js:10</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Y.soon accepts a callback function. The callback function will be called
+once in a future turn of the JavaScript event loop. If the function
+requires a specific execution context or arguments, wrap it with Y.bind.
+Y.soon returns an object with a cancel method. If the cancel method is
+called before the callback function, the callback function won't be
+called.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">callbackFunction</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ An object with a cancel method. If the cancel method is
+called before the callback function, the callback function won't be
+called.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_stamp" class="method item">
+ <h3 class="name"><code>stamp</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>readOnly</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l1346"><code>yui/js/yui.js:1346</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns a unique id associated with the given object and (if <em>readOnly</em> is
+falsy) stamps the object with that id so it can be identified in the future.</p>
+
+<p>Stamping an object involves adding a <code>_yuid</code> property to it that contains
+the object's id. One exception to this is that in Internet Explorer, DOM
+nodes have a <code>uniqueID</code> property that contains a browser-generated unique
+id, which will be used instead of a YUI-generated id when available.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Object to stamp.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">readOnly</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>If truthy and the given object has not already
+ been stamped, the object will not be modified and <code>null</code> will be
+ returned.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Object's unique id, or <code>null</code> if <em>readOnly</em> was truthy and
+ the given object was not already stamped.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_subscribe" class="method item deprecated inherited">
+ <h3 class="name"><code>subscribe</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+ <span class="flag deprecated" title="use on">deprecated</span>
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l336"><code>event-custom/js/event-target.js:336</code></a>
+
+ </p>
+
+
+
+ <p>Deprecated: use on</p>
+
+
+
+ </div>
+
+ <div class="description">
+ <p>subscribe to an event</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method_throttle" class="method item">
+ <h3 class="name"><code>throttle</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>ms</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/yui-throttle.html">yui-throttle</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui-throttle_js_throttle.js.html#l20"><code>yui-throttle/js/throttle.js:20</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.1.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Throttles a call to a method based on the time between calls.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The function call to throttle.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">ms</code>
+ <span class="type">Int</span>
+
+
+
+
+ <div class="param-description">
+ <p>The number of milliseconds to throttle the method call.
+Can set globally with Y.config.throttleTime or by call. Passing a -1 will
+disable the throttle. Defaults to 150.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>:
+
+ Returns a wrapped function that calls fn throttled.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_unsubscribe" class="method item deprecated inherited">
+ <h3 class="name"><code>unsubscribe</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+ <span class="flag deprecated" title="use detach">deprecated</span>
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l459"><code>event-custom/js/event-target.js:459</code></a>
+
+ </p>
+
+
+
+ <p>Deprecated: use detach</p>
+
+
+
+ </div>
+
+ <div class="description">
+ <p>detach a listener</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method_unsubscribeAll" class="method item deprecated inherited">
+ <h3 class="name"><code>unsubscribeAll</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+ <span class="flag deprecated" title="use detachAll">deprecated</span>
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l480"><code>event-custom/js/event-target.js:480</code></a>
+
+ </p>
+
+
+
+ <p>Deprecated: use detachAll</p>
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes all listeners from the specified event. If the event type
+is not specified, all listeners from all hosted custom events will
+be removed.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The type, or name of the event</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_use" class="method item">
+ <h3 class="name"><code>use</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>modules</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[callback]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l845"><code>yui/js/yui.js:845</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Attaches one or more modules to this YUI instance. When this is executed,
+the requirements of the desired modules are analyzed, and one of several
+things can happen:</p>
+
+<ul>
+<li><p>All required modules have already been loaded, and just need to be
+attached to this YUI instance. In this case, the <code>use()</code> callback will
+be executed synchronously after the modules are attached.</p></li>
+<li><p>One or more modules have not yet been loaded, or the Get utility is not
+available, or the <code>bootstrap</code> config option is <code>false</code>. In this case,
+a warning is issued indicating that modules are missing, but all
+available modules will still be attached and the <code>use()</code> callback will
+be executed synchronously.</p></li>
+<li><p>One or more modules are missing and the Loader is not available but the
+Get utility is, and <code>bootstrap</code> is not <code>false</code>. In this case, the Get
+utility will be used to load the Loader, and we will then proceed to
+the following state:</p></li>
+<li><p>One or more modules are missing and the Loader is available. In this
+case, the Loader will be used to resolve the dependency tree for the
+missing modules and load them and their dependencies. When the Loader is
+finished loading modules, the <code>use()</code> callback will be executed
+asynchronously.</p></li>
+</ul>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">modules</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+ <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+
+
+ <div class="param-description">
+ <p>One or more module names to attach.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[callback]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Callback function to be executed once all
+ specified modules and their dependencies have been attached.</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">Y</code>
+ <span class="type"><a href="../classes/YUI.html" class="crosslink">YUI</a></span>
+
+
+ <div class="param-description">
+ <p>The YUI instance created for this sandbox.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">status</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+ <div class="param-description">
+ <p>Object containing <code>success</code>, <code>msg</code> and
+ <code>data</code> properties.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>// Loads and attaches dd and its dependencies.
+YUI().use('dd', function (Y) {
+ // ...
+});
+
+// Loads and attaches dd and node as well as all of their dependencies.
+YUI().use(['dd', 'node'], function (Y) {
+ // ...
+});
+
+// Attaches all modules that have already been loaded.
+YUI().use('*', function (Y) {
+ // ...
+});
+
+// Attaches a gallery module.
+YUI().use('gallery-yql', function (Y) {
+ // ...
+});
+
+// Attaches a YUI 2in3 module.
+YUI().use('yui2-datatable', function (Y) {
+ // ...
+});
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="method_when" class="method item">
+ <h3 class="name"><code>when</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>promise</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[callback]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[errback]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/Promise.html" class="crosslink">Promise</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/promise.html">promise</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/promise_js_when.js.html#l1"><code>promise/js/when.js:1</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Abstraction API allowing you to interact with promises or raw values as if they
+were promises. If a non-promise object is passed in, a new Resolver is created
+and scheduled to resolve asynchronously with the provided value.</p>
+
+<p>In either case, a promise is returned. If either <em>callback</em> or <em>errback</em> are
+provided, the promise returned is the one returned from calling
+<code>promise.then(callback, errback)</code> on the provided or created promise. If neither
+are provided, the original promise is returned.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">promise</code>
+ <span class="type">Any</span>
+
+
+
+
+ <div class="param-description">
+ <p>Promise object or value to wrap in a resolved promise</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[callback]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>callback to execute if the promise is resolved</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[errback]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>callback to execute if the promise is rejected</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/Promise.html" class="crosslink">Promise</a></span>:
+
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ </div>
+
+
+
+ <div id="properties" class="api-class-tabpanel">
+ <h2 class="off-left">Properties</h2>
+
+
+ <div id="property_Global" class="property item">
+ <h3 class="name"><code>Global</code></h3>
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-custom-base.html">event-custom-base</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l899"><code>event-custom/js/event-target.js:899</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Hosts YUI page level events. This is where events bubble to
+when the broadcast config is set to 2. This property is
+only available if the custom event module is loaded.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property_GlobalConfig" class="property item">
+ <h3 class="name"><code>GlobalConfig</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l75"><code>yui/js/yui.js:75</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Master configuration that might span multiple contexts in a non-
+browser environment. It is applied first to all instances in all
+contexts.</p>
+ </div>
+
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>YUI.GlobalConfig = {
+ filter: 'debug'
+};
+
+YUI().use('node', function (Y) {
+ // debug files used here
+});
+
+YUI({
+ filter: 'min'
+}).use('node', function (Y) {
+ // min files used here
+});
+</code></pre>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="property_meta" class="property item">
+ <h3 class="name"><code>meta</code></h3>
+ <span class="type">Unknown</span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/loader-base.html">loader-base</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/loader_js_loader.js.html#l52"><code>loader/js/loader.js:52</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The component metadata is stored in Y.Env.meta.
+Part of the loader module.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property_version" class="property item">
+ <h3 class="name"><code>version</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l328"><code>yui/js/yui.js:328</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The version number of this YUI instance.</p>
+
+<p>This value is typically updated by a script when a YUI release is built,
+so it may not reflect the correct version number when YUI is run from
+the development source tree.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property_YUI_config" class="property item">
+ <h3 class="name"><code>YUI_config</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/yui_js_yui.js.html#l104"><code>yui/js/yui.js:104</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Page-level config applied to all YUI instances created on the
+current page. This is applied after <code>YUI.GlobalConfig</code> and before
+any instance-level configuration.</p>
+ </div>
+
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>// Single global var to include before YUI seed file
+YUI_config = {
+ filter: 'debug'
+};
+
+YUI().use('node', function (Y) {
+ // debug files used here
+});
+
+YUI({
+ filter: 'min'
+}).use('node', function (Y) {
+ // min files used here
+});
+</code></pre>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ </div>
+
+
+
+
+
+ <div id="events" class="api-class-tabpanel">
+ <h2 class="off-left">Events</h2>
+
+
+ <div id="event_available" class="events item">
+ <h3 class="name"><code>available</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-base.html">event-base</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_available.js.html#l8"><code>event/js/available.js:8</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Executes the callback as soon as the specified element
+is detected in the DOM. This function expects a selector
+string for the element(s) to detect. If you already have
+an element reference, you don't need this event.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>'available'</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the callback function to execute.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">el</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>an selector for the element(s) to attach</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">context</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional argument that specifies what 'this' refers to.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+ <span class="flag multiple" title="This parameter may occur one or more times.">Multiple</span>
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to pass on to the callback function.
+These arguments will be added after the event object.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ <div id="event_contentready" class="events item">
+ <h3 class="name"><code>contentready</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-base.html">event-base</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_available.js.html#l30"><code>event/js/available.js:30</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Executes the callback as soon as the specified element
+is detected in the DOM with a nextSibling property
+(indicating that the element's children are available).
+This function expects a selector
+string for the element(s) to detect. If you already have
+an element reference, you don't need this event.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>'contentready'</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the callback function to execute.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">el</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>an selector for the element(s) to attach.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">context</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional argument that specifies what 'this' refers to.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+ <span class="flag multiple" title="This parameter may occur one or more times.">Multiple</span>
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to pass on to the callback function.
+These arguments will be added after the event object.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ <div id="event_domready" class="events item">
+ <h3 class="name"><code>domready</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event.html">event</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-ready.js.html#l7"><code>event/js/event-ready.js:7</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The domready event fires at the moment the browser's DOM is
+usable. In most cases, this is before images are fully
+downloaded, allowing you to provide a more responsive user
+interface.</p>
+
+<p>In YUI 3, domready subscribers will be notified immediately if
+that moment has already passed when the subscription is created.</p>
+
+<p>One exception is if the yui.js file is dynamically injected into
+the page. If this is done, you must tell the YUI instance that
+you did this in order for DOMReady (and window load events) to
+fire normally. That configuration option is 'injected' -- set
+it to true if the yui.js script is not included inline.</p>
+
+<p>This method is part of the 'event-ready' module, which is a
+submodule of 'event'.</p>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="event_flick" class="events item">
+ <h3 class="name"><code>flick</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-flick.html">event-flick</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event-gestures_js_Flick.js.html#l54"><code>event-gestures/js/Flick.js:54</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Sets up a "flick" event, that is fired whenever the user initiates a flick gesture on the node
+where the listener is attached. The subscriber can specify a minimum distance or velocity for
+which the event is to be fired. The subscriber can also specify if there is a particular axis which
+they are interested in - "x" or "y". If no axis is specified, the axis along which there was most distance
+covered is used.</p>
+
+<p>It is recommended that you use Y.bind to set up context and additional arguments for your event handler,
+however if you want to pass the context and arguments as additional signature arguments to "on",
+you need to provide a null value for the configuration object, e.g: <code>node.on("flick", fn, null, context, arg1, arg2, arg3)</code></p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>"flick"</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The method the event invokes. It receives an event facade with an e.flick object containing the flick related properties: e.flick.time, e.flick.distance, e.flick.velocity and e.flick.axis, e.flick.start.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">cfg</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional. An object which specifies any of the following:</p>
+
+<dl>
+<dt>minDistance (in pixels, defaults to 10)</dt>
+<dd>The minimum distance between start and end points, which would qualify the gesture as a flick.</dd>
+<dt>minVelocity (in pixels/ms, defaults to 0)</dt>
+<dd>The minimum velocity which would qualify the gesture as a flick.</dd>
+<dt>preventDefault (defaults to false)</dt>
+<dd>Can be set to true/false to prevent default behavior as soon as the touchstart/touchend or mousedown/mouseup is received so that things like scrolling or text selection can be
+prevented. This property can also be set to a function, which returns true or false, based on the event facade passed to it.</dd>
+<dt>axis (no default)</dt>
+<dd>Can be set to "x" or "y" if you want to constrain the flick velocity and distance to a single axis. If not
+defined, the axis along which the maximum distance was covered is used.</dd>
+</dl>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ <div id="event_gesturemove" class="events item">
+ <h3 class="name"><code>gesturemove</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-move.html">event-move</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event-gestures_js_Move.js.html#l350"><code>event-gestures/js/Move.js:350</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Sets up a "gesturemove" event, that is fired on touch devices in response to a single finger "touchmove",
+and on mouse based devices in response to a "mousemove".</p>
+
+<p>By default this event is only fired when the same node
+has received a "gesturemovestart" event. The subscriber can set standAlone to true, in the configuration properties,
+if they want to listen for this event without an initial "gesturemovestart".</p>
+
+<p>By default this event sets up it's internal "touchmove" and "mousemove" DOM listeners on the document element. The subscriber
+can set the root configuration property, to specify which node to attach DOM listeners to, if different from the document.</p>
+
+<p>This event can also be listened for using node.delegate().</p>
+
+<p>It is recommended that you use Y.bind to set up context and additional arguments for your event handler,
+however if you want to pass the context and arguments as additional signature arguments to on/delegate,
+you need to provide a null value for the configuration object, e.g: <code>node.on("gesturemove", fn, null, context, arg1, arg2, arg3)</code></p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>"gesturemove"</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The method the event invokes. It receives the event facade of the underlying DOM event (mousemove or touchmove.touches[0]) which contains position co-ordinates.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">cfg</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional. An object which specifies:</p>
+
+<dl>
+<dt>standAlone (defaults to false)</dt>
+<dd>true, if the subscriber should be notified even if a "gesturemovestart" has not occured on the same node.</dd>
+<dt>root (defaults to document)</dt>
+<dd>The node to which the internal DOM listeners should be attached.</dd>
+<dt>preventDefault (defaults to false)</dt>
+<dd>Can be set to true/false to prevent default behavior as soon as the touchmove or mousemove is received. As with gesturemovestart, can also be set to function which returns true/false based on the event facade passed to it.</dd>
+</dl>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ <div id="event_gesturemoveend" class="events item">
+ <h3 class="name"><code>gesturemoveend</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-move.html">event-move</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event-gestures_js_Move.js.html#l475"><code>event-gestures/js/Move.js:475</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Sets up a "gesturemoveend" event, that is fired on touch devices in response to a single finger "touchend",
+and on mouse based devices in response to a "mouseup".</p>
+
+<p>By default this event is only fired when the same node
+has received a "gesturemove" or "gesturemovestart" event. The subscriber can set standAlone to true, in the configuration properties,
+if they want to listen for this event without a preceding "gesturemovestart" or "gesturemove".</p>
+
+<p>By default this event sets up it's internal "touchend" and "mouseup" DOM listeners on the document element. The subscriber
+can set the root configuration property, to specify which node to attach DOM listeners to, if different from the document.</p>
+
+<p>This event can also be listened for using node.delegate().</p>
+
+<p>It is recommended that you use Y.bind to set up context and additional arguments for your event handler,
+however if you want to pass the context and arguments as additional signature arguments to on/delegate,
+you need to provide a null value for the configuration object, e.g: <code>node.on("gesturemoveend", fn, null, context, arg1, arg2, arg3)</code></p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>"gesturemoveend"</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The method the event invokes. It receives the event facade of the underlying DOM event (mouseup or touchend.changedTouches[0]).</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">cfg</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional. An object which specifies:</p>
+
+<dl>
+<dt>standAlone (defaults to false)</dt>
+<dd>true, if the subscriber should be notified even if a "gesturemovestart" or "gesturemove" has not occured on the same node.</dd>
+<dt>root (defaults to document)</dt>
+<dd>The node to which the internal DOM listeners should be attached.</dd>
+<dt>preventDefault (defaults to false)</dt>
+<dd>Can be set to true/false to prevent default behavior as soon as the touchend or mouseup is received. As with gesturemovestart, can also be set to function which returns true/false based on the event facade passed to it.</dd>
+</dl>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ <div id="event_gesturemovestart" class="events item">
+ <h3 class="name"><code>gesturemovestart</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-move.html">event-move</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event-gestures_js_Move.js.html#l156"><code>event-gestures/js/Move.js:156</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Sets up a "gesturemovestart" event, that is fired on touch devices in response to a single finger "touchstart",
+and on mouse based devices in response to a "mousedown". The subscriber can specify the minimum time
+and distance thresholds which should be crossed before the "gesturemovestart" is fired and for the mouse,
+which button should initiate a "gesturemovestart". This event can also be listened for using node.delegate().</p>
+
+<p>It is recommended that you use Y.bind to set up context and additional arguments for your event handler,
+however if you want to pass the context and arguments as additional signature arguments to on/delegate,
+you need to provide a null value for the configuration object, e.g: <code>node.on("gesturemovestart", fn, null, context, arg1, arg2, arg3)</code></p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>"gesturemovestart"</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The method the event invokes. It receives the event facade of the underlying DOM event (mousedown or touchstart.touches[0]) which contains position co-ordinates.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">cfg</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional. An object which specifies:</p>
+
+<dl>
+<dt>minDistance (defaults to 0)</dt>
+<dd>The minimum distance threshold which should be crossed before the gesturemovestart is fired</dd>
+<dt>minTime (defaults to 0)</dt>
+<dd>The minimum time threshold for which the finger/mouse should be help down before the gesturemovestart is fired</dd>
+<dt>button (no default)</dt>
+<dd>In the case of a mouse input device, if the event should only be fired for a specific mouse button.</dd>
+<dt>preventDefault (defaults to false)</dt>
+<dd>Can be set to true/false to prevent default behavior as soon as the touchstart or mousedown is received (that is before minTime or minDistance thresholds are crossed, and so before the gesturemovestart listener is notified) so that things like text selection and context popups (on touch devices) can be
+prevented. This property can also be set to a function, which returns true or false, based on the event facade passed to it (for example, DragDrop can determine if the target is a valid handle or not before preventing default).</dd>
+</dl>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ <div id="event_hashchange" class="events item">
+ <h3 class="name"><code>hashchange</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/history-hash.html">history-hash</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/history_js_history-hash.js.html#l330"><code>history/js/history-hash.js:330</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.2.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Synthetic <code>window.onhashchange</code> event that normalizes differences
+across browsers and provides support for browsers that don't natively support
+<code>onhashchange</code>.</p>
+
+<p>This event is provided by the <code>history-hash</code> module.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Event facade with the following additional
+ properties:</p>
+
+<dl>
+ <dt>oldHash</dt>
+ <dd>
+ Previous hash fragment value before the change.
+ </dd>
+
+ <dt>oldUrl</dt>
+ <dd>
+ Previous URL (including the hash fragment) before the change.
+ </dd>
+
+ <dt>newHash</dt>
+ <dd>
+ New hash fragment value after the change.
+ </dd>
+
+ <dt>newUrl</dt>
+ <dd>
+ New URL (including the hash fragment) after the change.
+ </dd>
+</dl>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>YUI().use('history-hash', function (Y) {
+ Y.on('hashchange', function (e) {
+ // Handle hashchange events on the current window.
+ }, Y.config.win);
+});
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="event_key" class="events item">
+ <h3 class="name"><code>key</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-key.html">event-key</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_key.js.html#l131"><code>event/js/key.js:131</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Add a key listener. The listener will only be notified if the
+keystroke detected meets the supplied specification. The
+specification is a string that is defined as:</p>
+
+<dl>
+ <dt>spec</dt>
+ <dd><code>[{type}:]{code}[,{code}]*</code></dd>
+ <dt>type</dt>
+ <dd><code>"down", "up", or "press"</code></dd>
+ <dt>code</dt>
+ <dd><code>{keyCode|character|keyName}[+{modifier}]*</code></dd>
+ <dt>modifier</dt>
+ <dd><code>"shift", "ctrl", "alt", or "meta"</code></dd>
+ <dt>keyName</dt>
+ <dd><code>"enter", "backspace", "esc", "tab", "pageup", or "pagedown"</code></dd>
+</dl>
+
+<p>Examples:</p>
+
+<ul>
+ <li><code>Y.on("key", callback, "press:12,65+shift+ctrl", "#my-input");</code></li>
+ <li><code>Y.delegate("key", preventSubmit, "#forms", "enter", "input[type=text]");</code></li>
+ <li><code>Y.one("doc").on("key", viNav, "j,k,l,;");</code></li>
+</ul>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>'key'</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the function to execute</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">id</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a> | Collection</span>
+
+
+
+
+ <div class="param-description">
+ <p>the element(s) to bind</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">spec</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the keyCode and modifier specification</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional context object</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to provide to the listener.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ <div id="event_mousewheel" class="events item">
+ <h3 class="name"><code>mousewheel</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-mousewheel.html">event-mousewheel</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_mousewheel.js.html#l25"><code>event/js/mousewheel.js:25</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Mousewheel event. This listener is automatically attached to the
+correct target, so one should not be supplied. Mouse wheel
+direction and velocity is stored in the 'wheelDelta' field.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>'mousewheel'</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the callback to execute</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">context</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional context object</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to provide to the listener.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ <div id="event_valuechange" class="events item">
+ <h3 class="name"><code>valuechange</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-valuechange.html">event-valuechange</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event-valuechange_js_event-valuechange.js.html#l427"><code>event-valuechange/js/event-valuechange.js:427</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Synthetic event that fires when the <code>value</code> property of an <code><input></code> or
+<code><textarea></code> node changes as a result of a user-initiated keystroke, mouse
+operation, or input method editor (IME) input event.</p>
+
+<p>Unlike the <code>onchange</code> event, this event fires when the value actually changes
+and not when the element loses focus. This event also reports IME and
+multi-stroke input more reliably than <code>oninput</code> or the various key events across
+browsers.</p>
+
+<p>For performance reasons, only focused nodes are monitored for changes, so
+programmatic value changes on nodes that don't have focus won't be detected.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">prevVal</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Previous value prior to the latest change.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">newVal</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>New value after the latest change.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>YUI().use('event-valuechange', function (Y) {
+ Y.one('#my-input').on('valuechange', function (e) {
+ Y.log('previous value: ' + e.prevVal);
+ Y.log('new value: ' + e.newVal);
+ });
+});
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="event_windowresize" class="events item">
+ <h3 class="name"><code>windowresize</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-resize.html">event-resize</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_resize-window.js.html#l9"><code>event/js/resize-window.js:9</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Old firefox fires the window resize event once when the resize action
+finishes, other browsers fire the event periodically during the
+resize. This code uses timeout logic to simulate the Firefox
+behavior in other browsers.</p>
+ </div>
+
+
+
+
+
+</div>
+
+
+ </div>
+
+ </div>
+</div>
+
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+<script src="../assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+<script src="../assets/js/yui-prettify.js"></script>
+<script src="../assets/../api.js"></script>
+<script src="../assets/js/api-filter.js"></script>
+<script src="../assets/js/api-list.js"></script>
+<script src="../assets/js/api-search.js"></script>
+<script src="../assets/js/apidocs.js"></script>
+</body>
+</html>