<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>AutoCompleteBase - 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>AutoCompleteBase Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/autocomplete_js_autocomplete-base.js.html#l19"><code>autocomplete/js/autocomplete-base.js:19</code></a>
</div>
Module: <a href="../modules/autocomplete-base.html">autocomplete-base</a><br>
Parent Module: <a href="../modules/autocomplete.html">autocomplete</a>
</div>
<div class="box intro">
<p>Extension that provides core autocomplete logic (but no UI implementation) for a
text input field or textarea.</p>
<p>The <code>AutoCompleteBase</code> class provides events and attributes that abstract away
core autocomplete logic and configuration, but does not provide a widget
implementation or suggestion UI. For a prepackaged autocomplete widget, see
<code>AutoCompleteList</code>.</p>
<p>This extension cannot be instantiated directly, since it doesn't provide an
actual implementation. It's intended to be mixed into a <code>Y.Base</code>-based class or
widget.</p>
<p><code>Y.Widget</code>-based example:</p>
<pre class="code prettyprint"><code>YUI().use('autocomplete-base', 'widget', function (Y) {
var MyAC = Y.Base.create('myAC', Y.Widget, [Y.AutoCompleteBase], {
// Custom prototype methods and properties.
}, {
// Custom static methods and properties.
});
// Custom implementation code.
});
</code></pre>
<p><code>Y.Base</code>-based example:</p>
<pre class="code prettyprint"><code>YUI().use('autocomplete-base', function (Y) {
var MyAC = Y.Base.create('myAC', Y.Base, [Y.AutoCompleteBase], {
initializer: function () {
this._bindUIACBase();
this._syncUIACBase();
},
// Custom prototype methods and properties.
}, {
// Custom static methods and properties.
});
// Custom implementation code.
});
</code></pre>
</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 attrs"><a href="#attrs">Attributes</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 protected">
<a href="#method__afterSourceTypeChange">_afterSourceTypeChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterValueChange">_afterValueChange</a>
</li>
<li class="index-item method protected">
<a href="#method__beforeCreateObjectSource">_beforeCreateObjectSource</a>
</li>
<li class="index-item method protected">
<a href="#method__bindUIACBase">_bindUIACBase</a>
</li>
<li class="index-item method protected">
<a href="#method__createArraySource">_createArraySource</a>
</li>
<li class="index-item method protected">
<a href="#method__createFunctionSource">_createFunctionSource</a>
</li>
<li class="index-item method protected">
<a href="#method__createIOSource">_createIOSource</a>
</li>
<li class="index-item method protected">
<a href="#method__createJSONPSource">_createJSONPSource</a>
</li>
<li class="index-item method protected">
<a href="#method__createObjectSource">_createObjectSource</a>
</li>
<li class="index-item method protected">
<a href="#method__createSelectSource">_createSelectSource</a>
</li>
<li class="index-item method protected">
<a href="#method__createStringSource">_createStringSource</a>
</li>
<li class="index-item method protected">
<a href="#method__createYQLSource">_createYQLSource</a>
</li>
<li class="index-item method protected">
<a href="#method__defaultYQLLocator">_defaultYQLLocator</a>
</li>
<li class="index-item method protected">
<a href="#method__defClearFn">_defClearFn</a>
</li>
<li class="index-item method protected">
<a href="#method__defQueryFn">_defQueryFn</a>
</li>
<li class="index-item method protected">
<a href="#method__defResultsFn">_defResultsFn</a>
</li>
<li class="index-item method protected">
<a href="#method__functionValidator">_functionValidator</a>
</li>
<li class="index-item method protected">
<a href="#method__getObjectValue">_getObjectValue</a>
</li>
<li class="index-item method protected">
<a href="#method__getXHRUrl">_getXHRUrl</a>
</li>
<li class="index-item method protected">
<a href="#method__jsonpFormatter">_jsonpFormatter</a>
</li>
<li class="index-item method protected">
<a href="#method__onInputBlur">_onInputBlur</a>
</li>
<li class="index-item method protected">
<a href="#method__onInputValueChange">_onInputValueChange</a>
</li>
<li class="index-item method protected">
<a href="#method__onResponse">_onResponse</a>
</li>
<li class="index-item method protected">
<a href="#method__parseResponse">_parseResponse</a>
</li>
<li class="index-item method protected">
<a href="#method__parseValue">_parseValue</a>
</li>
<li class="index-item method protected">
<a href="#method__setEnableCache">_setEnableCache</a>
</li>
<li class="index-item method protected">
<a href="#method__setLocator">_setLocator</a>
</li>
<li class="index-item method protected">
<a href="#method__setRequestTemplate">_setRequestTemplate</a>
</li>
<li class="index-item method protected">
<a href="#method__setResultFilters">_setResultFilters</a>
</li>
<li class="index-item method protected">
<a href="#method__setResultHighlighter">_setResultHighlighter</a>
</li>
<li class="index-item method protected">
<a href="#method__setSource">_setSource</a>
</li>
<li class="index-item method protected">
<a href="#method__sourceSuccess">_sourceSuccess</a>
</li>
<li class="index-item method protected">
<a href="#method__syncBrowserAutocomplete">_syncBrowserAutocomplete</a>
</li>
<li class="index-item method protected">
<a href="#method__syncUIACBase">_syncUIACBase</a>
</li>
<li class="index-item method protected">
<a href="#method__updateValue">_updateValue</a>
</li>
<li class="index-item method">
<a href="#method_clearCache">clearCache</a>
</li>
<li class="index-item method">
<a href="#method_sendRequest">sendRequest</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property protected">
<a href="#property__YQL_SOURCE_REGEX">_YQL_SOURCE_REGEX</a>
</li>
<li class="index-item property">
<a href="#property_SOURCE_TYPES">SOURCE_TYPES</a>
<span class="flag static">static</span>
</li>
</ul>
</div>
<div class="index-section attrs">
<h3>Attributes</h3>
<ul class="index-list attrs">
<li class="index-item attr">
<a href="#attr_allowBrowserAutocomplete">allowBrowserAutocomplete</a>
</li>
<li class="index-item attr">
<a href="#attr_allowTrailingDelimiter">allowTrailingDelimiter</a>
</li>
<li class="index-item attr">
<a href="#attr_enableCache">enableCache</a>
</li>
<li class="index-item attr">
<a href="#attr_inputNode">inputNode</a>
</li>
<li class="index-item attr">
<a href="#attr_maxResults">maxResults</a>
</li>
<li class="index-item attr">
<a href="#attr_minQueryLength">minQueryLength</a>
</li>
<li class="index-item attr">
<a href="#attr_query">query</a>
</li>
<li class="index-item attr">
<a href="#attr_queryDelay">queryDelay</a>
</li>
<li class="index-item attr">
<a href="#attr_queryDelimiter">queryDelimiter</a>
</li>
<li class="index-item attr">
<a href="#attr_requestTemplate">requestTemplate</a>
</li>
<li class="index-item attr">
<a href="#attr_resultFilters">resultFilters</a>
</li>
<li class="index-item attr">
<a href="#attr_resultFormatter">resultFormatter</a>
</li>
<li class="index-item attr">
<a href="#attr_resultHighlighter">resultHighlighter</a>
</li>
<li class="index-item attr">
<a href="#attr_resultListLocator">resultListLocator</a>
</li>
<li class="index-item attr">
<a href="#attr_results">results</a>
</li>
<li class="index-item attr">
<a href="#attr_resultTextLocator">resultTextLocator</a>
</li>
<li class="index-item attr">
<a href="#attr_source">source</a>
</li>
<li class="index-item attr">
<a href="#attr_sourceType">sourceType</a>
</li>
<li class="index-item attr">
<a href="#attr_tokenInput">tokenInput</a>
</li>
<li class="index-item attr">
<a href="#attr_value">value</a>
</li>
<li class="index-item attr">
<a href="#attr_yqlEnv">yqlEnv</a>
</li>
<li class="index-item attr">
<a href="#attr_yqlProtocol">yqlProtocol</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_clear">clear</a>
</li>
<li class="index-item event">
<a href="#event_query">query</a>
</li>
<li class="index-item event">
<a href="#event_results">results</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method__afterSourceTypeChange" class="method item protected">
<h3 class="name"><code>_afterSourceTypeChange</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>e</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l789"><code>autocomplete/js/autocomplete-base.js:789</code></a>
</p>
</div>
<div class="description">
<p>Updates the current <code>source</code> based on the new <code>sourceType</code> to ensure that
the two attributes don't get out of sync when they're changed separately.</p>
</div>
<div class="params">
<h4>Parameters:</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">
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterValueChange" class="method item protected">
<h3 class="name"><code>_afterValueChange</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>e</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l803"><code>autocomplete/js/autocomplete-base.js:803</code></a>
</p>
</div>
<div class="description">
<p>Handles change events for the <code>value</code> attribute.</p>
</div>
<div class="params">
<h4>Parameters:</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">
</div>
</li>
</ul>
</div>
</div>
<div id="method__beforeCreateObjectSource" class="method item protected">
<h3 class="name"><code>_beforeCreateObjectSource</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/autocomplete-sources.html">autocomplete-sources</a> module.</p>
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-sources.js.html#l29"><code>autocomplete/js/autocomplete-sources.js:29</code></a>
</p>
</div>
<div class="description">
<p>Runs before AutoCompleteBase's <code>_createObjectSource()</code> method and augments
it to support additional object-based source types.</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/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method__bindUIACBase" class="method item protected">
<h3 class="name"><code>_bindUIACBase</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l242"><code>autocomplete/js/autocomplete-base.js:242</code></a>
</p>
</div>
<div class="description">
<p>Attaches event listeners and behaviors.</p>
</div>
</div>
<div id="method__createArraySource" class="method item protected">
<h3 class="name"><code>_createArraySource</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</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 protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l291"><code>autocomplete/js/autocomplete-base.js:291</code></a>
</p>
</div>
<div class="description">
<p>Creates a DataSource-like object that simply returns the specified array as
a response. See the <code>source</code> attribute for more details.</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/Array" class="crosslink external" target="_blank">Array</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>:
DataSource-like object.
</div>
</div>
</div>
<div id="method__createFunctionSource" class="method item protected">
<h3 class="name"><code>_createFunctionSource</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</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 protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l311"><code>autocomplete/js/autocomplete-base.js:311</code></a>
</p>
</div>
<div class="description">
<p>Creates a DataSource-like object that passes the query to a custom-defined
function, which is expected to call the provided callback with an array of
results. See the <code>source</code> attribute for more details.</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>Function that accepts a query and a callback as
parameters, and calls the callback with an array of results.</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>:
DataSource-like object.
</div>
</div>
</div>
<div id="method__createIOSource" class="method item protected">
<h3 class="name"><code>_createIOSource</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</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 protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/autocomplete-sources.html">autocomplete-sources</a> module.</p>
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-sources.js.html#l57"><code>autocomplete/js/autocomplete-sources.js:57</code></a>
</p>
</div>
<div class="description">
<p>Creates a DataSource-like object that uses <code>Y.io</code> as a source. See the
<code>source</code> attribute for more details.</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/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>URL.</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>:
DataSource-like object.
</div>
</div>
</div>
<div id="method__createJSONPSource" class="method item protected">
<h3 class="name"><code>_createJSONPSource</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</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 protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/autocomplete-sources.html">autocomplete-sources</a> module.</p>
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-sources.js.html#l130"><code>autocomplete/js/autocomplete-sources.js:130</code></a>
</p>
</div>
<div class="description">
<p>Creates a DataSource-like object that uses the specified JSONPRequest
instance as a source. See the <code>source</code> attribute for more details.</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="../classes/JSONPRequest.html" class="crosslink">JSONPRequest</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>URL string or JSONPRequest instance.</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>:
DataSource-like object.
</div>
</div>
</div>
<div id="method__createObjectSource" class="method item protected">
<h3 class="name"><code>_createObjectSource</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</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 protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l343"><code>autocomplete/js/autocomplete-base.js:343</code></a>
</p>
</div>
<div class="description">
<p>Creates a DataSource-like object that looks up queries as properties on the
specified object, and returns the found value (if any) as a response. See
the <code>source</code> attribute for more details.</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/Object" class="crosslink external" target="_blank">Object</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>:
DataSource-like object.
</div>
</div>
</div>
<div id="method__createSelectSource" class="method item protected">
<h3 class="name"><code>_createSelectSource</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</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 protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/autocomplete-sources.html">autocomplete-sources</a> module.</p>
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-sources.js.html#l199"><code>autocomplete/js/autocomplete-sources.js:199</code></a>
</p>
</div>
<div class="description">
<p>Creates a DataSource-like object that uses the specified <code><select></code> node as
a source.</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="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>YUI Node instance wrapping a <code><select></code> node.</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>:
DataSource-like object.
</div>
</div>
</div>
<div id="method__createStringSource" class="method item protected">
<h3 class="name"><code>_createStringSource</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</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 protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/autocomplete-sources.html">autocomplete-sources</a> module.</p>
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-sources.js.html#l233"><code>autocomplete/js/autocomplete-sources.js:233</code></a>
</p>
</div>
<div class="description">
<p>Creates a DataSource-like object that calls the specified URL or executes
the specified YQL query for results. If the string starts with "select ",
"use ", or "set " (case-insensitive), it's assumed to be a YQL query;
otherwise, it's assumed to be a URL (which may be absolute or relative).
URLs containing a "{callback}" placeholder are assumed to be JSONP URLs; all
others will use XHR. See the <code>source</code> attribute for more details.</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/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>URL or YQL query.</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>:
DataSource-like object.
</div>
</div>
</div>
<div id="method__createYQLSource" class="method item protected">
<h3 class="name"><code>_createYQLSource</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</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 protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/autocomplete-sources.html">autocomplete-sources</a> module.</p>
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-sources.js.html#l261"><code>autocomplete/js/autocomplete-sources.js:261</code></a>
</p>
</div>
<div class="description">
<p>Creates a DataSource-like object that uses the specified YQL query string to
create a YQL-based source. See the <code>source</code> attribute for details. If no
<code>resultListLocator</code> is defined, this method will set a best-guess locator
that might work for many typical YQL queries.</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/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>YQL query.</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>:
DataSource-like object.
</div>
</div>
</div>
<div id="method__defaultYQLLocator" class="method item protected">
<h3 class="name"><code>_defaultYQLLocator</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>response</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>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/autocomplete-sources.html">autocomplete-sources</a> module.</p>
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-sources.js.html#l348"><code>autocomplete/js/autocomplete-sources.js:348</code></a>
</p>
</div>
<div class="description">
<p>Default resultListLocator used when a string-based YQL source is set and the
implementer hasn't already specified one.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<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>YQL response object.</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>:
</div>
</div>
</div>
<div id="method__defClearFn" class="method item protected">
<h3 class="name"><code>_defClearFn</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l932"><code>autocomplete/js/autocomplete-base.js:932</code></a>
</p>
</div>
<div class="description">
<p>Default <code>clear</code> event handler. Sets the <code>results</code> attribute to an empty
array and <code>query</code> to null.</p>
</div>
</div>
<div id="method__defQueryFn" class="method item protected">
<h3 class="name"><code>_defQueryFn</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>e</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l944"><code>autocomplete/js/autocomplete-base.js:944</code></a>
</p>
</div>
<div class="description">
<p>Default <code>query</code> event handler. Sets the <code>query</code> attribute and sends a
request to the source if one is configured.</p>
</div>
<div class="params">
<h4>Parameters:</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">
</div>
</li>
</ul>
</div>
</div>
<div id="method__defResultsFn" class="method item protected">
<h3 class="name"><code>_defResultsFn</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>e</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l957"><code>autocomplete/js/autocomplete-base.js:957</code></a>
</p>
</div>
<div class="description">
<p>Default <code>results</code> event handler. Sets the <code>results</code> attribute to the latest
results.</p>
</div>
<div class="params">
<h4>Parameters:</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">
</div>
</li>
</ul>
</div>
</div>
<div id="method__functionValidator" class="method item protected">
<h3 class="name"><code>_functionValidator</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>value</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l369"><code>autocomplete/js/autocomplete-base.js:369</code></a>
</p>
</div>
<div class="description">
<p>Returns <code>true</code> if <em>value</em> is either a function or <code>null</code>.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">value</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | Null</span>
<div class="param-description">
<p>Value to validate.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__getObjectValue" class="method item protected">
<h3 class="name"><code>_getObjectValue</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>obj</code>
</li>
<li class="arg">
<code>path</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Any</span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l380"><code>autocomplete/js/autocomplete-base.js:380</code></a>
</p>
</div>
<div class="description">
<p>Faster and safer alternative to <code>Y.Object.getValue()</code>. Doesn't bother
casting the path to an array (since we already know it's an array) and
doesn't throw an error if a value in the middle of the object hierarchy is
neither <code>undefined</code> nor an object.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">obj</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">
</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/Array" class="crosslink external" target="_blank">Array</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Any</span>:
Located value, or <code>undefined</code> if the value was
not found at the specified path.
</div>
</div>
</div>
<div id="method__getXHRUrl" class="method item protected">
<h3 class="name"><code>_getXHRUrl</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>request</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 protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/autocomplete-sources.html">autocomplete-sources</a> module.</p>
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-sources.js.html#l380"><code>autocomplete/js/autocomplete-sources.js:380</code></a>
</p>
</div>
<div class="description">
<p>Returns a formatted XHR URL based on the specified base <em>url</em>, <em>query</em>, and
the current <em>requestTemplate</em> if any.</p>
</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>Base URL.</p>
</div>
</li>
<li class="param">
<code class="param-name">request</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>Request object containing <code>query</code> and <code>request</code>
properties.</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>:
Formatted URL.
</div>
</div>
</div>
<div id="method__jsonpFormatter" class="method item protected">
<h3 class="name"><code>_jsonpFormatter</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>proxy</code>
</li>
<li class="arg">
<code>query</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 protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/autocomplete-sources.html">autocomplete-sources</a> module.</p>
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-sources.js.html#l406"><code>autocomplete/js/autocomplete-sources.js:406</code></a>
</p>
</div>
<div class="description">
<p>URL formatter passed to <code>JSONPRequest</code> instances.</p>
</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">
</div>
</li>
<li class="param">
<code class="param-name">proxy</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">
</div>
</li>
<li class="param">
<code class="param-name">query</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">
</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>:
Formatted URL
</div>
</div>
</div>
<div id="method__onInputBlur" class="method item protected">
<h3 class="name"><code>_onInputBlur</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>e</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l860"><code>autocomplete/js/autocomplete-base.js:860</code></a>
</p>
</div>
<div class="description">
<p>Handles <code>blur</code> events on the input node.</p>
</div>
<div class="params">
<h4>Parameters:</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">
</div>
</li>
</ul>
</div>
</div>
<div id="method__onInputValueChange" class="method item protected">
<h3 class="name"><code>_onInputValueChange</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>e</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l898"><code>autocomplete/js/autocomplete-base.js:898</code></a>
</p>
</div>
<div class="description">
<p>Handles <code>valueChange</code> events on the input node and fires a <code>query</code> event
when the input value meets the configured criteria.</p>
</div>
<div class="params">
<h4>Parameters:</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">
</div>
</li>
</ul>
</div>
</div>
<div id="method__onResponse" class="method item protected">
<h3 class="name"><code>_onResponse</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>e</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l916"><code>autocomplete/js/autocomplete-base.js:916</code></a>
</p>
</div>
<div class="description">
<p>Handles source responses and fires the <code>results</code> event.</p>
</div>
<div class="params">
<h4>Parameters:</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">
</div>
</li>
</ul>
</div>
</div>
<div id="method__parseResponse" class="method item protected">
<h3 class="name"><code>_parseResponse</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>query</code>
</li>
<li class="arg">
<code>response</code>
</li>
<li class="arg">
<code>data</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l405"><code>autocomplete/js/autocomplete-base.js:405</code></a>
</p>
</div>
<div class="description">
<p>Parses result responses, performs filtering and highlighting, and fires the
<code>results</code> event.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">query</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>Query that generated these results.</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 containing results.</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>Raw response data.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__parseValue" class="method item protected">
<h3 class="name"><code>_parseValue</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>value</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> | Null</span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l536"><code>autocomplete/js/autocomplete-base.js:536</code></a>
</p>
</div>
<div class="description">
<p>Returns the query portion of the specified input value, or <code>null</code> if there
is no suitable query within the input value.</p>
<p>If a query delimiter is defined, the query will be the last delimited part
of of the string.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<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>Input value from which to extract the query.</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> | Null</span>:
query
</div>
</div>
</div>
<div id="method__setEnableCache" class="method item protected">
<h3 class="name"><code>_setEnableCache</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>value</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l559"><code>autocomplete/js/autocomplete-base.js:559</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Setter for the <code>enableCache</code> attribute.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">value</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">
</div>
</li>
</ul>
</div>
</div>
<div id="method__setLocator" class="method item protected">
<h3 class="name"><code>_setLocator</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>locator</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> | Null</span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l576"><code>autocomplete/js/autocomplete-base.js:576</code></a>
</p>
</div>
<div class="description">
<p>Setter for locator attributes.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">locator</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> | Null</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/Function" class="crosslink external" target="_blank">Function</a> | Null</span>:
</div>
</div>
</div>
<div id="method__setRequestTemplate" class="method item protected">
<h3 class="name"><code>_setRequestTemplate</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>template</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> | Null</span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l598"><code>autocomplete/js/autocomplete-base.js:598</code></a>
</p>
</div>
<div class="description">
<p>Setter for the <code>requestTemplate</code> attribute.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">template</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> | Null</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/Function" class="crosslink external" target="_blank">Function</a> | Null</span>:
</div>
</div>
</div>
<div id="method__setResultFilters" class="method item protected">
<h3 class="name"><code>_setResultFilters</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>filters</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 protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l618"><code>autocomplete/js/autocomplete-base.js:618</code></a>
</p>
</div>
<div class="description">
<p>Setter for the <code>resultFilters</code> attribute.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">filters</code>
<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/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> | Null</span>
<div class="param-description">
<p><code>null</code>, a filter
function, an array of filter functions, or a string or array of strings
representing the names of methods on <code>Y.AutoCompleteFilters</code>.</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>:
Array of filter functions (empty if filters is
<code>null</code>).
</div>
</div>
</div>
<div id="method__setResultHighlighter" class="method item protected">
<h3 class="name"><code>_setResultHighlighter</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>highlighter</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> | Null</span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l661"><code>autocomplete/js/autocomplete-base.js:661</code></a>
</p>
</div>
<div class="description">
<p>Setter for the <code>resultHighlighter</code> attribute.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">highlighter</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> | Null</span>
<div class="param-description">
<p><code>null</code>, a highlighter function, or
a string representing the name of a method on
<code>Y.AutoCompleteHighlighters</code>.</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> | Null</span>:
</div>
</div>
</div>
<div id="method__setSource" class="method item protected">
<h3 class="name"><code>_setSource</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>source</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">DataSource | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l688"><code>autocomplete/js/autocomplete-base.js:688</code></a>
</p>
</div>
<div class="description">
<p>Setter for the <code>source</code> attribute. Returns a DataSource or a DataSource-like
object depending on the type of <em>source</em> and/or the value of the
<code>sourceType</code> attribute.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">source</code>
<span class="type">Any</span>
<div class="param-description">
<p>AutoComplete source. See the <code>source</code> attribute for
details.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">DataSource | <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__sourceSuccess" class="method item protected">
<h3 class="name"><code>_sourceSuccess</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>request</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l723"><code>autocomplete/js/autocomplete-base.js:723</code></a>
</p>
</div>
<div class="description">
<p>Shared success callback for non-DataSource sources.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">data</code>
<span class="type">Any</span>
<div class="param-description">
<p>Response data.</p>
</div>
</li>
<li class="param">
<code class="param-name">request</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>Request object.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__syncBrowserAutocomplete" class="method item protected">
<h3 class="name"><code>_syncBrowserAutocomplete</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l738"><code>autocomplete/js/autocomplete-base.js:738</code></a>
</p>
</div>
<div class="description">
<p>Synchronizes the UI state of the <code>allowBrowserAutocomplete</code> attribute.</p>
</div>
</div>
<div id="method__syncUIACBase" class="method item protected">
<h3 class="name"><code>_syncUIACBase</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l278"><code>autocomplete/js/autocomplete-base.js:278</code></a>
</p>
</div>
<div class="description">
<p>Synchronizes the UI state of the <code>inputNode</code>.</p>
</div>
</div>
<div id="method__updateValue" class="method item protected">
<h3 class="name"><code>_updateValue</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>newVal</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l753"><code>autocomplete/js/autocomplete-base.js:753</code></a>
</p>
</div>
<div class="description">
<p>Updates the query portion of the <code>value</code> attribute.</p>
<p>If a query delimiter is defined, the last delimited portion of the input
value will be replaced with the specified <em>value</em>.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<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.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_clearCache" class="method item">
<h3 class="name"><code>clearCache</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l177"><code>autocomplete/js/autocomplete-base.js:177</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Clears the result cache.</p>
</div>
</div>
<div id="method_sendRequest" class="method item">
<h3 class="name"><code>sendRequest</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[query]</code>
</li>
<li class="arg">
<code class="optional">[requestTemplate]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l189"><code>autocomplete/js/autocomplete-base.js:189</code></a>
</p>
</div>
<div class="description">
<p>Sends a request to the configured source. If no source is configured, this
method won't do anything.</p>
<p>Usually there's no reason to call this method manually; it will be called
automatically when user input causes a <code>query</code> event to be fired. The only
time you'll need to call this method manually is if you want to force a
request to be sent when no user input has occurred.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[query]</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>Query to send. If specified, the <code>query</code> attribute
will be set to this query. If not specified, the current value of the
<code>query</code> attribute will be used.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[requestTemplate]</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>Request template function. If not
specified, the current value of the <code>requestTemplate</code> attribute will be
used.</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property__YQL_SOURCE_REGEX" class="property item protected">
<h3 class="name"><code>_YQL_SOURCE_REGEX</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/autocomplete-sources.html">autocomplete-sources</a> module.</p>
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-sources.js.html#l19"><code>autocomplete/js/autocomplete-sources.js:19</code></a>
</p>
</div>
<div class="description">
<p>Regular expression used to determine whether a String source is a YQL query.</p>
</div>
</div>
<div id="property_SOURCE_TYPES" class="property item">
<h3 class="name"><code>SOURCE_TYPES</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/autocomplete_js_autocomplete-base.js.html#l1525"><code>autocomplete/js/autocomplete-base.js:1525</code></a>
</p>
</div>
<div class="description">
<p>Mapping of built-in source types to their setter functions. DataSource instances
and DataSource-like objects are handled natively, so are not mapped here.</p>
</div>
</div>
</div>
<div id="attrs" class="api-class-tabpanel">
<h2 class="off-left">Attributes</h2>
<div id="attr_allowBrowserAutocomplete" class="attr item">
<a name="config_allowBrowserAutocomplete"></a>
<h3 class="name"><code>allowBrowserAutocomplete</code></h3>
<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="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l972"><code>autocomplete/js/autocomplete-base.js:972</code></a>
</p>
</div>
<div class="description">
<p>Whether or not to enable the browser's built-in autocomplete functionality
for input fields.</p>
</div>
<p><strong>Default:</strong> false</p>
<div class="emits box">
<h4>Fires event <code>allowBrowserAutocompleteChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>allowBrowserAutocomplete</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_allowTrailingDelimiter" class="attr item">
<a name="config_allowTrailingDelimiter"></a>
<h3 class="name"><code>allowTrailingDelimiter</code></h3>
<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="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l984"><code>autocomplete/js/autocomplete-base.js:984</code></a>
</p>
</div>
<div class="description">
<p>When a <code>queryDelimiter</code> is set, trailing delimiters will automatically be
stripped from the input value by default when the input node loses focus.
Set this to <code>true</code> to allow trailing delimiters.</p>
</div>
<p><strong>Default:</strong> false</p>
<div class="emits box">
<h4>Fires event <code>allowTrailingDelimiterChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>allowTrailingDelimiter</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_enableCache" class="attr item">
<a name="config_enableCache"></a>
<h3 class="name"><code>enableCache</code></h3>
<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="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l997"><code>autocomplete/js/autocomplete-base.js:997</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Whether or not to enable in-memory caching in result sources that support
it.</p>
</div>
<p><strong>Default:</strong> true</p>
<div class="emits box">
<h4>Fires event <code>enableCacheChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>enableCache</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_inputNode" class="attr item">
<a name="config_inputNode"></a>
<h3 class="name"><code>inputNode</code></h3>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a> | <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/autocomplete_js_autocomplete-base.js.html#l1012"><code>autocomplete/js/autocomplete-base.js:1012</code></a>
</p>
</div>
<div class="description">
<p>Node to monitor for changes, which will generate <code>query</code> events when
appropriate. May be either an <code><input></code> or a <code><textarea></code>.</p>
</div>
<div class="emits box">
<h4>Fires event <code>inputNodeChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>inputNode</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_maxResults" class="attr item">
<a name="config_maxResults"></a>
<h3 class="name"><code>maxResults</code></h3>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1025"><code>autocomplete/js/autocomplete-base.js:1025</code></a>
</p>
</div>
<div class="description">
<p>Maximum number of results to return. A value of <code>0</code> or less will allow an
unlimited number of results.</p>
</div>
<p><strong>Default:</strong> 0</p>
<div class="emits box">
<h4>Fires event <code>maxResultsChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>maxResults</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_minQueryLength" class="attr item">
<a name="config_minQueryLength"></a>
<h3 class="name"><code>minQueryLength</code></h3>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1037"><code>autocomplete/js/autocomplete-base.js:1037</code></a>
</p>
</div>
<div class="description">
<p>Minimum number of characters that must be entered before a <code>query</code> event
will be fired. A value of <code>0</code> allows empty queries; a negative value will
effectively disable all <code>query</code> events.</p>
</div>
<p><strong>Default:</strong> 1</p>
<div class="emits box">
<h4>Fires event <code>minQueryLengthChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>minQueryLength</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_query" class="attr item">
<a name="config_query"></a>
<h3 class="name"><code>query</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | Null</span>
<span class="flag readonly">readonly</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1050"><code>autocomplete/js/autocomplete-base.js:1050</code></a>
</p>
</div>
<div class="description">
<p>Current query, or <code>null</code> if there is no current query.</p>
<p>The query might not be the same as the current value of the input node, both
for timing reasons (due to <code>queryDelay</code>) and because when one or more
<code>queryDelimiter</code> separators are in use, only the last portion of the
delimited input string will be used as the query value.</p>
</div>
<p><strong>Default:</strong> null</p>
<div class="emits box">
<h4>Fires event <code>queryChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>query</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_queryDelay" class="attr item">
<a name="config_queryDelay"></a>
<h3 class="name"><code>queryDelay</code></h3>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1068"><code>autocomplete/js/autocomplete-base.js:1068</code></a>
</p>
</div>
<div class="description">
<p>Number of milliseconds to delay after input before triggering a <code>query</code>
event. If new input occurs before this delay is over, the previous input
event will be ignored and a new delay will begin.</p>
<p>This can be useful both to throttle queries to a remote data source and to
avoid distracting the user by showing them less relevant results before
they've paused their typing.</p>
</div>
<p><strong>Default:</strong> 100</p>
<div class="emits box">
<h4>Fires event <code>queryDelayChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>queryDelay</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_queryDelimiter" class="attr item">
<a name="config_queryDelimiter"></a>
<h3 class="name"><code>queryDelimiter</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | Null</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1085"><code>autocomplete/js/autocomplete-base.js:1085</code></a>
</p>
</div>
<div class="description">
<p>Query delimiter string. When a delimiter is configured, the input value
will be split on the delimiter, and only the last portion will be used in
autocomplete queries and updated when the <code>query</code> attribute is
modified.</p>
</div>
<p><strong>Default:</strong> null</p>
<div class="emits box">
<h4>Fires event <code>queryDelimiterChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>queryDelimiter</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_requestTemplate" class="attr item">
<a name="config_requestTemplate"></a>
<h3 class="name"><code>requestTemplate</code></h3>
<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> | Null</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1099"><code>autocomplete/js/autocomplete-base.js:1099</code></a>
</p>
</div>
<div class="description">
<p>Source request template. This can be a function that accepts a query as a
parameter and returns a request string, or it can be a string containing the
placeholder "{query}", which will be replaced with the actual URI-encoded
query. In either case, the resulting string will be appended to the request
URL when the <code>source</code> attribute is set to a remote DataSource, JSONP URL, or
XHR URL (it will not be appended to YQL URLs).</p>
<p>While <code>requestTemplate</code> may be set to either a function or a string, it will
always be returned as a function that accepts a query argument and returns a
string.</p>
</div>
<p><strong>Default:</strong> null</p>
<div class="emits box">
<h4>Fires event <code>requestTemplateChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>requestTemplate</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_resultFilters" class="attr item">
<a name="config_resultFilters"></a>
<h3 class="name"><code>resultFilters</code></h3>
<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="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1120"><code>autocomplete/js/autocomplete-base.js:1120</code></a>
</p>
</div>
<div class="description">
<p>Array of local result filter functions. If provided, each filter will be
called with two arguments when results are received: the query and an array
of result objects. See the documentation for the <code>results</code> event for a list
of the properties available on each result object.</p>
<p>Each filter is expected to return a filtered or modified version of the
results array, which will then be passed on to subsequent filters, then the
<code>resultHighlighter</code> function (if set), then the <code>resultFormatter</code> function
(if set), and finally to subscribers to the <code>results</code> event.</p>
<p>If no <code>source</code> is set, result filters will not be called.</p>
<p>Prepackaged result filters provided by the autocomplete-filters and
autocomplete-filters-accentfold modules can be used by specifying the filter
name as a string, such as <code>'phraseMatch'</code> (assuming the necessary filters
module is loaded).</p>
</div>
<p><strong>Default:</strong> []</p>
<div class="emits box">
<h4>Fires event <code>resultFiltersChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>resultFilters</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_resultFormatter" class="attr item">
<a name="config_resultFormatter"></a>
<h3 class="name"><code>resultFormatter</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | Null</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1147"><code>autocomplete/js/autocomplete-base.js:1147</code></a>
</p>
</div>
<div class="description">
<p>Function which will be used to format results. If provided, this function
will be called with two arguments after results have been received and
filtered: the query and an array of result objects. The formatter is
expected to return an array of HTML strings or Node instances containing the
desired HTML for each result.</p>
<p>See the documentation for the <code>results</code> event for a list of the properties
available on each result object.</p>
<p>If no <code>source</code> is set, the formatter will not be called.</p>
</div>
<div class="emits box">
<h4>Fires event <code>resultFormatterChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>resultFormatter</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_resultHighlighter" class="attr item">
<a name="config_resultHighlighter"></a>
<h3 class="name"><code>resultHighlighter</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | Null</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1167"><code>autocomplete/js/autocomplete-base.js:1167</code></a>
</p>
</div>
<div class="description">
<p>Function which will be used to highlight results. If provided, this function
will be called with two arguments after results have been received and
filtered: the query and an array of filtered result objects. The highlighter
is expected to return an array of highlighted result text in the form of
HTML strings.</p>
<p>See the documentation for the <code>results</code> event for a list of the properties
available on each result object.</p>
<p>If no <code>source</code> is set, the highlighter will not be called.</p>
</div>
<div class="emits box">
<h4>Fires event <code>resultHighlighterChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>resultHighlighter</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_resultListLocator" class="attr item">
<a name="config_resultListLocator"></a>
<h3 class="name"><code>resultListLocator</code></h3>
<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> | Null</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1187"><code>autocomplete/js/autocomplete-base.js:1187</code></a>
</p>
</div>
<div class="description">
<p>Locator that should be used to extract an array of results from a non-array
response.</p>
<p>By default, no locator is applied, and all responses are assumed to be
arrays by default. If all responses are already arrays, you don't need to
define a locator.</p>
<p>The locator may be either a function (which will receive the raw response as
an argument and must return an array) or a string representing an object
path, such as "foo.bar.baz" (which would return the value of
<code>result.foo.bar.baz</code> if the response is an object).</p>
<p>While <code>resultListLocator</code> may be set to either a function or a string, it
will always be returned as a function that accepts a response argument and
returns an array.</p>
</div>
<div class="emits box">
<h4>Fires event <code>resultListLocatorChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>resultListLocator</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_results" class="attr item">
<a name="config_results"></a>
<h3 class="name"><code>results</code></h3>
<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 readonly">readonly</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1212"><code>autocomplete/js/autocomplete-base.js:1212</code></a>
</p>
</div>
<div class="description">
<p>Current results, or an empty array if there are no results.</p>
</div>
<p><strong>Default:</strong> []</p>
<div class="emits box">
<h4>Fires event <code>resultsChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>results</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_resultTextLocator" class="attr item">
<a name="config_resultTextLocator"></a>
<h3 class="name"><code>resultTextLocator</code></h3>
<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> | Null</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1225"><code>autocomplete/js/autocomplete-base.js:1225</code></a>
</p>
</div>
<div class="description">
<p>Locator that should be used to extract a plain text string from a non-string
result item. The resulting text value will typically be the value that ends
up being inserted into an input field or textarea when the user of an
autocomplete implementation selects a result.</p>
<p>By default, no locator is applied, and all results are assumed to be plain
text strings. If all results are already plain text strings, you don't need
to define a locator.</p>
<p>The locator may be either a function (which will receive the raw result as
an argument and must return a string) or a string representing an object
path, such as "foo.bar.baz" (which would return the value of
<code>result.foo.bar.baz</code> if the result is an object).</p>
<p>While <code>resultTextLocator</code> may be set to either a function or a string, it
will always be returned as a function that accepts a result argument and
returns a string.</p>
</div>
<div class="emits box">
<h4>Fires event <code>resultTextLocatorChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>resultTextLocator</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_source" class="attr item">
<a name="config_source"></a>
<h3 class="name"><code>source</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | DataSource | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | Null</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1252"><code>autocomplete/js/autocomplete-base.js:1252</code></a>
</p>
</div>
<div class="description">
<p>Source for autocomplete results. The following source types are supported:</p>
<dl>
<dt>Array</dt>
<dd>
<p>
The full array will be provided to any configured filters for each
query. This is an easy way to create a fully client-side autocomplete
implementation.
</p>
<p>
Example: <code>['first result', 'second result', 'etc']</code>
</p>
</dd>
<dt>DataSource</dt>
<dd>
A <code>DataSource</code> instance or other object that provides a DataSource-like
<code>sendRequest</code> method. See the <code>DataSource</code> documentation for details.
</dd>
<dt>Function</dt>
<dd>
<p>
A function source will be called with the current query and a
callback function as parameters, and should either return an array of
results (for synchronous operation) or return nothing and pass an
array of results to the provided callback (for asynchronous
operation).
</p>
<p>
Example (synchronous):
</p>
<pre>
function (query) {
return ['foo', 'bar'];
}
</pre>
<p>
Example (async):
</p>
<pre>
function (query, callback) {
callback(['foo', 'bar']);
}
</pre>
</dd>
<dt>Object</dt>
<dd>
<p>
An object will be treated as a query hashmap. If a property on the
object matches the current query, the value of that property will be
used as the response.
</p>
<p>
The response is assumed to be an array of results by default. If the
response is not an array, provide a <code>resultListLocator</code> to
process the response and return an array.
</p>
<p>
Example: <code>{foo: ['foo result 1', 'foo result 2'], bar: ['bar result']}</code>
</p>
</dd>
</dl>
<p>If the optional <code>autocomplete-sources</code> module is loaded, then
the following additional source types will be supported as well:</p>
<dl>
<dt><select> Node</dt>
<dd>
You may provide a YUI Node instance wrapping a <select>
element, and the options in the list will be used as results. You
will also need to specify a <code>resultTextLocator</code> of 'text'
or 'value', depending on what you want to use as the text of the
result.
Each result will be an object with the following properties:
<dl>
<dt>html (String)</dt>
<dd>
<p>HTML content of the <option> element.</p>
</dd>
<dt>index (Number)</dt>
<dd>
<p>Index of the <option> element in the list.</p>
</dd>
<dt>node (Y.Node)</dt>
<dd>
<p>Node instance referring to the original <option> element.</p>
</dd>
<dt>selected (Boolean)</dt>
<dd>
<p>Whether or not this item is currently selected in the
<select> list.</p>
</dd>
<dt>text (String)</dt>
<dd>
<p>Text content of the <option> element.</p>
</dd>
<dt>value (String)</dt>
<dd>
<p>Value of the <option> element.</p>
</dd>
</dl>
</dd>
<dt>String (JSONP URL)</dt>
<dd>
<p>
If a URL with a <code>{callback}</code> placeholder is provided, it will be used to
make a JSONP request. The <code>{query}</code> placeholder will be replaced with
the current query, and the <code>{callback}</code> placeholder will be replaced
with an internally-generated JSONP callback name. Both placeholders must
appear in the URL, or the request will fail. An optional <code>{maxResults}</code>
placeholder may also be provided, and will be replaced with the value of
the maxResults attribute (or 1000 if the maxResults attribute is 0 or
less).
</p>
<p>
The response is assumed to be an array of results by default. If the
response is not an array, provide a <code>resultListLocator</code> to process the
response and return an array.
</p>
<p>
<strong>The <code>jsonp</code> module must be loaded in order for
JSONP URL sources to work.</strong> If the <code>jsonp</code> module
is not already loaded, it will be loaded on demand if possible.
</p>
<p>
Example: <code>'http://example.com/search?q={query}&callback={callback}'</code>
</p>
</dd>
<dt>String (XHR URL)</dt>
<dd>
<p>
If a URL without a <code>{callback}</code> placeholder is provided, it will be used
to make a same-origin XHR request. The <code>{query}</code> placeholder will be
replaced with the current query. An optional <code>{maxResults}</code> placeholder
may also be provided, and will be replaced with the value of the
maxResults attribute (or 1000 if the maxResults attribute is 0 or less).
</p>
<p>
The response is assumed to be a JSON array of results by default. If the
response is a JSON object and not an array, provide a
<code>resultListLocator</code> to process the response and return an array. If the
response is in some form other than JSON, you will need to use a custom
DataSource instance as the source.
</p>
<p>
<strong>The <code>io-base</code> and <code>json-parse</code> modules
must be loaded in order for XHR URL sources to work.</strong> If
these modules are not already loaded, they will be loaded on demand
if possible.
</p>
<p>
Example: <code>'http://example.com/search?q={query}'</code>
</p>
</dd>
<dt>String (YQL query)</dt>
<dd>
<p>
If a YQL query is provided, it will be used to make a YQL request. The
<code>{query}</code> placeholder will be replaced with the current autocomplete
query. This placeholder must appear in the YQL query, or the request
will fail. An optional <code>{maxResults}</code> placeholder may also be provided,
and will be replaced with the value of the maxResults attribute (or 1000
if the maxResults attribute is 0 or less).
</p>
<p>
<strong>The <code>yql</code> module must be loaded in order for YQL
sources to work.</strong> If the <code>yql</code> module is not
already loaded, it will be loaded on demand if possible.
</p>
<p>
Example: <code>'select * from search.suggest where query="{query}"'</code>
</p>
</dd>
</dl>
<p>As an alternative to providing a source, you could simply listen for <code>query</code>
events and handle them any way you see fit. Providing a source is optional,
but will usually be simpler.</p>
</div>
<div class="emits box">
<h4>Fires event <code>sourceChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>source</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_sourceType" class="attr item">
<a name="config_sourceType"></a>
<h3 class="name"><code>sourceType</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/autocomplete_js_autocomplete-base.js.html#l1469"><code>autocomplete/js/autocomplete-base.js:1469</code></a>
</p>
</div>
<div class="description">
<p>May be used to force a specific source type, overriding the automatic source
type detection. It should almost never be necessary to do this, but as they
taught us in the Boy Scouts, one should always be prepared, so it's here if
you need it. Be warned that if you set this attribute and something breaks,
it's your own fault.</p>
<p>Supported <code>sourceType</code> values are: 'array', 'datasource', 'function', and
'object'.</p>
<p>If the <code>autocomplete-sources</code> module is loaded, the following additional
source types are supported: 'io', 'jsonp', 'select', 'string', 'yql'</p>
</div>
<div class="emits box">
<h4>Fires event <code>sourceTypeChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>sourceType</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_tokenInput" class="attr item">
<a name="config_tokenInput"></a>
<h3 class="name"><code>tokenInput</code></h3>
<span class="type">Plugin.TokenInput</span>
<span class="flag readonly">readonly</span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l1489"><code>autocomplete/js/autocomplete-base.js:1489</code></a>
</p>
</div>
<div class="description">
<p>If the <code>inputNode</code> specified at instantiation time has a <code>node-tokeninput</code>
plugin attached to it, this attribute will be a reference to the
<code>Y.Plugin.TokenInput</code> instance.</p>
</div>
<div class="emits box">
<h4>Fires event <code>tokenInputChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>tokenInput</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_value" class="attr item">
<a name="config_value"></a>
<h3 class="name"><code>value</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/autocomplete_js_autocomplete-base.js.html#l1502"><code>autocomplete/js/autocomplete-base.js:1502</code></a>
</p>
</div>
<div class="description">
<p>Current value of the input node.</p>
</div>
<p><strong>Default:</strong> ''</p>
<div class="emits box">
<h4>Fires event <code>valueChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>value</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_yqlEnv" class="attr item">
<a name="config_yqlEnv"></a>
<h3 class="name"><code>yqlEnv</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>Provided by the <a href="../modules/autocomplete-sources.html">autocomplete-sources</a> module.</p>
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-sources.js.html#l435"><code>autocomplete/js/autocomplete-sources.js:435</code></a>
</p>
</div>
<div class="description">
<p>YQL environment file URL to load when the <code>source</code> is set to a YQL query.
Set this to <code>null</code> to use the default Open Data Tables environment file
(http://datatables.org/alltables.env).</p>
</div>
<p><strong>Default:</strong> null</p>
<div class="emits box">
<h4>Fires event <code>yqlEnvChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>yqlEnv</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div id="attr_yqlProtocol" class="attr item">
<a name="config_yqlProtocol"></a>
<h3 class="name"><code>yqlProtocol</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>Provided by the <a href="../modules/autocomplete-sources.html">autocomplete-sources</a> module.</p>
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-sources.js.html#l449"><code>autocomplete/js/autocomplete-sources.js:449</code></a>
</p>
</div>
<div class="description">
<p>URL protocol to use when the <code>source</code> is set to a YQL query.</p>
</div>
<p><strong>Default:</strong> 'http'</p>
<div class="emits box">
<h4>Fires event <code>yqlProtocolChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>yqlProtocol</code> is
changed. You can listen for the event using the <code>on</code> method if you
wish to be notified before the attribute's value has changed, or
using the <code>after</code> method if you wish to be notified after the
attribute's value has changed.
</p>
<div class="params">
<h4>Parameters:</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">
An Event Facade object with the following
attribute-specific properties added:
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">The value of the attribute, prior to it being set.</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">The value the attribute is to be set to.</div>
</li>
<li class="param">
<code class="param-name">attrName</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">The name of the attribute being set.</div>
</li>
<li class="param">
<code class="param-name">subAttrName</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">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="events" class="api-class-tabpanel">
<h2 class="off-left">Events</h2>
<div id="event_clear" class="events item">
<h3 class="name"><code>clear</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l103"><code>autocomplete/js/autocomplete-base.js:103</code></a>
</p>
</div>
<div class="description">
<p>Fires after the query has been completely cleared or no longer meets the
minimum query length requirement.</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>Value of the query before it was cleared.</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>Source of the event.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_query" class="events item">
<h3 class="name"><code>query</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l116"><code>autocomplete/js/autocomplete-base.js:116</code></a>
</p>
</div>
<div class="description">
<p>Fires when the contents of the input field have changed and the input
value meets the criteria necessary to generate an autocomplete query.</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">inputValue</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>Full contents of the text input field or
textarea that generated the query.</p>
</div>
</li>
<li class="param">
<code class="param-name">query</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>AutoComplete query. This is the string that will
be used to request completion results. It may or may not be the same
as <code>inputValue</code>.</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>Source of the event.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_results" class="events item">
<h3 class="name"><code>results</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/autocomplete_js_autocomplete-base.js.html#l133"><code>autocomplete/js/autocomplete-base.js:133</code></a>
</p>
</div>
<div class="description">
<p>Fires after query results are received from the source. If no source has
been set, this event will not fire.</p>
</div>
<div class="params">
<h4>Event Payload:</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/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>
<div class="param-description">
<p>Raw, unfiltered result data (if available).</p>
</div>
</li>
<li class="param">
<code class="param-name">query</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>Query that generated these results.</p>
</div>
</li>
<li class="param">
<code class="param-name">results</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 of filtered, formatted, and highlighted
results. Each item in the array is an object with the following
properties:</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">display</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</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>Formatted result
HTML suitable for display to the user. If no custom formatter is
set, this will be an HTML-escaped version of the string in the
<code>text</code> property.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[highlighted]</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>Highlighted (but not
formatted) result text. This property will only be set if a
highlighter is in use.</p>
</div>
</li>
<li class="param">
<code class="param-name">raw</code>
<span class="type">Any</span>
<div class="param-description">
<p>Raw, unformatted result in whatever form it
was provided by the source.</p>
</div>
</li>
<li class="param">
<code class="param-name">text</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>Plain text version of the result,
suitable for being inserted into the value of a text input field
or textarea when the result is selected by a user. This value is
not HTML-escaped and should not be inserted into the page using
<code>innerHTML</code> or <code>Node#setContent()</code>.</p>
</div>
</li>
</ul>
</li>
</ul>
</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>