<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>DataTable - 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>DataTable Class</h1>
<div class="box meta">
<div class="extends">
Extends <a href="../classes/DataTable.Base.html" class="crosslink">DataTable.Base</a>
</div>
<div class="foundat">
Defined in: <a href="../files/datatable_js_base.js.html#l16"><code>datatable/js/base.js:16</code></a>
</div>
Module: <a href="../modules/datatable-base.html">datatable-base</a><br>
Parent Module: <a href="../modules/datatable.html">datatable</a>
<p>Available since 3.5.0</p>
</div>
<div class="box intro">
<p>A Widget for displaying tabular data. Before feature modules are <code>use()</code>d,
this class is functionally equivalent to DataTable.Base. However, feature
modules can modify this class in non-destructive ways, expanding the API and
functionality.</p>
<p>This is the primary DataTable class. Out of the box, it provides the ability
to dynamically generate an HTML table from a set of column configurations and
row data. But feature module inclusion can add table sorting, pagintaion,
highlighting, selection, and more.</p>
<pre class="code prettyprint"><code>
// The functionality of this table would require additional modules be use()d,
// but the feature APIs are aggregated onto Y.DataTable.
// (Snippet is for illustration. Not all features are available today.)
var table = new Y.DataTable({
columns: [
{ type: 'checkbox', defaultChecked: true },
{ key: 'firstName', sortable: true, resizable: true },
{ key: 'lastName', sortable: true },
{ key: 'role', formatter: toRoleName }
],
data: {
source: 'http://myserver.com/service/json',
type: 'json',
schema: {
resultListLocator: 'results.users',
fields: [
'username',
'firstName',
'lastName',
{ key: 'role', type: 'number' }
]
}
},
recordType: UserModel,
pagedData: {
location: 'footer',
pageSizes: [20, 50, 'all'],
rowsPerPage: 20,
pageLinks: 5
},
editable: true
});
</code></pre>
<h3>Column Configuration</h3>
<p>The column configurations are set in the form of an array of objects, where
each object corresponds to a column. For columns populated directly from the
row data, a 'key' property is required to bind the column to that property or
attribute in the row data.</p>
<p>Not all columns need to relate to row data, nor do all properties or attributes
of the row data need to have a corresponding column. However, only those
columns included in the <code>columns</code> configuration attribute will be rendered.</p>
<p>Other column configuration properties are supported by the configured
<code>view</code>, class as well as any features added by plugins or class extensions.
See the description of DataTable.TableView and its subviews
DataTable.HeaderView, DataTable.BodyView, and DataTable.FooterView (and other
DataTable feature classes) to see what column properties they support.</p>
<p>Some examples of column configurations would be:</p>
<pre class="code prettyprint"><code>
// Basic
var columns = [{ key: 'firstName' }, { key: 'lastName' }, { key: 'age' }];
// For columns without any additional configuration, strings can be used
var columns = ['firstName', 'lastName', 'age'];
// Multi-row column headers (see DataTable.HeaderView for details)
var columns = [
{
label: 'Name',
children: [
{ key: 'firstName' },
{ key: 'lastName' }
]
},
'age' // mixing and matching objects and strings is ok
];
// Including columns that are not related 1:1 to row data fields/attributes
// (See DataTable.BodyView for details)
var columns = [
{
label: 'Name', // Needed for the column header
formatter: function (o) {
// Fill the column cells with data from firstName and lastName
if (o.data.age > 55) {
o.className += ' senior';
}
return o.data.lastName + ', ' + o.data.firstName;
}
},
'age'
];
// Columns that include feature configurations (for illustration; not all
// features are available today).
var columns = [
{ type: 'checkbox', defaultChecked: true },
{ key: 'firstName', sortable: true, resizable: true, min-width: '300px' },
{ key: 'lastName', sortable: true, resizable: true, min-width: '300px' },
{ key: 'age', emptyCellValue: '<em>unknown</em>' }
];
</code></pre>
<h3>Row Data Configuration</h3>
<p>The <code>data</code> configuration attribute is responsible for housing the data objects
that will be rendered as rows. You can provide this information in two ways by default:</p>
<ol>
<li>An array of simple objects with key:value pairs</li>
<li>A ModelList of Base-based class instances (presumably Model subclass
instances)</li>
</ol>
<p>If an array of objects is passed, it will be translated into a ModelList filled
with instances of the class provided to the <code>recordType</code> attribute. This
attribute can also create a custom Model subclass from an array of field names
or an object of attribute configurations. If no <code>recordType</code> is provided, one
will be created for you from available information (see <code>_initRecordType</code>).
Providing either your own ModelList instance for <code>data</code>, or at least Model
class for <code>recordType</code>, is the best way to control client-server
synchronization when modifying data on the client side.</p>
<p>The ModelList instance that manages the table's data is available in the <code>data</code>
property on the DataTable instance.</p>
<h3>Rendering</h3>
<p>Table rendering is a collaborative process between the DataTable and its
configured <code>view</code>. The DataTable creates an instance of the configured <code>view</code>
(DataTable.TableView by default), and calls its <code>render()</code> method.
DataTable.TableView, for instance, then creates the <code><table></code> and <code><caption></code>,
then delegates the rendering of the specific sections of the table to subviews,
which can be configured as <code>headerView</code>, <code>bodyView</code>, and <code>footerView</code>.
DataTable.TableView defaults the <code>headerView</code> to DataTable.HeaderView and the
<code>bodyView</code> to DataTable.BodyView, but leaves the <code>footerView</code> unassigned.
Setting any subview to <code>null</code> will result in that table section not being
rendered.</p>
</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 extends">
<li class="index-item method protected inherited">
<a href="#method_@renderUI">@renderUI</a>
</li>
<li class="index-item method private inherited">
<a href="#method__addAttrs">_addAttrs</a>
</li>
<li class="index-item method private inherited">
<a href="#method__addLazyAttr">_addLazyAttr</a>
</li>
<li class="index-item method protected">
<a href="#method__addScrollbarPadding">_addScrollbarPadding</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterChildSelectedChange">_afterChildSelectedChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterColumnsChange">_afterColumnsChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterDataChange">_afterDataChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterDisplayColumnsChange">_afterDisplayColumnsChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterMessageColumnsChange">_afterMessageColumnsChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterMessageDataChange">_afterMessageDataChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterRecordTypeChange">_afterRecordTypeChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterScrollableChange">_afterScrollableChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterScrollCaptionChange">_afterScrollCaptionChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterScrollColumnsChange">_afterScrollColumnsChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterScrollDataChange">_afterScrollDataChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterScrollHeightChange">_afterScrollHeightChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterScrollWidthChange">_afterScrollWidthChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterShowMessagesChange">_afterShowMessagesChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterSortByChange">_afterSortByChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterSortDataChange">_afterSortDataChange</a>
</li>
<li class="index-item method protected">
<a href="#method__afterSortRecordChange">_afterSortRecordChange</a>
</li>
<li class="index-item method private inherited">
<a href="#method__aggregateAttrs">_aggregateAttrs</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__applyParsedConfig">_applyParsedConfig</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__applyParser">_applyParser</a>
</li>
<li class="index-item method private inherited">
<a href="#method__attrCfgHash">_attrCfgHash</a>
</li>
<li class="index-item method private inherited">
<a href="#method__baseDestroy">_baseDestroy</a>
</li>
<li class="index-item method private inherited">
<a href="#method__baseInit">_baseInit</a>
</li>
<li class="index-item method private inherited">
<a href="#method__bindAttrUI">_bindAttrUI</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindDOM">_bindDOM</a>
</li>
<li class="index-item method protected">
<a href="#method__bindMessageUI">_bindMessageUI</a>
</li>
<li class="index-item method protected">
<a href="#method__bindScrollbar">_bindScrollbar</a>
</li>
<li class="index-item method protected">
<a href="#method__bindScrollResize">_bindScrollResize</a>
</li>
<li class="index-item method protected">
<a href="#method__bindScrollUI">_bindScrollUI</a>
</li>
<li class="index-item method protected">
<a href="#method__bindSortUI">_bindSortUI</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindUI">_bindUI</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindUIChild">_bindUIChild</a>
</li>
<li class="index-item method protected">
<a href="#method__clearScrollLock">_clearScrollLock</a>
</li>
<li class="index-item method private inherited">
<a href="#method__cloneDefaultValue">_cloneDefaultValue</a>
</li>
<li class="index-item method protected">
<a href="#method__createColumnGroup">_createColumnGroup</a>
</li>
<li class="index-item method protected">
<a href="#method__createRecordClass">_createRecordClass</a>
</li>
<li class="index-item method protected">
<a href="#method__createScrollbar">_createScrollbar</a>
</li>
<li class="index-item method protected">
<a href="#method__createScrollCaptionTable">_createScrollCaptionTable</a>
</li>
<li class="index-item method private inherited">
<a href="#method__createUIEvent">_createUIEvent</a>
</li>
<li class="index-item method protected">
<a href="#method__createXScrollNode">_createXScrollNode</a>
</li>
<li class="index-item method protected">
<a href="#method__createYScrollHeader">_createYScrollHeader</a>
</li>
<li class="index-item method protected">
<a href="#method__createYScrollNode">_createYScrollNode</a>
</li>
<li class="index-item method protected">
<a href="#method__defAddColumnFn">_defAddColumnFn</a>
</li>
<li class="index-item method private inherited">
<a href="#method__defAttrChangeFn">_defAttrChangeFn</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__defaultCB">_defaultCB</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__defDestroyFn">_defDestroyFn</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__defInitFn">_defInitFn</a>
</li>
<li class="index-item method protected">
<a href="#method__defModifyColumnFn">_defModifyColumnFn</a>
</li>
<li class="index-item method protected">
<a href="#method__defMoveColumnFn">_defMoveColumnFn</a>
</li>
<li class="index-item method protected">
<a href="#method__defRemoveColumnFn">_defRemoveColumnFn</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__defRenderFn">_defRenderFn</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__defRenderViewFn">_defRenderViewFn</a>
</li>
<li class="index-item method protected">
<a href="#method__defSortFn">_defSortFn</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__destroyBox">_destroyBox</a>
</li>
<li class="index-item method private inherited">
<a href="#method__destroyHierarchy">_destroyHierarchy</a>
</li>
<li class="index-item method private inherited">
<a href="#method__destroyUIEvents">_destroyUIEvents</a>
</li>
<li class="index-item method protected">
<a href="#method__disableScrolling">_disableScrolling</a>
</li>
<li class="index-item method protected">
<a href="#method__disableXScrolling">_disableXScrolling</a>
</li>
<li class="index-item method protected">
<a href="#method__disableYScrolling">_disableYScrolling</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__extractDisplayColumns">_extractDisplayColumns</a>
</li>
<li class="index-item method private inherited">
<a href="#method__filterAdHocAttrs">_filterAdHocAttrs</a>
</li>
<li class="index-item method private inherited">
<a href="#method__filterAttrCfgs">_filterAttrCfgs</a>
</li>
<li class="index-item method private inherited">
<a href="#method__filterUIEvent">_filterUIEvent</a>
</li>
<li class="index-item method private inherited">
<a href="#method__fireAttrChange">_fireAttrChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getAttr">_getAttr</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getAttrCfg">_getAttrCfg</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getAttrCfgs">_getAttrCfgs</a>
</li>
<li class="index-item method private inherited">
<a href="#method__getAttrInitVal">_getAttrInitVal</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getAttrs">_getAttrs</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getClasses">_getClasses</a>
</li>
<li class="index-item method protected">
<a href="#method__getColumns">_getColumns</a>
</li>
<li class="index-item method protected deprecated">
<a href="#method__getColumnset">_getColumnset</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item method private inherited">
<a href="#method__getFullType">_getFullType</a>
</li>
<li class="index-item method private inherited">
<a href="#method__getHtmlParser">_getHtmlParser</a>
</li>
<li class="index-item method private inherited">
<a href="#method__getNodeToParse">_getNodeToParse</a>
</li>
<li class="index-item method">
<a href="#method__getRecordType">_getRecordType</a>
</li>
<li class="index-item method protected">
<a href="#method__getSortBy">_getSortBy</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getSrcNode">_getSrcNode</a>
</li>
<li class="index-item method private inherited">
<a href="#method__getStateVal">_getStateVal</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getStrings">_getStrings</a>
</li>
<li class="index-item method private inherited">
<a href="#method__getType">_getType</a>
</li>
<li class="index-item method protected inherited inherited">
<a href="#method__getUIEventNode">_getUIEventNode</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__guid">_guid</a>
</li>
<li class="index-item method private inherited">
<a href="#method__initAttrHost">_initAttrHost</a>
</li>
<li class="index-item method private inherited inherited">
<a href="#method__initAttribute">_initAttribute</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__initAttrs">_initAttrs</a>
</li>
<li class="index-item method private inherited">
<a href="#method__initBase">_initBase</a>
</li>
<li class="index-item method protected">
<a href="#method__initColumns">_initColumns</a>
</li>
<li class="index-item method protected">
<a href="#method__initCoreEvents">_initCoreEvents</a>
</li>
<li class="index-item method protected">
<a href="#method__initData">_initData</a>
</li>
<li class="index-item method protected">
<a href="#method__initDataProperty">_initDataProperty</a>
</li>
<li class="index-item method private inherited">
<a href="#method__initHierarchy">_initHierarchy</a>
</li>
<li class="index-item method private inherited">
<a href="#method__initHierarchyData">_initHierarchyData</a>
</li>
<li class="index-item method protected">
<a href="#method__initMessageNode">_initMessageNode</a>
</li>
<li class="index-item method protected">
<a href="#method__initMessageStrings">_initMessageStrings</a>
</li>
<li class="index-item method protected">
<a href="#method__initSortFn">_initSortFn</a>
</li>
<li class="index-item method protected">
<a href="#method__initSortStrings">_initSortStrings</a>
</li>
<li class="index-item method private inherited">
<a href="#method__initUIEvent">_initUIEvent</a>
</li>
<li class="index-item method private inherited">
<a href="#method__isLazyAttr">_isLazyAttr</a>
</li>
<li class="index-item method private inherited">
<a href="#method__isUIEvent">_isUIEvent</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__mapInstance">_mapInstance</a>
</li>
<li class="index-item method private inherited">
<a href="#method__monitor">_monitor</a>
</li>
<li class="index-item method private inherited">
<a href="#method__normAttrVals">_normAttrVals</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__onDocFocus">_onDocFocus</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__onDocMouseDown">_onDocMouseDown</a>
</li>
<li class="index-item method protected">
<a href="#method__onUITriggerSort">_onUITriggerSort</a>
</li>
<li class="index-item method protected">
<a href="#method__parseSortable">_parseSortable</a>
</li>
<li class="index-item method private inherited">
<a href="#method__parseType">_parseType</a>
</li>
<li class="index-item method private inherited">
<a href="#method__preInitEventCfg">_preInitEventCfg</a>
</li>
<li class="index-item method protected deprecated inherited">
<a href="#method__protectAttrs">_protectAttrs</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item method private inherited">
<a href="#method__publish">_publish</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__relayCoreAttrChange">_relayCoreAttrChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__removeLoadingClassNames">_removeLoadingClassNames</a>
</li>
<li class="index-item method protected">
<a href="#method__removeScrollbar">_removeScrollbar</a>
</li>
<li class="index-item method protected">
<a href="#method__removeScrollCaptionTable">_removeScrollCaptionTable</a>
</li>
<li class="index-item method protected">
<a href="#method__removeXScrollNode">_removeXScrollNode</a>
</li>
<li class="index-item method protected">
<a href="#method__removeYScrollContainer">_removeYScrollContainer</a>
</li>
<li class="index-item method protected">
<a href="#method__removeYScrollHeader">_removeYScrollHeader</a>
</li>
<li class="index-item method protected">
<a href="#method__removeYScrollNode">_removeYScrollNode</a>
</li>
<li class="index-item method private inherited">
<a href="#method__renderBox">_renderBox</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__renderBoxClassNames">_renderBoxClassNames</a>
</li>
<li class="index-item method protected">
<a href="#method__renderSortable">_renderSortable</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__renderUI">_renderUI</a>
</li>
<li class="index-item method protected inherited inherited">
<a href="#method__set">_set</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__setAttr">_setAttr</a>
</li>
<li class="index-item method protected inherited inherited">
<a href="#method__setAttrs">_setAttrs</a>
</li>
<li class="index-item method private inherited">
<a href="#method__setAttrUI">_setAttrUI</a>
</li>
<li class="index-item method private inherited">
<a href="#method__setAttrVal">_setAttrVal</a>
</li>
<li class="index-item method private inherited">
<a href="#method__setBB">_setBB</a>
</li>
<li class="index-item method private inherited">
<a href="#method__setBox">_setBox</a>
</li>
<li class="index-item method private inherited">
<a href="#method__setCB">_setCB</a>
</li>
<li class="index-item method protected">
<a href="#method__setColumnMap">_setColumnMap</a>
</li>
<li class="index-item method protected">
<a href="#method__setColumns">_setColumns</a>
</li>
<li class="index-item method protected deprecated">
<a href="#method__setColumnset">_setColumnset</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item method protected">
<a href="#method__setColumnWidth">_setColumnWidth</a>
</li>
<li class="index-item method protected">
<a href="#method__setData">_setData</a>
</li>
<li class="index-item method protected deprecated">
<a href="#method__setRecordset">_setRecordset</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item method protected">
<a href="#method__setRecordType">_setRecordType</a>
</li>
<li class="index-item method protected">
<a href="#method__setScrollable">_setScrollable</a>
</li>
<li class="index-item method protected">
<a href="#method__setScrollProperties">_setScrollProperties</a>
</li>
<li class="index-item method protected">
<a href="#method__setSortBy">_setSortBy</a>
</li>
<li class="index-item method private inherited">
<a href="#method__setStateVal">_setStateVal</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__setStrings">_setStrings</a>
</li>
<li class="index-item method protected">
<a href="#method__sortComparator">_sortComparator</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__strSetter">_strSetter</a>
</li>
<li class="index-item method private inherited">
<a href="#method__syncAttrUI">_syncAttrUI</a>
</li>
<li class="index-item method protected">
<a href="#method__syncMessageUI">_syncMessageUI</a>
</li>
<li class="index-item method protected">
<a href="#method__syncScrollCaptionUI">_syncScrollCaptionUI</a>
</li>
<li class="index-item method protected">
<a href="#method__syncScrollColumnWidths">_syncScrollColumnWidths</a>
</li>
<li class="index-item method protected">
<a href="#method__syncScrollHeaders">_syncScrollHeaders</a>
</li>
<li class="index-item method protected">
<a href="#method__syncScrollPosition">_syncScrollPosition</a>
</li>
<li class="index-item method protected">
<a href="#method__syncScrollUI">_syncScrollUI</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__syncUI">_syncUI</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__syncUIChild">_syncUIChild</a>
</li>
<li class="index-item method protected">
<a href="#method__syncXScrollUI">_syncXScrollUI</a>
</li>
<li class="index-item method protected">
<a href="#method__syncYScrollUI">_syncYScrollUI</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetChildSelected">_uiSetChildSelected</a>
</li>
<li class="index-item method protected">
<a href="#method__uiSetColumnWidths">_uiSetColumnWidths</a>
</li>
<li class="index-item method private inherited">
<a href="#method__uiSetDim">_uiSetDim</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetDisabled">_uiSetDisabled</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetFocused">_uiSetFocused</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetHeight">_uiSetHeight</a>
</li>
<li class="index-item method protected">
<a href="#method__uiSetMessage">_uiSetMessage</a>
</li>
<li class="index-item method protected">
<a href="#method__uiSetScrollable">_uiSetScrollable</a>
</li>
<li class="index-item method protected">
<a href="#method__uiSetScrollbarHeight">_uiSetScrollbarHeight</a>
</li>
<li class="index-item method protected">
<a href="#method__uiSetScrollbarPosition">_uiSetScrollbarPosition</a>
</li>
<li class="index-item method protected">
<a href="#method__uiSetSortable">_uiSetSortable</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetTabIndex">_uiSetTabIndex</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetVisible">_uiSetVisible</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetWidth">_uiSetWidth</a>
</li>
<li class="index-item method protected">
<a href="#method__uiSetYScrollWidth">_uiSetYScrollWidth</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSizeCB">_uiSizeCB</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__unbindDOM">_unbindDOM</a>
</li>
<li class="index-item method protected">
<a href="#method__unbindScrollbar">_unbindScrollbar</a>
</li>
<li class="index-item method protected">
<a href="#method__unbindScrollResize">_unbindScrollResize</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__unbindUI">_unbindUI</a>
</li>
<li class="index-item method protected">
<a href="#method__validateSortable">_validateSortable</a>
</li>
<li class="index-item method protected">
<a href="#method__validateSortBy">_validateSortBy</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__validateView">_validateView</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__validTabIndex">_validTabIndex</a>
</li>
<li class="index-item method inherited">
<a href="#method_addAttr">addAttr</a>
</li>
<li class="index-item method inherited">
<a href="#method_addAttrs">addAttrs</a>
</li>
<li class="index-item method">
<a href="#method_addColumn">addColumn</a>
</li>
<li class="index-item method">
<a href="#method_addRow">addRow</a>
</li>
<li class="index-item method">
<a href="#method_addRows">addRows</a>
</li>
<li class="index-item method inherited">
<a href="#method_addTarget">addTarget</a>
</li>
<li class="index-item method inherited">
<a href="#method_after">after</a>
</li>
<li class="index-item method inherited">
<a href="#method_ancestor">ancestor</a>
</li>
<li class="index-item method inherited">
<a href="#method_attrAdded">attrAdded</a>
</li>
<li class="index-item method inherited">
<a href="#method_before">before</a>
</li>
<li class="index-item method protected inherited inherited">
<a href="#method_bindUI">bindUI</a>
</li>
<li class="index-item method inherited">
<a href="#method_blur">blur</a>
</li>
<li class="index-item method inherited">
<a href="#method_bubble">bubble</a>
</li>
<li class="index-item method inherited">
<a href="#method_delegate">delegate</a>
</li>
<li class="index-item method inherited inherited">
<a href="#method_destroy">destroy</a>
</li>
<li class="index-item method protected">
<a href="#method_destructor">destructor</a>
</li>
<li class="index-item method protected inherited">
<a href="#method_destructor">destructor</a>
</li>
<li class="index-item method inherited">
<a href="#method_detach">detach</a>
</li>
<li class="index-item method inherited">
<a href="#method_detachAll">detachAll</a>
</li>
<li class="index-item method inherited">
<a href="#method_disable">disable</a>
</li>
<li class="index-item method inherited">
<a href="#method_enable">enable</a>
</li>
<li class="index-item method inherited">
<a href="#method_fire">fire</a>
</li>
<li class="index-item method inherited">
<a href="#method_focus">focus</a>
</li>
<li class="index-item method inherited">
<a href="#method_get">get</a>
</li>
<li class="index-item method inherited">
<a href="#method_getAttrs">getAttrs</a>
</li>
<li class="index-item method inherited">
<a href="#method_getCell">getCell</a>
</li>
<li class="index-item method inherited inherited">
<a href="#method_getClassName">getClassName</a>
</li>
<li class="index-item method">
<a href="#method_getColumn">getColumn</a>
</li>
<li class="index-item method inherited">
<a href="#method_getDefaultLocale">getDefaultLocale</a>
</li>
<li class="index-item method inherited">
<a href="#method_getEvent">getEvent</a>
</li>
<li class="index-item method">
<a href="#method_getRecord">getRecord</a>
</li>
<li class="index-item method inherited">
<a href="#method_getRow">getRow</a>
</li>
<li class="index-item method inherited">
<a href="#method_getSkinName">getSkinName</a>
</li>
<li class="index-item method deprecated inherited inherited">
<a href="#method_getString">getString</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item method deprecated inherited inherited">
<a href="#method_getStrings">getStrings</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item method inherited">
<a href="#method_getTargets">getTargets</a>
</li>
<li class="index-item method inherited">
<a href="#method_hide">hide</a>
</li>
<li class="index-item method">
<a href="#method_hideMessage">hideMessage</a>
</li>
<li class="index-item method inherited inherited">
<a href="#method_init">init</a>
</li>
<li class="index-item method protected">
<a href="#method_initializer">initializer</a>
</li>
<li class="index-item method protected">
<a href="#method_initializer">initializer</a>
</li>
<li class="index-item method protected">
<a href="#method_initializer">initializer</a>
</li>
<li class="index-item method protected">
<a href="#method_initializer">initializer</a>
</li>
<li class="index-item method protected inherited">
<a href="#method_initializer">initializer</a>
</li>
<li class="index-item method protected">
<a href="#method_initializer">initializer</a>
</li>
<li class="index-item method inherited">
<a href="#method_isRoot">isRoot</a>
</li>
<li class="index-item method inherited">
<a href="#method_modifyAttr">modifyAttr</a>
</li>
<li class="index-item method">
<a href="#method_modifyColumn">modifyColumn</a>
</li>
<li class="index-item method">
<a href="#method_modifyRow">modifyRow</a>
</li>
<li class="index-item method">
<a href="#method_moveColumn">moveColumn</a>
</li>
<li class="index-item method inherited">
<a href="#method_next">next</a>
</li>
<li class="index-item method inherited">
<a href="#method_on">on</a>
</li>
<li class="index-item method inherited">
<a href="#method_once">once</a>
</li>
<li class="index-item method inherited">
<a href="#method_onceAfter">onceAfter</a>
</li>
<li class="index-item method inherited">
<a href="#method_parseType">parseType</a>
</li>
<li class="index-item method inherited">
<a href="#method_previous">previous</a>
</li>
<li class="index-item method inherited">
<a href="#method_publish">publish</a>
</li>
<li class="index-item method inherited">
<a href="#method_removeAttr">removeAttr</a>
</li>
<li class="index-item method">
<a href="#method_removeColumn">removeColumn</a>
</li>
<li class="index-item method">
<a href="#method_removeRow">removeRow</a>
</li>
<li class="index-item method inherited">
<a href="#method_removeTarget">removeTarget</a>
</li>
<li class="index-item method inherited">
<a href="#method_render">render</a>
</li>
<li class="index-item method protected inherited">
<a href="#method_renderer">renderer</a>
</li>
<li class="index-item method protected inherited">
<a href="#method_renderUI">renderUI</a>
</li>
<li class="index-item method inherited">
<a href="#method_reset">reset</a>
</li>
<li class="index-item method">
<a href="#method_scrollTo">scrollTo</a>
</li>
<li class="index-item method inherited inherited">
<a href="#method_set">set</a>
</li>
<li class="index-item method inherited inherited">
<a href="#method_setAttrs">setAttrs</a>
</li>
<li class="index-item method">
<a href="#method_setColumnWidth">setColumnWidth</a>
</li>
<li class="index-item method inherited">
<a href="#method_show">show</a>
</li>
<li class="index-item method">
<a href="#method_showMessage">showMessage</a>
</li>
<li class="index-item method">
<a href="#method_sort">sort</a>
</li>
<li class="index-item method deprecated inherited">
<a href="#method_subscribe">subscribe</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item method inherited inherited">
<a href="#method_syncUI">syncUI</a>
</li>
<li class="index-item method">
<a href="#method_toggleSort">toggleSort</a>
</li>
<li class="index-item method inherited inherited">
<a href="#method_toString">toString</a>
</li>
<li class="index-item method deprecated inherited">
<a href="#method_unsubscribe">unsubscribe</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item method deprecated inherited">
<a href="#method_unsubscribeAll">unsubscribeAll</a>
<span class="flag deprecated">deprecated</span>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property protected inherited">
<a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a>
</li>
<li class="index-item property protected">
<a href="#property__CAPTION_TABLE_TEMPLATE">_CAPTION_TABLE_TEMPLATE</a>
</li>
<li class="index-item property protected">
<a href="#property__columnMap">_columnMap</a>
</li>
<li class="index-item property inherited">
<a href="#property__displayColumns">_displayColumns</a>
</li>
<li class="index-item property">
<a href="#property__messageNode">_messageNode</a>
</li>
<li class="index-item property protected">
<a href="#property__SCROLL_LINER_TEMPLATE">_SCROLL_LINER_TEMPLATE</a>
</li>
<li class="index-item property protected">
<a href="#property__SCROLLBAR_TEMPLATE">_SCROLLBAR_TEMPLATE</a>
</li>
<li class="index-item property protected">
<a href="#property__sortable">_sortable</a>
</li>
<li class="index-item property protected">
<a href="#property__sortBy">_sortBy</a>
</li>
<li class="index-item property protected">
<a href="#property__tableNode">_tableNode</a>
</li>
<li class="index-item property private inherited">
<a href="#property__UI_ATTRS">_UI_ATTRS</a>
</li>
<li class="index-item property protected">
<a href="#property__X_SCROLLER_TEMPLATE">_X_SCROLLER_TEMPLATE</a>
</li>
<li class="index-item property private">
<a href="#property__xScroll">_xScroll</a>
</li>
<li class="index-item property protected">
<a href="#property__xScrollNode">_xScrollNode</a>
</li>
<li class="index-item property protected">
<a href="#property__Y_SCROLL_HEADER_TEMPLATE">_Y_SCROLL_HEADER_TEMPLATE</a>
</li>
<li class="index-item property protected">
<a href="#property__Y_SCROLLER_TEMPLATE">_Y_SCROLLER_TEMPLATE</a>
</li>
<li class="index-item property private">
<a href="#property__yScroll">_yScroll</a>
</li>
<li class="index-item property protected">
<a href="#property__yScrollHeader">_yScrollHeader</a>
</li>
<li class="index-item property protected">
<a href="#property__yScrollNode">_yScrollNode</a>
</li>
<li class="index-item property inherited">
<a href="#property_BOUNDING_TEMPLATE">BOUNDING_TEMPLATE</a>
</li>
<li class="index-item property">
<a href="#property_COL_TEMPLATE">COL_TEMPLATE</a>
</li>
<li class="index-item property">
<a href="#property_COLGROUP_TEMPLATE">COLGROUP_TEMPLATE</a>
</li>
<li class="index-item property inherited">
<a href="#property_CONTENT_TEMPLATE">CONTENT_TEMPLATE</a>
</li>
<li class="index-item property">
<a href="#property_data">data</a>
</li>
<li class="index-item property inherited">
<a href="#property_DEF_PARENT_NODE">DEF_PARENT_NODE</a>
</li>
<li class="index-item property inherited">
<a href="#property_DEF_UNIT">DEF_UNIT</a>
</li>
<li class="index-item property">
<a href="#property_MESSAGE_TEMPLATE">MESSAGE_TEMPLATE</a>
</li>
<li class="index-item property deprecated inherited">
<a href="#property_name">name</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item property">
<a href="#property_SORTABLE_HEADER_TEMPLATE">SORTABLE_HEADER_TEMPLATE</a>
</li>
<li class="index-item property inherited">
<a href="#property_UI_EVENTS">UI_EVENTS</a>
</li>
</ul>
</div>
<div class="index-section attrs">
<h3>Attributes</h3>
<ul class="index-list attrs extends">
<li class="index-item attr">
<a href="#attr_autoSync">autoSync</a>
</li>
<li class="index-item attr protected inherited">
<a href="#attr_bodyConfig">bodyConfig</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_bodyView">bodyView</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_boundingBox">boundingBox</a>
</li>
<li class="index-item attr">
<a href="#attr_caption">caption</a>
</li>
<li class="index-item attr">
<a href="#attr_columns">columns</a>
</li>
<li class="index-item attr deprecated">
<a href="#attr_columnset">columnset</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_contentBox">contentBox</a>
</li>
<li class="index-item attr">
<a href="#attr_data">data</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_destroyed">destroyed</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_disabled">disabled</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_focused">focused</a>
</li>
<li class="index-item attr protected inherited">
<a href="#attr_footerConfig">footerConfig</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_footerView">footerView</a>
</li>
<li class="index-item attr protected inherited">
<a href="#attr_headerConfig">headerConfig</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_headerView">headerView</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_height">height</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_id">id</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_initialized">initialized</a>
</li>
<li class="index-item attr deprecated inherited">
<a href="#attr_locale">locale</a>
</li>
<li class="index-item attr deprecated">
<a href="#attr_recordset">recordset</a>
</li>
<li class="index-item attr">
<a href="#attr_recordType">recordType</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_render">render</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_rendered">rendered</a>
</li>
<li class="index-item attr">
<a href="#attr_scrollable">scrollable</a>
</li>
<li class="index-item attr">
<a href="#attr_showMessages">showMessages</a>
</li>
<li class="index-item attr">
<a href="#attr_sortable">sortable</a>
</li>
<li class="index-item attr">
<a href="#attr_sortBy">sortBy</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_srcNode">srcNode</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_strings">strings</a>
</li>
<li class="index-item attr">
<a href="#attr_summary">summary</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_tabIndex">tabIndex</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_view">view</a>
</li>
<li class="index-item attr protected inherited">
<a href="#attr_viewConfig">viewConfig</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_visible">visible</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_width">width</a>
</li>
</ul>
</div>
<div class="index-section events">
<h3>Events</h3>
<ul class="index-list events extends">
<li class="index-item event">
<a href="#event_addColumn">addColumn</a>
</li>
<li class="index-item event inherited">
<a href="#event_destroy">destroy</a>
</li>
<li class="index-item event inherited">
<a href="#event_init">init</a>
</li>
<li class="index-item event">
<a href="#event_modifyColumn">modifyColumn</a>
</li>
<li class="index-item event">
<a href="#event_moveColumn">moveColumn</a>
</li>
<li class="index-item event">
<a href="#event_removeColumn">removeColumn</a>
</li>
<li class="index-item event inherited">
<a href="#event_render">render</a>
</li>
<li class="index-item event">
<a href="#event_sort">sort</a>
</li>
<li class="index-item event inherited">
<a href="#event_widget:contentUpdate">widget:contentUpdate</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_@renderUI" class="method item protected inherited">
<h3 class="name"><code>@renderUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#method_@renderUI">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l425"><code>datatable/js/base.js:425</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Instantiates the configured <code>view</code> class that will be responsible for
setting up the View class.</p>
</div>
</div>
<div id="method__addAttrs" class="method item private inherited">
<h3 class="name"><code>_addAttrs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cfgs</code>
</li>
<li class="arg">
<code>values</code>
</li>
<li class="arg">
<code>lazy</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__addAttrs">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l836"><code>attribute/js/AttributeCore.js:836</code></a>
</p>
</div>
<div class="description">
<p>Implementation behind the public addAttrs method.</p>
<p>This method is invoked directly by get if it encounters a scenario
in which an attribute's valueFn attempts to obtain the
value an attribute in the same group of attributes, which has not yet
been added (on demand initialization).</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cfgs</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>An object with attribute name/configuration pairs.</p>
</div>
</li>
<li class="param">
<code class="param-name">values</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>An object with attribute name/value pairs, defining the initial values to apply.
Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>
</div>
</li>
<li class="param">
<code class="param-name">lazy</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>Whether or not to delay the intialization of these attributes until the first call to get/set.
Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.
See <a href="#method_addAttr">addAttr</a>.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__addLazyAttr" class="method item private inherited">
<h3 class="name"><code>_addLazyAttr</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code class="optional">[lazyCfg]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__addLazyAttr">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l382"><code>attribute/js/AttributeCore.js:382</code></a>
</p>
</div>
<div class="description">
<p>Finishes initializing an attribute which has been lazily added.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The name of the attribute</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[lazyCfg]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Optional config hash for the attribute. This is added for performance
along the critical path, where the calling method has already obtained lazy config from state.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__addScrollbarPadding" class="method item protected">
<h3 class="name"><code>_addScrollbarPadding</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l193"><code>datatable/js/scroll.js:193</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Adds padding to the last cells in the fixed header for vertically scrolling
tables. This padding is equal in width to the scrollbar, so can't be
relegated to a stylesheet.</p>
</div>
</div>
<div id="method__afterChildSelectedChange" class="method item protected inherited">
<h3 class="name"><code>_afterChildSelectedChange</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>event</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__afterChildSelectedChange">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l327"><code>widget-child/js/Widget-Child.js:327</code></a>
</p>
</div>
<div class="description">
<p>Default attribute change listener for the <code>selected</code>
attribute, responsible for updating the UI, in response to
attribute changes.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event</code>
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
<div class="param-description">
<p>The event facade for the attribute change.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterColumnsChange" class="method item protected">
<h3 class="name"><code>_afterColumnsChange</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>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l333"><code>datatable/js/core.js:333</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Updates the <code>_columnMap</code> property in response to changes in the <code>columns</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">
<p>The <code>columnsChange</code> event object</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterDataChange" class="method item protected">
<h3 class="name"><code>_afterDataChange</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>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l346"><code>datatable/js/core.js:346</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Updates the <code>modelList</code> attributes of the rendered views in response to the
<code>data</code> attribute being assigned a new ModelList.</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">
<p>the <code>dataChange</code> event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterDisplayColumnsChange" class="method item protected inherited">
<h3 class="name"><code>_afterDisplayColumnsChange</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>Inherited from
<a href="../classes/DataTable.Base.html#method__afterDisplayColumnsChange">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l305"><code>datatable/js/base.js:305</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Updates the <code>_displayColumns</code> property.</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">
<p>The <code>columnsChange</code> event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterMessageColumnsChange" class="method item protected">
<h3 class="name"><code>_afterMessageColumnsChange</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>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l110"><code>datatable/js/message.js:110</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Updates the colspan of the <code><td></code> used to display the messages.</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">
<p>The columnsChange event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterMessageDataChange" class="method item protected">
<h3 class="name"><code>_afterMessageDataChange</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>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l133"><code>datatable/js/message.js:133</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Relays to <code>_uiSetMessage</code> to hide or show the message 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">
<p>The dataChange event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterRecordTypeChange" class="method item protected">
<h3 class="name"><code>_afterRecordTypeChange</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>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l367"><code>datatable/js/core.js:367</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Assigns to the new recordType as the model for the data ModelList</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">
<p>recordTypeChange event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterScrollableChange" class="method item protected">
<h3 class="name"><code>_afterScrollableChange</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>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l218"><code>datatable/js/scroll.js:218</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Reacts to changes in the <code>scrollable</code> attribute by updating the <code>_xScroll</code>
and <code>_yScroll</code> properties and syncing the scrolling structure accordingly.</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">
<p>The relevant change event (ignored)</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterScrollCaptionChange" class="method item protected">
<h3 class="name"><code>_afterScrollCaptionChange</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>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l242"><code>datatable/js/scroll.js:242</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Reacts to changes in the <code>caption</code> attribute by adding, removing, or
syncing the caption table when the table is set to scroll.</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">
<p>The relevant change event (ignored)</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterScrollColumnsChange" class="method item protected">
<h3 class="name"><code>_afterScrollColumnsChange</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>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l257"><code>datatable/js/scroll.js:257</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Reacts to changes in the <code>columns</code> attribute of vertically scrolling tables
by refreshing the fixed headers, scroll container, and virtual scrollbar
position.</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">
<p>The relevant change event (ignored)</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterScrollDataChange" class="method item protected">
<h3 class="name"><code>_afterScrollDataChange</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>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l277"><code>datatable/js/scroll.js:277</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Reacts to changes in vertically scrolling table's <code>data</code> ModelList by
synchronizing the fixed column header widths and virtual scrollbar height.</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">
<p>The relevant change event (ignored)</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterScrollHeightChange" class="method item protected">
<h3 class="name"><code>_afterScrollHeightChange</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>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l292"><code>datatable/js/scroll.js:292</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Reacts to changes in the <code>height</code> attribute of vertically scrolling tables
by updating the height of the <code><div></code> wrapping the data table and the
virtual scrollbar. If <code>scrollable</code> was set to "y" or "xy" but lacking a
declared <code>height</code> until the received change, <code>_syncScrollUI</code> is called to
create the fixed headers etc.</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">
<p>The relevant change event (ignored)</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterScrollWidthChange" class="method item protected">
<h3 class="name"><code>_afterScrollWidthChange</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>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l331"><code>datatable/js/scroll.js:331</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Reacts to changes in the width of scrolling tables by expanding the width of
the <code><div></code> wrapping the data table for horizontally scrolling tables or
upding the position of the virtual scrollbar for vertically scrolling
tables.</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">
<p>The relevant change event (ignored)</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterShowMessagesChange" class="method item protected">
<h3 class="name"><code>_afterShowMessagesChange</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>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l145"><code>datatable/js/message.js:145</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes the message node if <code>showMessages</code> is <code>false</code>, or relays to
<code>_uiSetMessage</code> if <code>true</code>.</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">
<p>The showMessagesChange event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterSortByChange" class="method item protected">
<h3 class="name"><code>_afterSortByChange</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>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l288"><code>datatable/js/sort.js:288</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Sorts the <code>data</code> ModelList based on the new <code>sortBy</code> configuration.</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">
<p>The <code>sortByChange</code> event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterSortDataChange" class="method item protected">
<h3 class="name"><code>_afterSortDataChange</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>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l313"><code>datatable/js/sort.js:313</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Applies the sorting logic to the new ModelList if the <code>newVal</code> is a new
ModelList.</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">
<p>the <code>dataChange</code> event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterSortRecordChange" class="method item protected">
<h3 class="name"><code>_afterSortRecordChange</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>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l332"><code>datatable/js/sort.js:332</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Checks if any of the fields in the modified record are fields that are
currently being sorted by, and if so, resorts the <code>data</code> ModelList.</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">
<p>The Model's <code>change</code> event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__aggregateAttrs" class="method item private inherited">
<h3 class="name"><code>_aggregateAttrs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>allAttrs</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#method__aggregateAttrs">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l575"><code>base/js/BaseCore.js:575</code></a>
</p>
</div>
<div class="description">
<p>A helper method, used by _initHierarchyData to aggregate
attribute configuration across the instances class hierarchy.</p>
<p>The method will protect the attribute configuration value to protect the statically defined
default value in ATTRS if required (if the value is an object literal, array or the
attribute configuration has cloneDefaultValue set to shallow or deep).</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">allAttrs</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
<div class="param-description">
<p>An array of ATTRS definitions across classes in the hierarchy
(subclass first, Base last)</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
The aggregate set of ATTRS definitions for the instance
</div>
</div>
</div>
<div id="method__applyParsedConfig" class="method item protected inherited">
<h3 class="name"><code>_applyParsedConfig</code></h3>
<span class="paren">()</span>
<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>Inherited from
<a href="../classes/Widget.html#method__applyParsedConfig">Widget</a>:
<a href="../files/widget_js_WidgetHTMLParser.js.html#l83"><code>widget/js/WidgetHTMLParser.js:83</code></a>
</p>
</div>
<div class="description">
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
The merged configuration literal
</div>
</div>
</div>
<div id="method__applyParser" class="method item protected inherited">
<h3 class="name"><code>_applyParser</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__applyParser">Widget</a>:
<a href="../files/widget_js_WidgetHTMLParser.js.html#l92"><code>widget/js/WidgetHTMLParser.js:92</code></a>
</p>
</div>
<div class="description">
<p>Utility method used to apply the <code>HTML_PARSER</code> configuration for the
instance, to retrieve config data values.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>User configuration object (will be populated with values from Node)</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__attrCfgHash" class="method item private inherited">
<h3 class="name"><code>_attrCfgHash</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#method__attrCfgHash">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l538"><code>base/js/BaseCore.js:538</code></a>
</p>
</div>
<div class="description">
<p>Utility method to define the attribute hash used to filter/whitelist property mixes for
this class for iteration performance reasons.</p>
</div>
</div>
<div id="method__baseDestroy" class="method item private inherited">
<h3 class="name"><code>_baseDestroy</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#method__baseDestroy">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l309"><code>base/js/BaseCore.js:309</code></a>
</p>
</div>
<div class="description">
<p>Internal destroy implementation for BaseCore</p>
</div>
</div>
<div id="method__baseInit" class="method item private inherited">
<h3 class="name"><code>_baseInit</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#method__baseInit">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l281"><code>base/js/BaseCore.js:281</code></a>
</p>
</div>
<div class="description">
<p>Internal initialization implementation for BaseCore</p>
</div>
</div>
<div id="method__bindAttrUI" class="method item private inherited">
<h3 class="name"><code>_bindAttrUI</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attrs</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__bindAttrUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1170"><code>widget/js/Widget.js:1170</code></a>
</p>
</div>
<div class="description">
<p>Binds after listeners for the list of attributes provided</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">attrs</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>
<div id="method__bindDOM" class="method item protected inherited">
<h3 class="name"><code>_bindDOM</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__bindDOM">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l902"><code>widget/js/Widget.js:902</code></a>
</p>
</div>
<div class="description">
<p>Sets up DOM listeners, on elements rendered by the widget.</p>
</div>
</div>
<div id="method__bindMessageUI" class="method item protected">
<h3 class="name"><code>_bindMessageUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l166"><code>datatable/js/message.js:166</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Binds the events necessary to keep the message node in sync with the current
table and configuration state.</p>
</div>
</div>
<div id="method__bindScrollbar" class="method item protected">
<h3 class="name"><code>_bindScrollbar</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l348"><code>datatable/js/scroll.js:348</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Binds virtual scrollbar interaction to the <code>_yScrollNode</code>'s <code>scrollTop</code> and
vice versa.</p>
</div>
</div>
<div id="method__bindScrollResize" class="method item protected">
<h3 class="name"><code>_bindScrollResize</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l368"><code>datatable/js/scroll.js:368</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Binds to the window resize event to update the vertical scrolling table
headers and wrapper <code><div></code> dimensions.</p>
</div>
</div>
<div id="method__bindScrollUI" class="method item protected">
<h3 class="name"><code>_bindScrollUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l385"><code>datatable/js/scroll.js:385</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Attaches internal subscriptions to keep the scrolling structure up to date
with changes in the table's <code>data</code>, <code>columns</code>, <code>caption</code>, or <code>height</code>. The
<code>width</code> is taken care of already.</p>
<p>This executes after the table's native <code>bindUI</code> method.</p>
</div>
</div>
<div id="method__bindSortUI" class="method item protected">
<h3 class="name"><code>_bindSortUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l352"><code>datatable/js/sort.js:352</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Subscribes to state changes that warrant updating the UI, and adds the
click handler for triggering the sort operation from the UI.</p>
</div>
</div>
<div id="method__bindUI" class="method item protected inherited">
<h3 class="name"><code>_bindUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__bindUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l883"><code>widget/js/Widget.js:883</code></a>
</p>
</div>
<div class="description">
<p>Sets up DOM and CustomEvent listeners for the widget.</p>
</div>
</div>
<div id="method__bindUIChild" class="method item protected inherited">
<h3 class="name"><code>_bindUIChild</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__bindUIChild">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l356"><code>widget-child/js/Widget-Child.js:356</code></a>
</p>
</div>
<div class="description">
<p>Binds event listeners responsible for updating the UI state in response
to WidgetChild related state changes.</p>
<p>
This method is invoked after bindUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__clearScrollLock" class="method item protected">
<h3 class="name"><code>_clearScrollLock</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l413"><code>datatable/js/scroll.js:413</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Clears the lock and timer used to manage synchronizing the scroll position
between the vertical scroll container and the virtual scrollbar.</p>
</div>
</div>
<div id="method__cloneDefaultValue" class="method item private inherited">
<h3 class="name"><code>_cloneDefaultValue</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cfg</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#method__cloneDefaultValue">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l549"><code>base/js/BaseCore.js:549</code></a>
</p>
</div>
<div class="description">
<p>This method assumes that the value has already been checked to be an object.
Since it's on a critical path, we don't want to re-do the check.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cfg</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method__createColumnGroup" class="method item protected">
<h3 class="name"><code>_createColumnGroup</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-column-widths.html">datatable-column-widths</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_colwidths.js.html#l175"><code>datatable/js/colwidths.js:175</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Renders the table's <code><colgroup></code> and populates the <code>_colgroupNode</code> property.</p>
</div>
</div>
<div id="method__createRecordClass" class="method item protected">
<h3 class="name"><code>_createRecordClass</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attrs</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l391"><code>datatable/js/core.js:391</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Creates a Model subclass from an array of attribute names or an object of
attribute definitions. This is used to generate a class suitable to
represent the data passed to the <code>data</code> attribute if no <code>recordType</code> is
set.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">attrs</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Names assigned to the Model subclass's
<code>ATTRS</code> or its entire <code>ATTRS</code> definition object</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>:
</div>
</div>
</div>
<div id="method__createScrollbar" class="method item protected">
<h3 class="name"><code>_createScrollbar</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l428"><code>datatable/js/scroll.js:428</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Creates a virtual scrollbar from the <code>_SCROLLBAR_TEMPLATE</code>, assigning it to
the <code>_scrollbarNode</code> property.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
The created Node
</div>
</div>
</div>
<div id="method__createScrollCaptionTable" class="method item protected">
<h3 class="name"><code>_createScrollCaptionTable</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l454"><code>datatable/js/scroll.js:454</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Creates a separate table to contain the caption when the table is
configured to scroll vertically or horizontally.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
The created Node
</div>
</div>
</div>
<div id="method__createUIEvent" class="method item private inherited">
<h3 class="name"><code>_createUIEvent</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__createUIEvent">Widget</a>:
<a href="../files/widget_js_WidgetUIEvents.js.html#l73"><code>widget/js/WidgetUIEvents.js:73</code></a>
</p>
</div>
<div class="description">
<p>Binds a delegated DOM event listener of the specified type to the
Widget's outtermost DOM element to facilitate the firing of a Custom
Event of the same type for the Widget instance.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>String representing the name of the event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__createXScrollNode" class="method item protected">
<h3 class="name"><code>_createXScrollNode</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l476"><code>datatable/js/scroll.js:476</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Populates the <code>_xScrollNode</code> property by creating the <code><div></code> Node described
by the <code>_X_SCROLLER_TEMPLATE</code>.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
The created Node
</div>
</div>
</div>
<div id="method__createYScrollHeader" class="method item protected">
<h3 class="name"><code>_createYScrollHeader</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l496"><code>datatable/js/scroll.js:496</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Populates the <code>_yScrollHeader</code> property by creating the <code><table></code> Node
described by the <code>_Y_SCROLL_HEADER_TEMPLATE</code>.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
The created Node
</div>
</div>
</div>
<div id="method__createYScrollNode" class="method item protected">
<h3 class="name"><code>_createYScrollNode</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l518"><code>datatable/js/scroll.js:518</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Populates the <code>_yScrollNode</code> property by creating the <code><div></code> Node described
by the <code>_Y_SCROLLER_TEMPLATE</code>.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
The created Node
</div>
</div>
</div>
<div id="method__defAddColumnFn" class="method item protected">
<h3 class="name"><code>_defAddColumnFn</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>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l394"><code>datatable/js/mutable.js:394</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Default function for the <code>addColumn</code> event.</p>
<p>Inserts the specified column at the provided index.</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">
<p>The <code>addColumn</code> event</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">column</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The new column definition object</p>
</div>
</li>
<li class="param">
<code class="param-name">index</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span>
<div class="param-description">
<p>The array index to insert the new column</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="method__defAttrChangeFn" class="method item private inherited">
<h3 class="name"><code>_defAttrChangeFn</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeObservable.html#method__defAttrChangeFn">AttributeObservable</a>:
<a href="../files/attribute_js_AttributeObservable.js.html#l186"><code>attribute/js/AttributeObservable.js:186</code></a>
</p>
</div>
<div class="description">
<p>Default function for attribute change events.</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">
<p>The event object for attribute change events.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__defaultCB" class="method item protected inherited">
<h3 class="name"><code>_defaultCB</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__defaultCB">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l780"><code>widget/js/Widget.js:780</code></a>
</p>
</div>
<div class="description">
<p>Returns the default value for the contentBox attribute.</p>
<p>For the Widget class, this will be the srcNode if provided, otherwise null (resulting in
a new contentBox node instance being created)</p>
</div>
</div>
<div id="method__defDestroyFn" class="method item protected inherited">
<h3 class="name"><code>_defDestroyFn</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>Inherited from
<a href="../classes/BaseObservable.html#method__defDestroyFn">BaseObservable</a>:
<a href="../files/base_js_BaseObservable.js.html#l190"><code>base/js/BaseObservable.js:190</code></a>
</p>
</div>
<div class="description">
<p>Default destroy event handler</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">
<p>Event object</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__defInitFn" class="method item protected inherited">
<h3 class="name"><code>_defInitFn</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>Inherited from
<a href="../classes/BaseObservable.html#method__defInitFn">BaseObservable</a>:
<a href="../files/base_js_BaseObservable.js.html#l178"><code>base/js/BaseObservable.js:178</code></a>
</p>
</div>
<div class="description">
<p>Default init event handler</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">
<p>Event object, with a cfg property which
refers to the configuration object passed to the constructor.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__defModifyColumnFn" class="method item protected">
<h3 class="name"><code>_defModifyColumnFn</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>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l424"><code>datatable/js/mutable.js:424</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Default function for the <code>modifyColumn</code> event.</p>
<p>Mixes the new column properties into the specified column definition.</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">
<p>The <code>modifyColumn</code> event</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">column</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span>
<div class="param-description">
<p>The column definition object or identifier</p>
</div>
</li>
<li class="param">
<code class="param-name">newColumnDef</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The properties to assign to the column</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="method__defMoveColumnFn" class="method item protected">
<h3 class="name"><code>_defMoveColumnFn</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>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l448"><code>datatable/js/mutable.js:448</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Default function for the <code>moveColumn</code> event.</p>
<p>Removes the specified column from its current location and inserts it at the
specified array index (may be an array of indexes for nested headers).</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">
<p>The <code>moveColumn</code> event</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">column</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span>
<div class="param-description">
<p>The column definition object or identifier</p>
</div>
</li>
<li class="param">
<code class="param-name">index</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The destination index to move to</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="method__defRemoveColumnFn" class="method item protected">
<h3 class="name"><code>_defRemoveColumnFn</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>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l501"><code>datatable/js/mutable.js:501</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Default function for the <code>removeColumn</code> event.</p>
<p>Splices the specified column from its containing columns array.</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">
<p>The <code>removeColumn</code> event</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">column</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span>
<div class="param-description">
<p>The column definition object or identifier</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="method__defRenderFn" class="method item protected inherited">
<h3 class="name"><code>_defRenderFn</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>e</code>
</li>
<li class="arg">
<code>parentNode</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__defRenderFn">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l571"><code>widget/js/Widget.js:571</code></a>
</p>
</div>
<div class="description">
<p>Default render handler</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">
<p>The Event object</p>
</div>
</li>
<li class="param">
<code class="param-name">parentNode</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The parent node to render to, if passed in to the <code>render</code> method</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__defRenderViewFn" class="method item protected inherited">
<h3 class="name"><code>_defRenderViewFn</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>Inherited from
<a href="../classes/DataTable.Base.html#method__defRenderViewFn">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l336"><code>datatable/js/base.js:336</code></a>
</p>
</div>
<div class="description">
<p>The default behavior of the <code>renderView</code> event. Calls <code>render()</code> on the
<code>View</code> instance on the 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">
<p>The <code>renderView</code> event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__defSortFn" class="method item protected">
<h3 class="name"><code>_defSortFn</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>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l376"><code>datatable/js/sort.js:376</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Sets the <code>sortBy</code> attribute from the <code>sort</code> event's <code>e.sortBy</code> value.</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">
<p>The <code>sort</code> event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__destroyBox" class="method item protected inherited">
<h3 class="name"><code>_destroyBox</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__destroyBox">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l476"><code>widget/js/Widget.js:476</code></a>
</p>
</div>
<div class="description">
<p>Removes and destroys the widgets rendered boundingBox, contentBox,
and detaches bound UI events.</p>
</div>
</div>
<div id="method__destroyHierarchy" class="method item private inherited">
<h3 class="name"><code>_destroyHierarchy</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#method__destroyHierarchy">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l721"><code>base/js/BaseCore.js:721</code></a>
</p>
</div>
<div class="description">
<p>Destroys the class hierarchy for this instance by invoking
the destructor method on the prototype of each class in the hierarchy.</p>
</div>
</div>
<div id="method__destroyUIEvents" class="method item private inherited">
<h3 class="name"><code>_destroyUIEvents</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__destroyUIEvents">Widget</a>:
<a href="../files/widget_js_WidgetUIEvents.js.html#l20"><code>widget/js/WidgetUIEvents.js:20</code></a>
</p>
</div>
<div class="description">
<p>Destructor logic for UI event infrastructure,
invoked during Widget destruction.</p>
</div>
</div>
<div id="method__disableScrolling" class="method item protected">
<h3 class="name"><code>_disableScrolling</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l546"><code>datatable/js/scroll.js:546</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes the nodes used to create horizontal and vertical scrolling and
rejoins the caption to the main table if needed.</p>
</div>
</div>
<div id="method__disableXScrolling" class="method item protected">
<h3 class="name"><code>_disableXScrolling</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l563"><code>datatable/js/scroll.js:563</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes the nodes used to allow horizontal scrolling.</p>
</div>
</div>
<div id="method__disableYScrolling" class="method item protected">
<h3 class="name"><code>_disableYScrolling</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l574"><code>datatable/js/scroll.js:574</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes the nodes used to allow vertical scrolling.</p>
</div>
</div>
<div id="method__extractDisplayColumns" class="method item protected inherited">
<h3 class="name"><code>_extractDisplayColumns</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>columns</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#method__extractDisplayColumns">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l348"><code>datatable/js/base.js:348</code></a>
</p>
</div>
<div class="description">
<p>Processes the full column array, distilling the columns down to those that
correspond to cell data columns.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">columns</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
<div class="param-description">
<p>The full set of table columns</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__filterAdHocAttrs" class="method item private inherited">
<h3 class="name"><code>_filterAdHocAttrs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>allAttrs</code>
</li>
<li class="arg">
<code>userVals</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#method__filterAdHocAttrs">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l427"><code>base/js/BaseCore.js:427</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">allAttrs</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The set of all attribute configurations for this instance.
Attributes will be removed from this set, if they belong to the filtered class, so
that by the time all classes are processed, allCfgs will be empty.</p>
</div>
</li>
<li class="param">
<code class="param-name">userVals</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The config object passed in by the user, from which adhoc attrs are to be filtered.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
The set of adhoc attributes passed in, in the form
of an object with attribute name/configuration pairs.
</div>
</div>
</div>
<div id="method__filterAttrCfgs" class="method item private inherited">
<h3 class="name"><code>_filterAttrCfgs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>clazz</code>
</li>
<li class="arg">
<code>allCfgs</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#method__filterAttrCfgs">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l356"><code>base/js/BaseCore.js:356</code></a>
</p>
</div>
<div class="description">
<p>A helper method used when processing ATTRS across the class hierarchy during
initialization. Returns a disposable object with the attributes defined for
the provided class, extracted from the set of all attributes passed in.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">clazz</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>The class for which the desired attributes are required.</p>
</div>
</li>
<li class="param">
<code class="param-name">allCfgs</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The set of all attribute configurations for this instance.
Attributes will be removed from this set, if they belong to the filtered class, so
that by the time all classes are processed, allCfgs will be empty.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
The set of attributes belonging to the class passed in, in the form
of an object with attribute name/configuration pairs.
</div>
</div>
</div>
<div id="method__filterUIEvent" class="method item private inherited">
<h3 class="name"><code>_filterUIEvent</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>evt</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__filterUIEvent">Widget</a>:
<a href="../files/widget_js_WidgetUIEvents.js.html#l117"><code>widget/js/WidgetUIEvents.js:117</code></a>
</p>
</div>
<div class="description">
<p>This method is used to determine if we should fire
the UI Event or not. The default implementation makes sure
that for nested delegates (nested unrelated widgets), we don't
fire the UI event listener more than once at each level.</p>
<p>For example, without the additional filter, if you have nested
widgets, each widget will have a delegate listener. If you
click on the inner widget, the inner delegate listener's
filter will match once, but the outer will match twice
(based on delegate's design) - once for the inner widget,
and once for the outer.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">evt</code>
<span class="type"><a href="../classes/DOMEventFacade.html" class="crosslink">DOMEventFacade</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/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
true if it's OK to fire the custom UI event, false if not.
</div>
</div>
</div>
<div id="method__fireAttrChange" class="method item private inherited">
<h3 class="name"><code>_fireAttrChange</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attrName</code>
</li>
<li class="arg">
<code>subAttrName</code>
</li>
<li class="arg">
<code>currVal</code>
</li>
<li class="arg">
<code>newVal</code>
</li>
<li class="arg">
<code>opts</code>
</li>
<li class="arg">
<code class="optional">[cfg]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeObservable.html#method__fireAttrChange">AttributeObservable</a>:
<a href="../files/attribute_js_AttributeObservable.js.html#l120"><code>attribute/js/AttributeObservable.js:120</code></a>
</p>
</div>
<div class="description">
<p>Utility method to help setup the event payload and fire the attribute change event.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<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">
<p>The name of the attribute</p>
</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">
<p>The full path of the property being changed,
if this is a sub-attribute value being change. Otherwise null.</p>
</div>
</li>
<li class="param">
<code class="param-name">currVal</code>
<span class="type">Any</span>
<div class="param-description">
<p>The current value of the attribute</p>
</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">
<p>The new value of the attribute</p>
</div>
</li>
<li class="param">
<code class="param-name">opts</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Any additional event data to mix into the attribute change event's event facade.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[cfg]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The attribute config stored in State, if already available.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__getAttr" class="method item protected inherited">
<h3 class="name"><code>_getAttr</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Any</span>
</span>
<span class="flag protected">protected</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__getAttr">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l543"><code>attribute/js/AttributeCore.js:543</code></a>
</p>
</div>
<div class="description">
<p>Provides the common implementation for the public get method,
allowing Attribute hosts to over-ride either method.</p>
<p>See <a href="#method_get">get</a> for argument details.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Any</span>:
The value of the attribute.
</div>
</div>
</div>
<div id="method__getAttrCfg" class="method item protected inherited">
<h3 class="name"><code>_getAttrCfg</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</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>Inherited from
<a href="../classes/AttributeExtras.html#method__getAttrCfg">AttributeExtras</a>:
<a href="../files/attribute_js_AttributeExtras.js.html#l114"><code>attribute/js/AttributeExtras.js:114</code></a>
</p>
</div>
<div class="description">
<p>Returns an object with the configuration properties (and value)
for the given attribute. If attrName is not provided, returns the
configuration properties for all attributes.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>Optional. The attribute name. If not provided, the method will return the configuration for all attributes.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
The configuration properties for the given attribute, or all attributes.
</div>
</div>
</div>
<div id="method__getAttrCfgs" class="method item protected inherited">
<h3 class="name"><code>_getAttrCfgs</code></h3>
<span class="paren">()</span>
<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>Inherited from
<a href="../classes/BaseCore.html#method__getAttrCfgs">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l339"><code>base/js/BaseCore.js:339</code></a>
</p>
</div>
<div class="description">
<p>Returns an aggregated set of attribute configurations, by traversing
the class hierarchy.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
The hash of attribute configurations, aggregated across classes in the hierarchy
This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return
the cached value.
</div>
</div>
</div>
<div id="method__getAttrInitVal" class="method item private inherited">
<h3 class="name"><code>_getAttrInitVal</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attr</code>
</li>
<li class="arg">
<code>cfg</code>
</li>
<li class="arg">
<code>initValues</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Any</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__getAttrInitVal">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l945"><code>attribute/js/AttributeCore.js:945</code></a>
</p>
</div>
<div class="description">
<p>Returns the initial value of the given attribute from
either the default configuration provided, or the
over-ridden value if it exists in the set of initValues
provided and the attribute is not read-only.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">attr</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute</p>
</div>
</li>
<li class="param">
<code class="param-name">cfg</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The attribute configuration object</p>
</div>
</li>
<li class="param">
<code class="param-name">initValues</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The object with simple and complex attribute name/value pairs returned from _normAttrVals</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Any</span>:
The initial value of the attribute.
</div>
</div>
</div>
<div id="method__getAttrs" class="method item protected inherited">
<h3 class="name"><code>_getAttrs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attrs</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>Inherited from
<a href="../classes/AttributeCore.html#method__getAttrs">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l774"><code>attribute/js/AttributeCore.js:774</code></a>
</p>
</div>
<div class="description">
<p>Implementation behind the public getAttrs method, to get multiple attribute values.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">attrs</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span>
<div class="param-description">
<p>Optional. An array of attribute names. If omitted, all attribute values are
returned. If set to true, all attributes modified from their initial values are returned.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
An object with attribute name/value pairs.
</div>
</div>
</div>
<div id="method__getClasses" class="method item protected inherited">
<h3 class="name"><code>_getClasses</code></h3>
<span class="paren">()</span>
<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>Inherited from
<a href="../classes/BaseCore.html#method__getClasses">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l323"><code>base/js/BaseCore.js:323</code></a>
</p>
</div>
<div class="description">
<p>Returns the class hierarchy for this object, with BaseCore being the last class in the array.</p>
</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>:
An array of classes (constructor functions), making up the class hierarchy for this object.
This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the
cached value.
</div>
</div>
</div>
<div id="method__getColumns" class="method item protected">
<h3 class="name"><code>_getColumns</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>columns</code>
</li>
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l431"><code>datatable/js/core.js:431</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>The getter for the <code>columns</code> attribute. Returns the array of column
configuration objects if <code>instance.get('columns')</code> is called, or the
specific column object if <code>instance.get('columns.columnKey')</code> is called.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">columns</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
<div class="param-description">
<p>The full array of column objects</p>
</div>
</li>
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The attribute name requested
(e.g. 'columns' or 'columns.foo');</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__getColumnset" class="method item protected deprecated">
<h3 class="name"><code>_getColumnset</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>ignored</code>
</li>
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag deprecated" title="This will be removed with the `columnset` attribute in a future
version.">deprecated</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l450"><code>datatable/js/core.js:450</code></a>
</p>
<p>Deprecated: This will be removed with the `columnset` attribute in a future
version.</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Relays the <code>get()</code> request for the deprecated <code>columnset</code> attribute to the
<code>columns</code> attribute.</p>
<p>THIS BREAKS BACKWARD COMPATIBILITY. 3.4.1 and prior implementations will
expect a Columnset instance returned from <code>get('columnset')</code>.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">ignored</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The current value stored in the <code>columnset</code> state</p>
</div>
</li>
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The attribute name requested
(e.g. 'columnset' or 'columnset.foo');</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__getFullType" class="method item private inherited">
<h3 class="name"><code>_getFullType</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method__getFullType">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l586"><code>event-custom/js/event-target.js:586</code></a>
</p>
</div>
<div class="description">
<p>Returns the fully qualified type, given a short type string.
That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.</p>
<p>NOTE: This method, unlike _getType, does no checking of the value passed in, and
is designed to be used with the low level _publish() method, for critical path
implementations which need to fast-track publish for performance reasons.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The short type to prefix</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
The prefixed type, if a prefix is set, otherwise the type passed in
</div>
</div>
</div>
<div id="method__getHtmlParser" class="method item private inherited">
<h3 class="name"><code>_getHtmlParser</code></h3>
<span class="paren">()</span>
<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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__getHtmlParser">Widget</a>:
<a href="../files/widget_js_WidgetHTMLParser.js.html#l149"><code>widget/js/WidgetHTMLParser.js:149</code></a>
</p>
</div>
<div class="description">
<p>Gets the HTML<em>PARSER definition for this instance, by merging HTML</em>PARSER
definitions across the class hierarchy.</p>
</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>:
HTML_PARSER definition for this instance
</div>
</div>
</div>
<div id="method__getNodeToParse" class="method item private inherited">
<h3 class="name"><code>_getNodeToParse</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__getNodeToParse">Widget</a>:
<a href="../files/widget_js_WidgetHTMLParser.js.html#l134"><code>widget/js/WidgetHTMLParser.js:134</code></a>
</p>
</div>
<div class="description">
<p>Determines whether we have a node reference which we should try and parse.</p>
<p>The current implementation does not parse nodes generated from CONTENT_TEMPLATE,
only explicitly set srcNode, or contentBox attributes.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
The node reference to apply HTML_PARSER to.
</div>
</div>
</div>
<div id="method__getRecordType" class="method item">
<h3 class="name"><code>_getRecordType</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>
</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l470"><code>datatable/js/core.js:470</code></a>
</p>
</div>
<div class="description">
<p>Returns the Model class of the instance's <code>data</code> attribute ModelList. If
not set, returns the explicitly configured value.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>
<div class="param-description">
<p>The currently configured value</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>:
</div>
</div>
</div>
<div id="method__getSortBy" class="method item protected">
<h3 class="name"><code>_getSortBy</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
<li class="arg">
<code>detail</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l388"><code>datatable/js/sort.js:388</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Getter for the <code>sortBy</code> attribute.</p>
<p>Supports the special subattribute "sortBy.state" to get a normalized JSON
version of the current sort state. Otherwise, returns the last assigned
value.</p>
<p>For example:</p>
<pre class="code prettyprint"><code>var table = new Y.DataTable({
columns: [ ... ],
data: [ ... ],
sortBy: 'username'
});
table.get('sortBy'); // 'username'
table.get('sortBy.state'); // { key: 'username', dir: 1 }
table.sort(['lastName', { firstName: "desc" }]);
table.get('sortBy'); // ['lastName', { firstName: "desc" }]
table.get('sortBy.state'); // [{ key: "lastName", dir: 1 }, { key: "firstName", dir: -1 }]
</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
<div class="param-description">
<p>The current sortBy value</p>
</div>
</li>
<li class="param">
<code class="param-name">detail</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>String passed to <code>get(HERE)</code>. to parse subattributes</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__getSrcNode" class="method item protected inherited">
<h3 class="name"><code>_getSrcNode</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__getSrcNode">Widget</a>:
<a href="../files/widget_js_WidgetHTMLParser.js.html#l74"><code>widget/js/WidgetHTMLParser.js:74</code></a>
</p>
</div>
<div class="description">
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
The Node to apply HTML_PARSER to
</div>
</div>
</div>
<div id="method__getStateVal" class="method item private inherited">
<h3 class="name"><code>_getStateVal</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code class="optional">[cfg]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Any</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__getStateVal">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l600"><code>attribute/js/AttributeCore.js:600</code></a>
</p>
</div>
<div class="description">
<p>Gets the stored value for the attribute, from either the
internal state object, or the state proxy if it exits</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[cfg]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Optional config hash for the attribute. This is added for performance along the critical path,
where the calling method has already obtained the config from state.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Any</span>:
The stored value of the attribute
</div>
</div>
</div>
<div id="method__getStrings" class="method item protected inherited">
<h3 class="name"><code>_getStrings</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>locale</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__getStrings">Widget</a>:
<a href="../files/widget_js_WidgetLocale.js.html#l56"><code>widget/js/WidgetLocale.js:56</code></a>
</p>
</div>
<div class="description">
<p>Returns the strings key/value hash for a paricular locale, without locale lookup applied.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">locale</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>
<div id="method__getType" class="method item private inherited">
<h3 class="name"><code>_getType</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method__getType">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l36"><code>event-custom/js/event-target.js:36</code></a>
</p>
</div>
<div class="description">
<p>If the instance has a prefix attribute and the
event type is not prefixed, the instance prefix is
applied to the supplied type.</p>
</div>
</div>
<div id="method__getUIEventNode" class="method item protected inherited">
<h3 class="name"><code>_getUIEventNode</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__getUIEventNode">
Widget
</a>
but overwritten in
<a href="../files/widget-child_js_Widget-Child.js.html#l167"><code>widget-child/js/Widget-Child.js:167</code></a>
</p>
</div>
<div class="description">
<p>Returns the node on which to bind delegate listeners.</p>
<p>Override of Widget's implementation of _getUIEventNode() to ensure that
all event listeners are bound to the Widget's topmost DOM element.
This ensures that the firing of each type of Widget UI event (click,
mousedown, etc.) is facilitated by a single, top-level, delegated DOM
event listener.</p>
</div>
</div>
<div id="method__guid" class="method item protected inherited">
<h3 class="name"><code>_guid</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__guid">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1153"><code>widget/js/Widget.js:1153</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="method__initAttrHost" class="method item private inherited">
<h3 class="name"><code>_initAttrHost</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attrs</code>
</li>
<li class="arg">
<code>values</code>
</li>
<li class="arg">
<code>lazy</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__initAttrHost">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l140"><code>attribute/js/AttributeCore.js:140</code></a>
</p>
</div>
<div class="description">
<p>Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the
constructor.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">attrs</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>).
These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p>
</div>
</li>
<li class="param">
<code class="param-name">values</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>).
These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p>
</div>
</li>
<li class="param">
<code class="param-name">lazy</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__initAttribute" class="method item private inherited">
<h3 class="name"><code>_initAttribute</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseObservable.html#method__initAttribute">
BaseObservable
</a>
but overwritten in
<a href="../files/base_js_BaseCore.js.html#l254"><code>base/js/BaseCore.js:254</code></a>
</p>
</div>
<div class="description">
<p>Initializes AttributeCore</p>
</div>
</div>
<div id="method__initAttrs" class="method item protected inherited">
<h3 class="name"><code>_initAttrs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attrs</code>
</li>
<li class="arg">
<code>values</code>
</li>
<li class="arg">
<code>lazy</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__initAttrs">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l1011"><code>attribute/js/AttributeCore.js:1011</code></a>
</p>
</div>
<div class="description">
<p>Utility method to set up initial attributes defined during construction,
either through the constructor.ATTRS property, or explicitly passed in.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">attrs</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>).
These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p>
</div>
</li>
<li class="param">
<code class="param-name">values</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>).
These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p>
</div>
</li>
<li class="param">
<code class="param-name">lazy</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__initBase" class="method item private inherited">
<h3 class="name"><code>_initBase</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#method__initBase">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l219"><code>base/js/BaseCore.js:219</code></a>
</p>
</div>
<div class="description">
<p>Internal construction logic for BaseCore.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The constructor configuration object</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__initColumns" class="method item protected">
<h3 class="name"><code>_initColumns</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l488"><code>datatable/js/core.js:488</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Initializes the <code>_columnMap</code> property from the configured <code>columns</code>
attribute. If <code>columns</code> is not set, but there are records in the <code>data</code>
ModelList, use
<code>ATTRS</code> of that class.</p>
</div>
</div>
<div id="method__initCoreEvents" class="method item protected">
<h3 class="name"><code>_initCoreEvents</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l517"><code>datatable/js/core.js:517</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Sets up the change event subscriptions to maintain internal state.</p>
</div>
</div>
<div id="method__initData" class="method item protected">
<h3 class="name"><code>_initData</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/ModelList.html" class="crosslink">ModelList</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l532"><code>datatable/js/core.js:532</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Defaults the <code>data</code> attribute to an empty ModelList if not set during
construction. Uses the configured <code>recordType</code> for the ModelList's <code>model</code>
proeprty if set.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/ModelList.html" class="crosslink">ModelList</a></span>:
</div>
</div>
</div>
<div id="method__initDataProperty" class="method item protected">
<h3 class="name"><code>_initDataProperty</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>data</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l554"><code>datatable/js/core.js:554</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Initializes the instance's <code>data</code> property from the value of the <code>data</code>
attribute. If the attribute value is a ModelList, it is assigned directly
to <code>this.data</code>. If it is an array, a ModelList is created, its <code>model</code>
property is set to the configured <code>recordType</code> class, and it is seeded with
the array data. This ModelList is then assigned to <code>this.data</code>.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">data</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | <a href="../classes/ModelList.html" class="crosslink">ModelList</a> | <a href="../classes/ArrayList.html" class="crosslink">ArrayList</a></span>
<div class="param-description">
<p>Collection of data to populate the
DataTable</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__initHierarchy" class="method item private inherited">
<h3 class="name"><code>_initHierarchy</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>userVals</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#method__initHierarchy">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l659"><code>base/js/BaseCore.js:659</code></a>
</p>
</div>
<div class="description">
<p>Initializes the class hierarchy for the instance, which includes
initializing attributes for each class defined in the class's
static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and
invoking the initializer method on the prototype of each class in the hierarchy.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">userVals</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Object with configuration property name/value pairs</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__initHierarchyData" class="method item private inherited">
<h3 class="name"><code>_initHierarchyData</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#method__initHierarchyData">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l457"><code>base/js/BaseCore.js:457</code></a>
</p>
</div>
<div class="description">
<p>A helper method used by _getClasses and _getAttrCfgs, which determines both
the array of classes and aggregate set of attribute configurations
across the class hierarchy for the instance.</p>
</div>
</div>
<div id="method__initMessageNode" class="method item protected">
<h3 class="name"><code>_initMessageNode</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l203"><code>datatable/js/message.js:203</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Creates the <code>_messageNode</code> property from the configured <code>MESSAGE_TEMPLATE</code>
and inserts it before the <code><table></code>'s <code><tbody></code> node.</p>
</div>
</div>
<div id="method__initMessageStrings" class="method item protected">
<h3 class="name"><code>_initMessageStrings</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l224"><code>datatable/js/message.js:224</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Add the messaging related strings to the <code>strings</code> map.</p>
</div>
</div>
<div id="method__initSortFn" class="method item protected">
<h3 class="name"><code>_initSortFn</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l477"><code>datatable/js/sort.js:477</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Creates a <code>_compare</code> function for the <code>data</code> ModelList to allow custom
sorting by multiple fields.</p>
</div>
</div>
<div id="method__initSortStrings" class="method item protected">
<h3 class="name"><code>_initSortStrings</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l532"><code>datatable/js/sort.js:532</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Add the sort related strings to the <code>strings</code> map.</p>
</div>
</div>
<div id="method__initUIEvent" class="method item private inherited">
<h3 class="name"><code>_initUIEvent</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__initUIEvent">Widget</a>:
<a href="../files/widget_js_WidgetUIEvents.js.html#l176"><code>widget/js/WidgetUIEvents.js:176</code></a>
</p>
</div>
<div class="description">
<p>Sets up infrastructure required to fire a UI event.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>String representing the name of the event</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>:
</div>
</div>
</div>
<div id="method__isLazyAttr" class="method item private inherited">
<h3 class="name"><code>_isLazyAttr</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__isLazyAttr">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l369"><code>attribute/js/AttributeCore.js:369</code></a>
</p>
</div>
<div class="description">
<p>Checks whether or not the attribute is one which has been
added lazily and still requires initialization.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
true if it's a lazily added attribute, false otherwise.
</div>
</div>
</div>
<div id="method__isUIEvent" class="method item private inherited">
<h3 class="name"><code>_isUIEvent</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__isUIEvent">Widget</a>:
<a href="../files/widget_js_WidgetUIEvents.js.html#l143"><code>widget/js/WidgetUIEvents.js:143</code></a>
</p>
</div>
<div class="description">
<p>Determines if the specified event is a UI event.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>String representing the name of the event</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>:
Event Returns the name of the UI Event, otherwise
undefined.
</div>
</div>
</div>
<div id="method__mapInstance" class="method item protected inherited">
<h3 class="name"><code>_mapInstance</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>The</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__mapInstance">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l414"><code>widget/js/Widget.js:414</code></a>
</p>
</div>
<div class="description">
<p>Utility method used to add an entry to the boundingBox id to instance map.</p>
<p>This method can be used to populate the instance with lazily created boundingBox Node references.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">The</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>boundingBox id</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__monitor" class="method item private inherited">
<h3 class="name"><code>_monitor</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>what</code>
</li>
<li class="arg">
<code>eventType</code>
</li>
<li class="arg">
<code>o</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method__monitor">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l658"><code>event-custom/js/event-target.js:658</code></a>
</p>
</div>
<div class="description">
<p>This is the entry point for the event monitoring system.
You can monitor 'attach', 'detach', 'fire', and 'publish'.
When configured, these events generate an event. click ->
click<em>attach, click</em>detach, click_publish -- these can
be subscribed to like other events to monitor the event
system. Inividual published events can have monitoring
turned on or off (publish can't be turned off before it
it published) by setting the events 'monitor' config.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">what</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>'attach', 'detach', 'fire', or 'publish'</p>
</div>
</li>
<li class="param">
<code class="param-name">eventType</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
<div class="param-description">
<p>The prefixed name of the event being monitored, or the CustomEvent object.</p>
</div>
</li>
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Information about the event interaction, such as
fire() args, subscription category, publish config</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__normAttrVals" class="method item private inherited">
<h3 class="name"><code>_normAttrVals</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>valueHash</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__normAttrVals">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l897"><code>attribute/js/AttributeCore.js:897</code></a>
</p>
</div>
<div class="description">
<p>Utility method to normalize attribute values. The base implementation
simply merges the hash to protect the original.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">valueHash</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>An object with attribute name/value pairs</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>:
An object literal with 2 properties - "simple" and "complex",
containing simple and complex attribute values respectively keyed
by the top level attribute name, or null, if valueHash is falsey.
</div>
</div>
</div>
<div id="method__onDocFocus" class="method item protected inherited">
<h3 class="name"><code>_onDocFocus</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>evt</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__onDocFocus">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1081"><code>widget/js/Widget.js:1081</code></a>
</p>
</div>
<div class="description">
<p>DOM focus event handler, used to sync the state of the Widget with the DOM</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">evt</code>
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
<div class="param-description">
<p>The event facade for the DOM focus event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__onDocMouseDown" class="method item protected inherited">
<h3 class="name"><code>_onDocMouseDown</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>evt</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__onDocMouseDown">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1068"><code>widget/js/Widget.js:1068</code></a>
</p>
</div>
<div class="description">
<p>"mousedown" event handler for the owner document of the
widget's bounding box.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">evt</code>
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
<div class="param-description">
<p>The event facade for the DOM focus event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__onUITriggerSort" class="method item protected">
<h3 class="name"><code>_onUITriggerSort</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>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l545"><code>datatable/js/sort.js:545</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Fires the <code>sort</code> event in response to user clicks on sortable column
headers.</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/DOMEventFacade.html" class="crosslink">DOMEventFacade</a></span>
<div class="param-description">
<p>The <code>click</code> event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__parseSortable" class="method item protected">
<h3 class="name"><code>_parseSortable</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l595"><code>datatable/js/sort.js:595</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Normalizes the possible input values for the <code>sortable</code> attribute, storing
the results in the <code>_sortable</code> property.</p>
</div>
</div>
<div id="method__parseType" class="method item private inherited">
<h3 class="name"><code>_parseType</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method__parseType">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l52"><code>event-custom/js/event-target.js:52</code></a>
</p>
</div>
<div class="description">
<p>Returns an array with the detach key (if provided),
and the prefixed event name from _getType
Y.on('detachcategory| menu:click', fn)</p>
</div>
</div>
<div id="method__preInitEventCfg" class="method item private inherited">
<h3 class="name"><code>_preInitEventCfg</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseObservable.html#method__preInitEventCfg">BaseObservable</a>:
<a href="../files/base_js_BaseObservable.js.html#l98"><code>base/js/BaseObservable.js:98</code></a>
</p>
</div>
<div class="description">
<p>Handles the special on, after and target properties which allow the user to
easily configure on and after listeners as well as bubble targets during
construction, prior to init.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The user configuration object</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__protectAttrs" class="method item protected deprecated inherited">
<h3 class="name"><code>_protectAttrs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attrs</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 deprecated" title="Use `AttributeCore.protectAttrs()` or
`Attribute.protectAttrs()` which are the same static utility method.">deprecated</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__protectAttrs">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l883"><code>attribute/js/AttributeCore.js:883</code></a>
</p>
<p>Deprecated: Use `AttributeCore.protectAttrs()` or
`Attribute.protectAttrs()` which are the same static utility method.</p>
</div>
<div class="description">
<p>Utility method to protect an attribute configuration
hash, by merging the entire object and the individual
attr config objects.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">attrs</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>A hash of attribute to configuration object pairs.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
A protected version of the attrs argument.
</div>
</div>
</div>
<div id="method__publish" class="method item private inherited">
<h3 class="name"><code>_publish</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>fullType</code>
</li>
<li class="arg">
<code>etOpts</code>
</li>
<li class="arg">
<code>ceOpts</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method__publish">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l610"><code>event-custom/js/event-target.js:610</code></a>
</p>
</div>
<div class="description">
<p>The low level event publish implementation. It expects all the massaging to have been done
outside of this method. e.g. the <code>type</code> to <code>fullType</code> conversion. It's designed to be a fast
path publish, which can be used by critical code paths to improve performance.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">fullType</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The prefixed type of the event to publish.</p>
</div>
</li>
<li class="param">
<code class="param-name">etOpts</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The EventTarget specific configuration to mix into the published event.</p>
</div>
</li>
<li class="param">
<code class="param-name">ceOpts</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The publish specific configuration to mix into the published event.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
The published event. If called without <code>etOpts</code> or <code>ceOpts</code>, this will
be the default <code>CustomEvent</code> instance, and can be configured independently.
</div>
</div>
</div>
<div id="method__relayCoreAttrChange" class="method item protected inherited">
<h3 class="name"><code>_relayCoreAttrChange</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>Inherited from
<a href="../classes/DataTable.Base.html#method__relayCoreAttrChange">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l411"><code>datatable/js/base.js:411</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Relays attribute changes to the instance's <code>view</code>.</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">
<p>The change event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__removeLoadingClassNames" class="method item protected inherited">
<h3 class="name"><code>_removeLoadingClassNames</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__removeLoadingClassNames">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l862"><code>widget/js/Widget.js:862</code></a>
</p>
</div>
<div class="description">
<p>Removes class names representative of the widget's loading state from
the boundingBox.</p>
</div>
</div>
<div id="method__removeScrollbar" class="method item protected">
<h3 class="name"><code>_removeScrollbar</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l713"><code>datatable/js/scroll.js:713</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes the virtual scrollbar used by scrolling tables.</p>
</div>
</div>
<div id="method__removeScrollCaptionTable" class="method item protected">
<h3 class="name"><code>_removeScrollCaptionTable</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l621"><code>datatable/js/scroll.js:621</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes the table used to house the caption when the table is scrolling.</p>
</div>
</div>
<div id="method__removeXScrollNode" class="method item protected">
<h3 class="name"><code>_removeXScrollNode</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l640"><code>datatable/js/scroll.js:640</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes the <code><div></code> wrapper used to contain the data table when the table
is horizontally scrolling.</p>
</div>
</div>
<div id="method__removeYScrollContainer" class="method item protected">
<h3 class="name"><code>_removeYScrollContainer</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l659"><code>datatable/js/scroll.js:659</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes the <code><div></code> wrapper used to contain the data table and fixed header
when the table is vertically scrolling.</p>
</div>
</div>
<div id="method__removeYScrollHeader" class="method item protected">
<h3 class="name"><code>_removeYScrollHeader</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l678"><code>datatable/js/scroll.js:678</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes the <code><table></code> used to contain the fixed column headers when the
table is vertically scrolling.</p>
</div>
</div>
<div id="method__removeYScrollNode" class="method item protected">
<h3 class="name"><code>_removeYScrollNode</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l694"><code>datatable/js/scroll.js:694</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes the <code><div></code> wrapper used to contain the data table when the table
is vertically scrolling.</p>
</div>
</div>
<div id="method__renderBox" class="method item private inherited">
<h3 class="name"><code>_renderBox</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>parentNode</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__renderBox">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l710"><code>widget/js/Widget.js:710</code></a>
</p>
</div>
<div class="description">
<p>Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not
already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used
as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and
the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered
to the current document's body.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">parentNode</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The parentNode to render the widget to. If not provided, and both the boundingBox and
the contentBox are not currently in the document, the widget will be rendered to the current document's body.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__renderBoxClassNames" class="method item protected inherited">
<h3 class="name"><code>_renderBoxClassNames</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__renderBoxClassNames">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l838"><code>widget/js/Widget.js:838</code></a>
</p>
</div>
<div class="description">
<p>Applies standard class names to the boundingBox and contentBox</p>
</div>
</div>
<div id="method__renderSortable" class="method item protected">
<h3 class="name"><code>_renderSortable</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l637"><code>datatable/js/sort.js:637</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Initial application of the sortable UI.</p>
</div>
</div>
<div id="method__renderUI" class="method item protected inherited">
<h3 class="name"><code>_renderUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__renderUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l827"><code>widget/js/Widget.js:827</code></a>
</p>
</div>
<div class="description">
<p>Initializes the UI state for the Widget's bounding/content boxes.</p>
</div>
</div>
<div id="method__set" class="method item protected inherited">
<h3 class="name"><code>_set</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>val</code>
</li>
<li class="arg">
<code class="optional">[opts]</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>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeObservable.html#method__set">
AttributeObservable
</a>
but overwritten in
<a href="../files/attribute_js_AttributeCore.js.html#l427"><code>attribute/js/AttributeCore.js:427</code></a>
</p>
</div>
<div class="description">
<p>Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute.</p>
</div>
</li>
<li class="param">
<code class="param-name">val</code>
<span class="type">Any</span>
<div class="param-description">
<p>The value to set the attribute to.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[opts]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Optional data providing the circumstances for the change.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
A reference to the host object.
</div>
</div>
</div>
<div id="method__setAttr" class="method item protected inherited">
<h3 class="name"><code>_setAttr</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>value</code>
</li>
<li class="arg">
<code class="optional">[opts]</code>
</li>
<li class="arg">
<code>force</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>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__setAttr">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l443"><code>attribute/js/AttributeCore.js:443</code></a>
</p>
</div>
<div class="description">
<p>Provides the common implementation for the public set and protected _set methods.</p>
<p>See <a href="#method_set">set</a> for argument details.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute.</p>
</div>
</li>
<li class="param">
<code class="param-name">value</code>
<span class="type">Any</span>
<div class="param-description">
<p>The value to set the attribute to.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[opts]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Optional data providing the circumstances for the change.</p>
</div>
</li>
<li class="param">
<code class="param-name">force</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>If true, allows the caller to set values for
readOnly or writeOnce attributes which have already been set.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
A reference to the host object.
</div>
</div>
</div>
<div id="method__setAttrs" class="method item protected inherited">
<h3 class="name"><code>_setAttrs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attrs</code>
</li>
<li class="arg">
<code class="optional">[opts]</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>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeObservable.html#method__setAttrs">
AttributeObservable
</a>
but overwritten in
<a href="../files/attribute_js_AttributeCore.js.html#l742"><code>attribute/js/AttributeCore.js:742</code></a>
</p>
</div>
<div class="description">
<p>Implementation behind the public setAttrs method, to set multiple attribute values.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">attrs</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>An object with attributes name/value pairs.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[opts]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Optional data providing the circumstances for the change</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
A reference to the host object.
</div>
</div>
</div>
<div id="method__setAttrUI" class="method item private inherited">
<h3 class="name"><code>_setAttrUI</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__setAttrUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1201"><code>widget/js/Widget.js:1201</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">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__setAttrVal" class="method item private inherited">
<h3 class="name"><code>_setAttrVal</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attrName</code>
</li>
<li class="arg">
<code>subAttrName</code>
</li>
<li class="arg">
<code>prevVal</code>
</li>
<li class="arg">
<code>newVal</code>
</li>
<li class="arg">
<code class="optional">[opts]</code>
</li>
<li class="arg">
<code class="optional">[attrCfg]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Booolean</span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__setAttrVal">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l640"><code>attribute/js/AttributeCore.js:640</code></a>
</p>
</div>
<div class="description">
<p>Updates the stored value of the attribute in the privately held State object,
if validation and setter passes.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<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">
<p>The attribute name.</p>
</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">
<p>The sub-attribute name, if setting a sub-attribute property ("x.y.z").</p>
</div>
</li>
<li class="param">
<code class="param-name">prevVal</code>
<span class="type">Any</span>
<div class="param-description">
<p>The currently stored value of the attribute.</p>
</div>
</li>
<li class="param">
<code class="param-name">newVal</code>
<span class="type">Any</span>
<div class="param-description">
<p>The value which is going to be stored.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[opts]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Optional data providing the circumstances for the change.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[attrCfg]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Optional config hash for the attribute. This is added for performance along the critical path,
where the calling method has already obtained the config from state.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Booolean</span>:
true if the new attribute value was stored, false if not.
</div>
</div>
</div>
<div id="method__setBB" class="method item private inherited">
<h3 class="name"><code>_setBB</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>Node/String</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__setBB">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l756"><code>widget/js/Widget.js:756</code></a>
</p>
</div>
<div class="description">
<p>Setter for the boundingBox attribute</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">Node/String</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">
Node
</div>
</div>
</div>
<div id="method__setBox" class="method item private inherited">
<h3 class="name"><code>_setBox</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code>node</code>
</li>
<li class="arg">
<code>template</code>
</li>
<li class="arg">
<code>true</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__setBox">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l793"><code>widget/js/Widget.js:793</code></a>
</p>
</div>
<div class="description">
<p>Helper method to set the bounding/content box, or create it from
the provided template if not found.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The node's id attribute</p>
</div>
</li>
<li class="param">
<code class="param-name">node</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The node reference</p>
</div>
</li>
<li class="param">
<code class="param-name">template</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>HTML string template for the node</p>
</div>
</li>
<li class="param">
<code class="param-name">true</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>if this is the boundingBox, false if it's the contentBox</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
The node
</div>
</div>
</div>
<div id="method__setCB" class="method item private inherited">
<h3 class="name"><code>_setCB</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>node</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__setCB">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l768"><code>widget/js/Widget.js:768</code></a>
</p>
</div>
<div class="description">
<p>Setter for the contentBox attribute</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">node</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
Node
</div>
</div>
</div>
<div id="method__setColumnMap" class="method item protected">
<h3 class="name"><code>_setColumnMap</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>columns</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l640"><code>datatable/js/core.js:640</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Iterates the array of column configurations to capture all columns with a
<code>key</code> property. An map is built with column keys as the property name and
the corresponding column object as the associated value. This map is then
assigned to the instance's <code>_columnMap</code> property.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">columns</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span>
<div class="param-description">
<p>The array of column config objects</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__setColumns" class="method item protected">
<h3 class="name"><code>_setColumns</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Null | <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/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l684"><code>datatable/js/core.js:684</code></a>
</p>
</div>
<div class="description">
<p>Translates string columns into objects with that string as the value of its
<code>key</code> property.</p>
<p>All columns are assigned a <code>_yuid</code> stamp and <code>_id</code> property corresponding
to the column's configured <code>name</code> or <code>key</code> property with any spaces
replaced with dashes. If the same <code>name</code> or <code>key</code> appears in multiple
columns, subsequent appearances will have their <code>_id</code> appended with an
incrementing number (e.g. if column "foo" is included in the <code>columns</code>
attribute twice, the first will get <code>_id</code> of "foo", and the second an <code>_id</code>
of "foo1"). Columns that are children of other columns will have the
<code>_parent</code> property added, assigned the column object to which they belong.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type">Null | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span>
<div class="param-description">
<p>Array of config objects or strings</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Null | <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__setColumnset" class="method item protected deprecated">
<h3 class="name"><code>_setColumnset</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag deprecated" title="This will be removed with the deprecated `columnset` attribute
in a later version.">deprecated</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l792"><code>datatable/js/core.js:792</code></a>
</p>
<p>Deprecated: This will be removed with the deprecated `columnset` attribute
in a later version.</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Relays attribute assignments of the deprecated <code>columnset</code> attribute to the
<code>columns</code> attribute. If a Columnset is object is passed, its basic object
structure is mined.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | Columnset</span>
<div class="param-description">
<p>The columnset value to relay</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__setColumnWidth" class="method item protected">
<h3 class="name"><code>_setColumnWidth</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>colIndex</code>
</li>
<li class="arg">
<code>width</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-column-widths.html">datatable-column-widths</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_colwidths.js.html#l198"><code>datatable/js/colwidths.js:198</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Sets a columns's <code><col></code> element width style. This is needed to get around
browser rendering differences.</p>
<p>The colIndex corresponds to the item index of the <code><col></code> in the table's
<code><colgroup></code>.</p>
<p>To unset the width, pass a falsy value for the <code>width</code>.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">colIndex</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The display column index</p>
</div>
</li>
<li class="param">
<code class="param-name">width</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The desired width</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__setData" class="method item protected">
<h3 class="name"><code>_setData</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l810"><code>datatable/js/core.js:810</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Accepts an object with <code>each</code> and <code>getAttrs</code> (preferably a ModelList or
subclass) or an array of data objects. If an array is passes, it will
create a ModelList to wrap the data. In doing so, it will set the created
ModelList's <code>model</code> property to the class in the <code>recordType</code> attribute,
which will be defaulted if not yet set.</p>
<p>If the <code>data</code> property is already set with a ModelList, passing an array as
the value will call the ModelList's <code>reset()</code> method with that array rather
than replacing the stored ModelList wholesale.</p>
<p>Any non-ModelList-ish and non-array value is invalid.</p>
</div>
</div>
<div id="method__setRecordset" class="method item protected deprecated">
<h3 class="name"><code>_setRecordset</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag deprecated" title="This will be removed with the deprecated `recordset` attribute
in a later version.">deprecated</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l853"><code>datatable/js/core.js:853</code></a>
</p>
<p>Deprecated: This will be removed with the deprecated `recordset` attribute
in a later version.</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Relays the value assigned to the deprecated <code>recordset</code> attribute to the
<code>data</code> attribute. If a Recordset instance is passed, the raw object data
will be culled from it.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a> | <a href="../classes/Recordset.html" class="crosslink">Recordset</a></span>
<div class="param-description">
<p>The recordset value to relay</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__setRecordType" class="method item protected">
<h3 class="name"><code>_setRecordType</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</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>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l881"><code>datatable/js/core.js:881</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Accepts a Base subclass (preferably a Model subclass). Alternately, it will
generate a custom Model subclass from an array of attribute names or an
object defining attributes and their respective configurations (it is
assigned as the <code>ATTRS</code> of the new class).</p>
<p>Any other value is invalid.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</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> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The Model subclass, array of
attribute names, or the <code>ATTRS</code> definition for a custom model
subclass</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>:
A Base/Model subclass
</div>
</div>
</div>
<div id="method__setScrollable" class="method item protected">
<h3 class="name"><code>_setScrollable</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</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/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l733"><code>datatable/js/scroll.js:733</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Accepts (case insensitive) values "x", "y", "xy", <code>true</code>, and <code>false</code>.
<code>true</code> is translated to "xy" and upper case values are converted to lower
case. All other values are invalid.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | Boolea</span>
<div class="param-description">
<p>Incoming value for the <code>scrollable</code> attribute</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>:
</div>
</div>
</div>
<div id="method__setScrollProperties" class="method item protected">
<h3 class="name"><code>_setScrollProperties</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l758"><code>datatable/js/scroll.js:758</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Assigns the <code>_xScroll</code> and <code>_yScroll</code> properties to true if an
appropriate value is set in the <code>scrollable</code> attribute and the <code>height</code>
and/or <code>width</code> is set.</p>
</div>
</div>
<div id="method__setSortBy" class="method item protected">
<h3 class="name"><code>_setSortBy</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l650"><code>datatable/js/sort.js:650</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Parses the current <code>sortBy</code> attribute into a normalized structure for the
<code>data</code> ModelList's <code>_compare</code> method. Also updates the column
configurations' <code>sortDir</code> properties.</p>
</div>
</div>
<div id="method__setStateVal" class="method item private inherited">
<h3 class="name"><code>_setStateVal</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>value</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method__setStateVal">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l622"><code>attribute/js/AttributeCore.js:622</code></a>
</p>
</div>
<div class="description">
<p>Sets the stored value for the attribute, in either the
internal state object, or the state proxy if it exits</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute</p>
</div>
</li>
<li class="param">
<code class="param-name">value</code>
<span class="type">Any</span>
<div class="param-description">
<p>The value of the attribute</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__setStrings" class="method item protected inherited">
<h3 class="name"><code>_setStrings</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>strings</code>
</li>
<li class="arg">
<code>locale</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__setStrings">Widget</a>:
<a href="../files/widget_js_WidgetLocale.js.html#l35"><code>widget/js/WidgetLocale.js:35</code></a>
</p>
</div>
<div class="description">
<p>Sets strings for a particular locale, merging with any existing
strings which may already be defined for the locale.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">strings</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The hash of string key/values to set</p>
</div>
</li>
<li class="param">
<code class="param-name">locale</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The locale for the string values being set</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__sortComparator" class="method item protected">
<h3 class="name"><code>_sortComparator</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>item</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l741"><code>datatable/js/sort.js:741</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Replacement <code>comparator</code> for the <code>data</code> ModelList that defers sorting logic
to the <code>_compare</code> method. The deferral is accomplished by returning <code>this</code>.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">item</code>
<span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>
<div class="param-description">
<p>The record being evaluated for sort position</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>:
The record
</div>
</div>
</div>
<div id="method__strSetter" class="method item protected inherited">
<h3 class="name"><code>_strSetter</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>strings</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>Inherited from
<a href="../classes/Widget.html#method__strSetter">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1212"><code>widget/js/Widget.js:1212</code></a>
</p>
</div>
<div class="description">
<p>The default setter for the strings attribute. Merges partial sets
into the full string set, to allow users to partial sets of strings</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">strings</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/String" class="crosslink external" target="_blank">String</a></span>:
The full set of strings to set
</div>
</div>
</div>
<div id="method__syncAttrUI" class="method item private inherited">
<h3 class="name"><code>_syncAttrUI</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attrs</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__syncAttrUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1186"><code>widget/js/Widget.js:1186</code></a>
</p>
</div>
<div class="description">
<p>Invokes the _uiSet=ATTR NAME> method for the list of attributes provided</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">attrs</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>
<div id="method__syncMessageUI" class="method item protected">
<h3 class="name"><code>_syncMessageUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l247"><code>datatable/js/message.js:247</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Synchronizes the message UI with the table state.</p>
</div>
</div>
<div id="method__syncScrollCaptionUI" class="method item protected">
<h3 class="name"><code>_syncScrollCaptionUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l805"><code>datatable/js/scroll.js:805</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Splits the caption from the data <code><table></code> if the table is configured to
scroll. If not, rejoins the caption to the data <code><table></code> if it needs to
be.</p>
</div>
</div>
<div id="method__syncScrollColumnWidths" class="method item protected">
<h3 class="name"><code>_syncScrollColumnWidths</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l844"><code>datatable/js/scroll.js:844</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Assigns widths to the fixed header columns to match the columns in the data
table.</p>
</div>
</div>
<div id="method__syncScrollHeaders" class="method item protected">
<h3 class="name"><code>_syncScrollHeaders</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l886"><code>datatable/js/scroll.js:886</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Creates matching headers in the fixed header table for vertically scrolling
tables and synchronizes the column widths.</p>
</div>
</div>
<div id="method__syncScrollPosition" class="method item protected">
<h3 class="name"><code>_syncScrollPosition</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>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l776"><code>datatable/js/scroll.js:776</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Keeps the virtual scrollbar and the scrolling <code><div></code> wrapper around the
data table in vertically scrolling tables in sync.</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/DOMEventFacade.html" class="crosslink">DOMEventFacade</a></span>
<div class="param-description">
<p>The scroll event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__syncScrollUI" class="method item protected">
<h3 class="name"><code>_syncScrollUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l934"><code>datatable/js/scroll.js:934</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Wraps the table for X and Y scrolling, if necessary, if the <code>scrollable</code>
attribute is set. Synchronizes dimensions and DOM placement of all
scrolling related nodes.</p>
</div>
</div>
<div id="method__syncUI" class="method item protected inherited">
<h3 class="name"><code>_syncUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__syncUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l964"><code>widget/js/Widget.js:964</code></a>
</p>
</div>
<div class="description">
<p>Updates the widget UI to reflect the attribute state.</p>
</div>
</div>
<div id="method__syncUIChild" class="method item protected inherited">
<h3 class="name"><code>_syncUIChild</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__syncUIChild">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l341"><code>widget-child/js/Widget-Child.js:341</code></a>
</p>
</div>
<div class="description">
<p>Synchronizes the UI to match the WidgetChild state.</p>
<p>
This method is invoked after bindUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__syncXScrollUI" class="method item protected">
<h3 class="name"><code>_syncXScrollUI</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>xy</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l995"><code>datatable/js/scroll.js:995</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Wraps the table in a scrolling <code><div></code> of the configured width for "x"
scrolling.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">xy</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>True if the table is configured with scrollable ="xy"</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__syncYScrollUI" class="method item protected">
<h3 class="name"><code>_syncYScrollUI</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>xy</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l1064"><code>datatable/js/scroll.js:1064</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Wraps the table in a scrolling <code><div></code> of the configured height (accounting
for the caption if there is one) if "y" scrolling is enabled. Otherwise,
unwraps the table if necessary.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">xy</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>True if the table is configured with scrollable = "xy"</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetChildSelected" class="method item protected inherited">
<h3 class="name"><code>_uiSetChildSelected</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>selected</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetChildSelected">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l305"><code>widget-child/js/Widget-Child.js:305</code></a>
</p>
</div>
<div class="description">
<p>Updates the UI to reflect the <code>selected</code> attribute value.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">selected</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The selected value to be reflected in the UI.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetColumnWidths" class="method item protected">
<h3 class="name"><code>_uiSetColumnWidths</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-column-widths.html">datatable-column-widths</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_colwidths.js.html#l254"><code>datatable/js/colwidths.js:254</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Populates the table's <code><colgroup></code> with a <code><col></code> per item in the <code>columns</code>
attribute without children. It is assumed that these are the columns that
have data cells renderered for them.</p>
</div>
</div>
<div id="method__uiSetDim" class="method item private inherited">
<h3 class="name"><code>_uiSetDim</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>dim</code>
</li>
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetDim">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l997"><code>widget/js/Widget.js:997</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">dim</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The dimension - "width" or "height"</p>
</div>
</li>
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The value to set</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetDisabled" class="method item protected inherited">
<h3 class="name"><code>_uiSetDisabled</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetDisabled">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1018"><code>widget/js/Widget.js:1018</code></a>
</p>
</div>
<div class="description">
<p>Sets the disabled state for the UI</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</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__uiSetFocused" class="method item protected inherited">
<h3 class="name"><code>_uiSetFocused</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
<li class="arg">
<code>src</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetFocused">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1029"><code>widget/js/Widget.js:1029</code></a>
</p>
</div>
<div class="description">
<p>Sets the focused state for the UI</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</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>
<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>String representing the source that triggered an update to
the UI.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetHeight" class="method item protected inherited">
<h3 class="name"><code>_uiSetHeight</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetHeight">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l974"><code>widget/js/Widget.js:974</code></a>
</p>
</div>
<div class="description">
<p>Sets the height on the widget's bounding box element</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetMessage" class="method item protected">
<h3 class="name"><code>_uiSetMessage</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>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l258"><code>datatable/js/message.js:258</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Calls <code>hideMessage</code> or <code>showMessage</code> as appropriate based on the presence of
records in the <code>data</code> ModelList.</p>
<p>This is called when <code>data</code> is reset or records are added or removed. Also,
if the <code>showMessages</code> attribute is updated. In either case, if the
triggering event has a <code>message</code> property on the EventFacade, it will be
passed to <code>showMessage</code> (if appropriate). If no such property is on the
facade, the <code>emptyMessage</code> will be used (see the strings).</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">
<p>The columnsChange event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetScrollable" class="method item protected">
<h3 class="name"><code>_uiSetScrollable</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l1164"><code>datatable/js/scroll.js:1164</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Assigns the appropriate class to the <code>boundingBox</code> to identify the DataTable
as horizontally scrolling, vertically scrolling, or both (adds both classes).</p>
<p>Classes added are "yui3-datatable-scrollable-x" or "...-y"</p>
</div>
</div>
<div id="method__uiSetScrollbarHeight" class="method item protected">
<h3 class="name"><code>_uiSetScrollbarHeight</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l1180"><code>datatable/js/scroll.js:1180</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Updates the virtual scrollbar's height to avoid overlapping with the fixed
headers.</p>
</div>
</div>
<div id="method__uiSetScrollbarPosition" class="method item protected">
<h3 class="name"><code>_uiSetScrollbarPosition</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>scroller</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l1203"><code>datatable/js/scroll.js:1203</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Updates the virtual scrollbar's placement to avoid overlapping the fixed
headers or the data table.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">scroller</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>Reference node to position the scrollbar over</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetSortable" class="method item protected">
<h3 class="name"><code>_uiSetSortable</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l756"><code>datatable/js/sort.js:756</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Applies the appropriate classes to the <code>boundingBox</code> and column headers to
indicate sort state and sortability.</p>
<p>Also currently wraps the header content of sortable columns in a <code><div></code>
liner to give a CSS anchor for sort indicators.</p>
</div>
</div>
<div id="method__uiSetTabIndex" class="method item protected inherited">
<h3 class="name"><code>_uiSetTabIndex</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>Number</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetTabIndex">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1051"><code>widget/js/Widget.js:1051</code></a>
</p>
</div>
<div class="description">
<p>Set the tabIndex on the widget's rendered UI</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">Number</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>
<div id="method__uiSetVisible" class="method item protected inherited">
<h3 class="name"><code>_uiSetVisible</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetVisible">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1007"><code>widget/js/Widget.js:1007</code></a>
</p>
</div>
<div class="description">
<p>Sets the visible state for the UI</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</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__uiSetWidth" class="method item protected inherited">
<h3 class="name"><code>_uiSetWidth</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetWidth">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l986"><code>widget/js/Widget.js:986</code></a>
</p>
</div>
<div class="description">
<p>Sets the width on the widget's bounding box element</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetYScrollWidth" class="method item protected">
<h3 class="name"><code>_uiSetYScrollWidth</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>width</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l1238"><code>datatable/js/scroll.js:1238</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Assigns the width of the <code><div></code> wrapping the data table in vertically
scrolling tables.</p>
<p>If the table can't compress to the specified width, the container is
expanded accordingly.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">width</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The CSS width to attempt to set</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSizeCB" class="method item protected inherited">
<h3 class="name"><code>_uiSizeCB</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>expand</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSizeCB">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l701"><code>widget/js/Widget.js:701</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">expand</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__unbindDOM" class="method item protected inherited">
<h3 class="name"><code>_unbindDOM</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__unbindDOM">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l933"><code>widget/js/Widget.js:933</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="method__unbindScrollbar" class="method item protected">
<h3 class="name"><code>_unbindScrollbar</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l1294"><code>datatable/js/scroll.js:1294</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Detaches the scroll event subscriptions used to maintain scroll position
parity between the scrollable <code><div></code> wrapper around the data table and the
virtual scrollbar for vertically scrolling tables.</p>
</div>
</div>
<div id="method__unbindScrollResize" class="method item protected">
<h3 class="name"><code>_unbindScrollResize</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l1309"><code>datatable/js/scroll.js:1309</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Detaches the resize event subscription used to maintain column parity for
vertically scrolling tables with percentage widths.</p>
</div>
</div>
<div id="method__unbindUI" class="method item protected inherited">
<h3 class="name"><code>_unbindUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__unbindUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l894"><code>widget/js/Widget.js:894</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="method__validateSortable" class="method item protected">
<h3 class="name"><code>_validateSortable</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l858"><code>datatable/js/sort.js:858</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Allows values <code>true</code>, <code>false</code>, "auto", or arrays of column names through.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type">Any</span>
<div class="param-description">
<p>The input value to <code>set("sortable", VAL)</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/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
</div>
</div>
</div>
<div id="method__validateSortBy" class="method item protected">
<h3 class="name"><code>_validateSortBy</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l871"><code>datatable/js/sort.js:871</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Allows strings, arrays of strings, objects, or arrays of objects.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
<div class="param-description">
<p>The new <code>sortBy</code> value</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
</div>
</div>
</div>
<div id="method__validateView" class="method item protected inherited">
<h3 class="name"><code>_validateView</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#method__validateView">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l524"><code>datatable/js/base.js:524</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Verifies the input value is a function with a <code>render</code> method on its
prototype. <code>null</code> is also accepted to remove the default View.</p>
</div>
</div>
<div id="method__validTabIndex" class="method item protected inherited">
<h3 class="name"><code>_validTabIndex</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>tabIndex</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__validTabIndex">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1161"><code>widget/js/Widget.js:1161</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">tabIndex</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_addAttr" class="method item inherited">
<h3 class="name"><code>addAttr</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>config</code>
</li>
<li class="arg">
<code>lazy</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 chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method_addAttr">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l157"><code>attribute/js/AttributeCore.js:157</code></a>
</p>
</div>
<div class="description">
<p>
Adds an attribute with the provided configuration to the host object.
</p>
<p>
The config argument object supports the following properties:
</p>
<dl>
<dt>value <Any></dt>
<dd>The initial value to set on the attribute</dd>
<dt>valueFn <Function | String></dt>
<dd>
<p>A function, which will return the initial value to set on the attribute. This is useful
for cases where the attribute configuration is defined statically, but needs to
reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined,
the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which
case the value property is used.</p>
<p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p>
</dd>
<dt>readOnly <boolean></dt>
<dd>Whether or not the attribute is read only. Attributes having readOnly set to true
cannot be modified by invoking the set method.</dd>
<dt>writeOnce <boolean> or <string></dt>
<dd>
Whether or not the attribute is "write once". Attributes having writeOnce set to true,
can only have their values set once, be it through the default configuration,
constructor configuration arguments, or by invoking set.
<p>The writeOnce attribute can also be set to the string "initOnly",
in which case the attribute can only be set during initialization
(when used with Base, this means it can only be set during construction)</p>
</dd>
<dt>setter <Function | String></dt>
<dd>
<p>The setter function used to massage or normalize the value passed to the set method for the attribute.
The value returned by the setter will be the final stored value. Returning
<a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent
the value from being stored.
</p>
<p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p>
</dd>
<dt>getter <Function | String></dt>
<dd>
<p>
The getter function used to massage or normalize the value returned by the get method for the attribute.
The value returned by the getter function is the value which will be returned to the user when they
invoke get.
</p>
<p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p>
</dd>
<dt>validator <Function | String></dt>
<dd>
<p>
The validator function invoked prior to setting the stored value. Returning
false from the validator function will prevent the value from being stored.
</p>
<p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p>
</dd>
<dt>lazyAdd <boolean></dt>
<dd>Whether or not to delay initialization of the attribute until the first call to get/set it.
This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through
the <a href="#method_addAttrs">addAttrs</a> method.</dd>
</dl>
<p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with
the context ("this") set to the host object.</p>
<p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute,
and are not intended for public use.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</p>
<p>
<strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need
to protect the original values, you will need to merge the object.
</p>
</div>
</li>
<li class="param">
<code class="param-name">lazy</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
A reference to the host object.
</div>
</div>
</div>
<div id="method_addAttrs" class="method item inherited">
<h3 class="name"><code>addAttrs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cfgs</code>
</li>
<li class="arg">
<code>values</code>
</li>
<li class="arg">
<code>lazy</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 chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method_addAttrs">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l805"><code>attribute/js/AttributeCore.js:805</code></a>
</p>
</div>
<div class="description">
<p>Configures a group of attributes, and sets initial values.</p>
<p>
<strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning.
The caller is responsible for merging/cloning the configuration object if required.
</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cfgs</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>An object with attribute name/configuration pairs.</p>
</div>
</li>
<li class="param">
<code class="param-name">values</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>An object with attribute name/value pairs, defining the initial values to apply.
Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>
</div>
</li>
<li class="param">
<code class="param-name">lazy</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>Whether or not to delay the intialization of these attributes until the first call to get/set.
Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.
See <a href="#method_addAttr">addAttr</a>.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
A reference to the host object.
</div>
</div>
</div>
<div id="method_addColumn" class="method item">
<h3 class="name"><code>addColumn</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>config</code>
</li>
<li class="arg">
<code class="optional">[index]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l60"><code>datatable/js/mutable.js:60</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Adds the column configuration to the DataTable's <code>columns</code> configuration.
If the <code>index</code> parameter is supplied, it is injected at that index. If the
table has nested headers, inject a subcolumn by passing an array of indexes
to identify the new column's final location.</p>
<p>The <code>index</code> parameter is required if adding a nested column.</p>
<p>This method is a convienience method for fetching the DataTable's <code>columns</code>
attribute, updating it, and calling
<code>table.set('columns', _updatedColumnsDefs_)</code></p>
<p>For example:</p>
<pre class="code prettyprint"><code>// Becomes last column
table.addColumn('name');
// Inserted after the current second column, moving the current third column
// to index 4
table.addColumn({ key: 'price', formatter: currencyFormatter }, 2 );
// Insert a new column in a set of headers three rows deep. The index array
// translates to
// [ 2, -- in the third column's children
// 1, -- in the second child's children
// 3 ] -- as the fourth child column
table.addColumn({ key: 'age', sortable: true }, [ 2, 1, 3 ]);
</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The new column configuration object</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[index]</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>the insertion index</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_addRow" class="method item">
<h3 class="name"><code>addRow</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 class="optional">[config]</code>
</li>
<li class="arg">
<code class="optional">[callback]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l198"><code>datatable/js/mutable.js:198</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Adds a new record to the DataTable's <code>data</code> ModelList. Record data can be
an object of field values or an instance of the DataTable's configured
<code>recordType</code> class.</p>
<p>This relays all parameters to the <code>data</code> ModelList's <code>add</code> method.</p>
<p>If a configuration object is passed as a second argument, and that object
has <code>sync: true</code> set, the underlying Model will be <code>save()</code>d.</p>
<p>If the DataTable's <code>autoSync</code> attribute is set to <code>true</code>, the additional
argument is not needed.</p>
<p>If syncing and the last argument is a function, that function will be used
as a callback to the Model's <code>save()</code> method.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">data</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The data or Model instance for the new record</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[config]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Configuration to pass along</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[callback]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Callback function for Model's <code>save()</code></p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">err</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span>
<div class="param-description">
<p>If an error occurred or validation
failed, this parameter will contain the error. If the sync operation
succeeded, <em>err</em> will be <code>null</code>.</p>
</div>
</li>
<li class="param">
<code class="param-name">response</code>
<span class="type">Any</span>
<div class="param-description">
<p>The server's response. This value will
be passed to the <code>parse()</code> method, which is expected to parse it and
return an attribute hash.</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_addRows" class="method item">
<h3 class="name"><code>addRows</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 class="optional">[config]</code>
</li>
<li class="arg">
<code class="optional">[callback]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l552"><code>datatable/js/mutable.js:552</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Adds an array of new records to the DataTable's <code>data</code> ModelList. Record data
can be an array of objects containing field values or an array of instance of
the DataTable's configured <code>recordType</code> class.</p>
<p>This relays all parameters to the <code>data</code> ModelList's <code>add</code> method.</p>
<p>Technically, this is an alias to <code>addRow</code>, but please use the appropriately
named method for readability.</p>
<p>If a configuration object is passed as a second argument, and that object
has <code>sync: true</code> set, the underlying Models will be <code>save()</code>d.</p>
<p>If the DataTable's <code>autoSync</code> attribute is set to <code>true</code>, the additional
argument is not needed.</p>
<p>If syncing and the last argument is a function, that function will be used
as a callback to each Model's <code>save()</code> method.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">data</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
<div class="param-description">
<p>The data or Model instances to add</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[config]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Configuration to pass along</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[callback]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Callback function for each Model's <code>save()</code></p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">err</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span>
<div class="param-description">
<p>If an error occurred or validation
failed, this parameter will contain the error. If the sync operation
succeeded, <em>err</em> will be <code>null</code>.</p>
</div>
</li>
<li class="param">
<code class="param-name">response</code>
<span class="type">Any</span>
<div class="param-description">
<p>The server's response. This value will
be passed to the <code>parse()</code> method, which is expected to parse it and
return an attribute hash.</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_addTarget" class="method item inherited">
<h3 class="name"><code>addTarget</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_addTarget">EventTarget</a>:
<a href="../files/event-custom_js_event-facade.js.html#l455"><code>event-custom/js/event-facade.js:455</code></a>
</p>
</div>
<div class="description">
<p>Registers another EventTarget as a bubble target. Bubble order
is determined by the order registered. Multiple targets can
be specified.</p>
<p>Events can only bubble if emitFacade is true.</p>
<p>Included in the event-custom-complex submodule.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
<div class="param-description">
<p>the target to add</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_after" class="method item inherited">
<h3 class="name"><code>after</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
<li class="arg">
<code>fn</code>
</li>
<li class="arg">
<code class="optional">[context]</code>
</li>
<li class="arg">
<code class="optional">[arg*]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_after">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l833"><code>event-custom/js/event-target.js:833</code></a>
</p>
</div>
<div class="description">
<p>Subscribe to a custom event hosted by this object. The
supplied callback will execute after any listeners add
via the subscribe method, and after the default function,
if configured for the event, has executed.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the event</p>
</div>
</li>
<li class="param">
<code class="param-name">fn</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>The callback to execute in response to the event</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[context]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Override <code>this</code> object in callback</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[arg*]</code>
<span class="type">Any</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>0..n additional arguments to supply to the subscriber</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
A subscription handle capable of detaching the
subscription
</div>
</div>
</div>
<div id="method_ancestor" class="method item inherited">
<h3 class="name"><code>ancestor</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>depth</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_ancestor">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l279"><code>widget-child/js/Widget-Child.js:279</code></a>
</p>
</div>
<div class="description">
<p>Returns the Widget instance at the specified depth.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">depth</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>Number representing the depth of the ancestor.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:
Widget instance.
</div>
</div>
</div>
<div id="method_attrAdded" class="method item inherited">
<h3 class="name"><code>attrAdded</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method_attrAdded">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l341"><code>attribute/js/AttributeCore.js:341</code></a>
</p>
</div>
<div class="description">
<p>Checks if the given attribute has been added to the host</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute to check.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
true if an attribute with the given name has been added, false if it hasn't.
This method will return true for lazily added attributes.
</div>
</div>
</div>
<div id="method_before" class="method item inherited">
<h3 class="name"><code>before</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_before">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l870"><code>event-custom/js/event-target.js:870</code></a>
</p>
</div>
<div class="description">
<p>Executes the callback before a DOM event, custom event
or method. If the first argument is a function, it
is assumed the target is a method. For DOM and custom
events, this is an alias for Y.on.</p>
<p>For DOM and custom events:
type, callback, context, 0-n arguments</p>
<p>For methods:
callback, object (method host), methodName, context, 0-n arguments</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
detach handle
</div>
</div>
</div>
<div id="method_bindUI" class="method item protected inherited">
<h3 class="name"><code>bindUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_bindUI">
Widget
</a>
but overwritten in
<a href="../files/datatable_js_base.js.html#l319"><code>datatable/js/base.js:319</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Attaches subscriptions to relay core change events to the view.</p>
</div>
</div>
<div id="method_blur" class="method item inherited">
<h3 class="name"><code>blur</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_blur">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l673"><code>widget/js/Widget.js:673</code></a>
</p>
</div>
<div class="description">
<p>Causes the Widget to lose focus by setting the "focused" attribute
to "false"</p>
</div>
</div>
<div id="method_bubble" class="method item inherited">
<h3 class="name"><code>bubble</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>evt</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_bubble">EventTarget</a>:
<a href="../files/event-custom_js_event-facade.js.html#l507"><code>event-custom/js/event-facade.js:507</code></a>
</p>
</div>
<div class="description">
<p>Propagate an event. Requires the event-custom-complex module.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">evt</code>
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
<div class="param-description">
<p>the custom event to propagate</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
the aggregated return value from Event.Custom.fire
</div>
</div>
</div>
<div id="method_delegate" class="method item inherited">
<h3 class="name"><code>delegate</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
<li class="arg">
<code>fn</code>
</li>
<li class="arg">
<code>spec</code>
</li>
<li class="arg">
<code>context</code>
</li>
<li class="arg">
<code>args</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#method_delegate">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l219"><code>datatable/js/base.js:219</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Pass through to <code>delegate()</code> called from the <code>contentBox</code>.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>the event type to delegate</p>
</div>
</li>
<li class="param">
<code class="param-name">fn</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>the callback function to execute. This function
will be provided the event object for the delegated event.</p>
</div>
</li>
<li class="param">
<code class="param-name">spec</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>a selector that must match the target of the
event or a function to test target and its parents for a match</p>
</div>
</li>
<li class="param">
<code class="param-name">context</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>optional argument that specifies what 'this' refers to</p>
</div>
</li>
<li class="param">
<code class="param-name">args</code>
<span class="type">Any</span>
<span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
<div class="param-description">
<p>0..n additional arguments to pass on to the callback
function. These arguments will be added after the event object.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
the detach handle
</div>
</div>
</div>
<div id="method_destroy" class="method item inherited">
<h3 class="name"><code>destroy</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>destroyAllNodes</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseObservable.html#method_destroy">
BaseObservable
</a>
but overwritten in
<a href="../files/widget_js_Widget.js.html#l452"><code>widget/js/Widget.js:452</code></a>
</p>
</div>
<div class="description">
<p>
Destroy lifecycle method. Fires the destroy
event, prior to invoking destructors for the
class hierarchy.
Overrides Base's implementation, to support arguments to destroy
</p>
<p>
Subscribers to the destroy
event can invoke preventDefault on the event object, to prevent destruction
from proceeding.
</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">destroyAllNodes</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>If true, all nodes contained within the Widget are
removed and destroyed. Defaults to false due to potentially high run-time cost.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:
A reference to this object
</div>
</div>
</div>
<div id="method_destructor" class="method item protected">
<h3 class="name"><code>destructor</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l588"><code>datatable/js/scroll.js:588</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Cleans up external event subscriptions.</p>
</div>
</div>
<div id="method_destructor" class="method item protected">
<h3 class="name"><code>destructor</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_destructor">
Widget
</a>
but overwritten in
<a href="../files/datatable_js_core.js.html#l420"><code>datatable/js/core.js:420</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Tears down the instance.</p>
</div>
</div>
<div id="method_detach" class="method item inherited">
<h3 class="name"><code>detach</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
<li class="arg">
<code>fn</code>
</li>
<li class="arg">
<code>context</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_detach">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l346"><code>event-custom/js/event-target.js:346</code></a>
</p>
</div>
<div class="description">
<p>Detach one or more listeners the from the specified event</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Either the handle to the subscriber or the
type of event. If the type
is not specified, it will attempt to remove
the listener from all hosted events.</p>
</div>
</li>
<li class="param">
<code class="param-name">fn</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>The subscribed function to unsubscribe, if not
supplied, all subscribers will be removed.</p>
</div>
</li>
<li class="param">
<code class="param-name">context</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The custom object passed to subscribe. This is
optional, but if supplied will be used to
disambiguate multiple listeners that are the same
(e.g., you subscribe many object using a function
that lives on the prototype)</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:
the host
</div>
</div>
</div>
<div id="method_detachAll" class="method item inherited">
<h3 class="name"><code>detachAll</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_detachAll">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l469"><code>event-custom/js/event-target.js:469</code></a>
</p>
</div>
<div class="description">
<p>Removes all listeners from the specified event. If the event type
is not specified, all listeners from all hosted custom events will
be removed.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The type, or name of the event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_disable" class="method item inherited">
<h3 class="name"><code>disable</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_disable">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l692"><code>widget/js/Widget.js:692</code></a>
</p>
</div>
<div class="description">
<p>Set the Widget's "disabled" attribute to "true".</p>
</div>
</div>
<div id="method_enable" class="method item inherited">
<h3 class="name"><code>enable</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_enable">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l683"><code>widget/js/Widget.js:683</code></a>
</p>
</div>
<div class="description">
<p>Set the Widget's "disabled" attribute to "false".</p>
</div>
</div>
<div id="method_fire" class="method item inherited">
<h3 class="name"><code>fire</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
<li class="arg">
<code>arguments</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_fire">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l695"><code>event-custom/js/event-target.js:695</code></a>
</p>
</div>
<div class="description">
<p>Fire a custom event by name. The callback functions will be executed
from the context specified when the event was created, and with the
following parameters.</p>
<p>If the custom event object hasn't been created, then the event hasn't
been published and it has no subscribers. For performance sake, we
immediate exit in this case. This means the event won't bubble, so
if the intention is that a bubble target be notified, the event must
be published on this object first.</p>
<p>The first argument is the event type, and any additional arguments are
passed to the listeners as parameters. If the first of these is an
object literal, and the event is configured to emit an event facade,
that object is mixed into the event facade and the facade is provided
in place of the original object.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The type of the event, or an object that contains
a 'type' property.</p>
</div>
</li>
<li class="param">
<code class="param-name">arguments</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object*</a></span>
<div class="param-description">
<p>an arbitrary set of parameters to pass to
the handler. If the first of these is an object literal and the event is
configured to emit an event facade, the event facade will replace that
parameter after the properties the object literal contains are copied to
the event facade.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:
the event host
</div>
</div>
</div>
<div id="method_focus" class="method item inherited">
<h3 class="name"><code>focus</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_focus">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l663"><code>widget/js/Widget.js:663</code></a>
</p>
</div>
<div class="description">
<p>Causes the Widget to receive the focus by setting the "focused"
attribute to "true".</p>
</div>
</div>
<div id="method_get" class="method item inherited">
<h3 class="name"><code>get</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Any</span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method_get">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l353"><code>attribute/js/AttributeCore.js:353</code></a>
</p>
</div>
<div class="description">
<p>Returns the current value of the attribute. If the attribute
has been configured with a 'getter' function, this method will delegate
to the 'getter' to obtain the value of the attribute.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute. If the value of the attribute is an Object,
dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Any</span>:
The value of the attribute
</div>
</div>
</div>
<div id="method_getAttrs" class="method item inherited">
<h3 class="name"><code>getAttrs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attrs</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeCore.html#method_getAttrs">AttributeCore</a>:
<a href="../files/attribute_js_AttributeCore.js.html#l762"><code>attribute/js/AttributeCore.js:762</code></a>
</p>
</div>
<div class="description">
<p>Gets multiple attribute values.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">attrs</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span>
<div class="param-description">
<p>Optional. An array of attribute names. If omitted, all attribute values are
returned. If set to true, all attributes modified from their initial values are returned.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
An object with attribute name/value pairs.
</div>
</div>
</div>
<div id="method_getCell" class="method item inherited">
<h3 class="name"><code>getCell</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>seed</code>
</li>
<li class="arg">
<code class="optional">[shift]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#method_getCell">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l253"><code>datatable/js/base.js:253</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Returns the <code><td></code> Node from the given row and column index. Alternately,
the <code>seed</code> can be a Node. If so, the nearest ancestor cell is returned.
If the <code>seed</code> is a cell, it is returned. If there is no cell at the given
coordinates, <code>null</code> is returned.</p>
<p>Optionally, include an offset array or string to return a cell near the
cell identified by the <code>seed</code>. The offset can be an array containing the
number of rows to shift followed by the number of columns to shift, or one
of "above", "below", "next", or "previous".</p>
<p><pre class="code prettyprint"><code>// Previous cell in the previous row
var cell = table.getCell(e.target, [-1, -1]);</p>
<p>// Next cell
var cell = table.getCell(e.target, 'next');
var cell = table.getCell(e.taregt, [0, 1];</pre></code></p>
<p>This is actually just a pass through to the <code>view</code> instance's method
by the same name.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">seed</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number[]</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>Array of row and column indexes, or a Node that
is either the cell itself or a descendant of one.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[shift]</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Offset by which to identify the returned
cell Node</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
</div>
</div>
</div>
<div id="method_getClassName" class="method item inherited">
<h3 class="name"><code>getClassName</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>args</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_getClassName">
Widget
</a>
but overwritten in
<a href="../files/widget_js_Widget.js.html#l309"><code>widget/js/Widget.js:309</code></a>
</p>
</div>
<div class="description">
<p>Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined
by the <code>Y.config.classNamePrefix</code> attribute used by <code>ClassNameManager</code> and
<code>Widget.NAME.toLowerCase()</code> (e.g. "yui-widget-xxxxx-yyyyy", based on default values for
the prefix and widget class name).</p>
<p>
The instance based version of this method can be used to generate standard prefixed classnames,
based on the instances NAME, as opposed to Widget.NAME. This method should be used when you
need to use a constant class name across different types instances.
</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">args</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String*</a></span>
<span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
<div class="param-description">
<p>0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_getColumn" class="method item">
<h3 class="name"><code>getColumn</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l213"><code>datatable/js/core.js:213</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Gets the column configuration object for the given key, name, or index. For
nested columns, <code>name</code> can be an array of indexes, each identifying the index
of that column in the respective parent's "children" array.</p>
<p>If you pass a column object, it will be returned.</p>
<p>For columns with keys, you can also fetch the column with
<code>instance.get('columns.foo')</code>.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span>
<div class="param-description">
<p>Key, "name", index, or index array to
identify the column</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
the column configuration object
</div>
</div>
</div>
<div id="method_getDefaultLocale" class="method item inherited">
<h3 class="name"><code>getDefaultLocale</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_getDefaultLocale">Widget</a>:
<a href="../files/widget_js_WidgetLocale.js.html#l153"><code>widget/js/WidgetLocale.js:153</code></a>
</p>
</div>
<div class="description">
<p>Returns the default locale for the widget (the locale value defined by the
widget class, or provided by the user during construction).</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
The default locale for the widget
</div>
</div>
</div>
<div id="method_getEvent" class="method item inherited">
<h3 class="name"><code>getEvent</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
<li class="arg">
<code>prefixed</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l814"><code>event-custom/js/event-target.js:814</code></a>
</p>
</div>
<div class="description">
<p>Returns the custom event of the provided type has been created, a
falsy value otherwise</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>the type, or name of the event</p>
</div>
</li>
<li class="param">
<code class="param-name">prefixed</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>if true, the type is prefixed already</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
the custom event or null
</div>
</div>
</div>
<div id="method_getRecord" class="method item">
<h3 class="name"><code>getRecord</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>seed</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>
</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l262"><code>datatable/js/core.js:262</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Returns the Model associated to the record <code>id</code>, <code>clientId</code>, or index (not
row index). If none of those yield a Model from the <code>data</code> ModelList, the
arguments will be passed to the <code>view</code> instance's <code>getRecord</code> method
if it has one.</p>
<p>If no Model can be found, <code>null</code> is returned.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">seed</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>Record <code>id</code>, <code>clientId</code>, index, Node, or
identifier for a row or child element</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Model.html" class="crosslink">Model</a></span>:
</div>
</div>
</div>
<div id="method_getRow" class="method item inherited">
<h3 class="name"><code>getRow</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#method_getRow">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l287"><code>datatable/js/base.js:287</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Returns the <code><tr></code> Node from the given row index, Model, or Model's
<code>clientId</code>. If the rows haven't been rendered yet, or if the row can't be
found by the input, <code>null</code> is returned.</p>
<p>This is actually just a pass through to the <code>view</code> instance's method
by the same name.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Model.html" class="crosslink">Model</a></span>
<div class="param-description">
<p>Row index, Model instance, or clientId</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
</div>
</div>
</div>
<div id="method_getSkinName" class="method item inherited">
<h3 class="name"><code>getSkinName</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[skinPrefix]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_getSkinName">Widget</a>:
<a href="../files/widget_js_WidgetSkin.js.html#l12"><code>widget/js/WidgetSkin.js:12</code></a>
</p>
</div>
<div class="description">
<p>Returns the name of the skin that's currently applied to the widget.</p>
<p>Searches up the Widget's ancestor axis for, by default, a class
yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.</p>
<p>This is only really useful after the widget's DOM structure is in the
document, either by render or by progressive enhancement.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[skinPrefix]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The prefix which the implementation uses for the skin
("yui3-skin-" is the default).</p>
<p>NOTE: skinPrefix will be used as part of a regular expression:</p>
<pre><code>new RegExp('\\b' + skinPrefix + '(\\S+)')
</code></pre>
<p>Although an unlikely use case, literal characters which may result in an invalid
regular expression should be escaped.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
The name of the skin, or null, if a matching skin class is not found.
</div>
</div>
</div>
<div id="method_getString" class="method item deprecated inherited">
<h3 class="name"><code>getString</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>key</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 deprecated" title="Used by deprecated WidgetLocale implementations.">deprecated</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_getString">
Widget
</a>
but overwritten in
<a href="../files/widget_js_Widget.js.html#l1225"><code>widget/js/Widget.js:1225</code></a>
</p>
<p>Deprecated: Used by deprecated WidgetLocale implementations.</p>
</div>
<div class="description">
<p>Helper method to get a specific string value</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">key</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>:
The string
</div>
</div>
</div>
<div id="method_getStrings" class="method item deprecated inherited">
<h3 class="name"><code>getStrings</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>key</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 deprecated" title="Used by deprecated WidgetLocale implementations.">deprecated</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_getStrings">
Widget
</a>
but overwritten in
<a href="../files/widget_js_Widget.js.html#l1237"><code>widget/js/Widget.js:1237</code></a>
</p>
<p>Deprecated: Used by deprecated WidgetLocale implementations.</p>
</div>
<div class="description">
<p>Helper method to get the complete set of strings for the widget</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">key</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>:
The strings
</div>
</div>
</div>
<div id="method_getTargets" class="method item inherited">
<h3 class="name"><code>getTargets</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>:
<a href="../files/event-custom_js_event-facade.js.html#l479"><code>event-custom/js/event-facade.js:479</code></a>
</p>
</div>
<div class="description">
<p>Returns an array of bubble targets for this object.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
EventTarget[]
</div>
</div>
</div>
<div id="method_hide" class="method item inherited">
<h3 class="name"><code>hide</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_hide">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l645"><code>widget/js/Widget.js:645</code></a>
</p>
</div>
<div class="description">
<p>Hides the Widget by setting the "visible" attribute to "false".</p>
</div>
</div>
<div id="method_hideMessage" class="method item">
<h3 class="name"><code>hideMessage</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l56"><code>datatable/js/message.js:56</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Hides the message node.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_init" class="method item inherited">
<h3 class="name"><code>init</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cfg</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseObservable.html#method_init">
BaseObservable
</a>
but overwritten in
<a href="../files/base_js_BaseCore.js.html#l264"><code>base/js/BaseCore.js:264</code></a>
</p>
</div>
<div class="description">
<p>Init lifecycle method, invoked during construction. Sets up attributes
and invokes initializers for the class hierarchy.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cfg</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Object with configuration property name/value pairs</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span>:
A reference to this object
</div>
</div>
</div>
<div id="method_initializer" class="method item protected">
<h3 class="name"><code>initializer</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l530"><code>datatable/js/mutable.js:530</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Publishes the events used by the mutation methods:</p>
<ul>
<li>addColumn</li>
<li>removeColumn</li>
<li>modifyColumn</li>
<li>moveColumn</li>
</ul>
</div>
</div>
<div id="method_initializer" class="method item protected">
<h3 class="name"><code>initializer</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l597"><code>datatable/js/core.js:597</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Initializes the columns, <code>recordType</code> and data ModelList.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object passed to constructor</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_initializer" class="method item protected">
<h3 class="name"><code>initializer</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l442"><code>datatable/js/sort.js:442</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Sets up the initial sort state and instance properties. Publishes events
and subscribes to attribute change events to maintain internal state.</p>
</div>
</div>
<div id="method_initializer" class="method item protected">
<h3 class="name"><code>initializer</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l184"><code>datatable/js/message.js:184</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Merges in the message related strings and hooks into the rendering cycle to
also render and bind the message node.</p>
</div>
</div>
<div id="method_initializer" class="method item protected">
<h3 class="name"><code>initializer</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_initializer">
Widget
</a>
but overwritten in
<a href="../files/datatable_js_colwidths.js.html#l186"><code>datatable/js/colwidths.js:186</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Hooks up to the rendering lifecycle to also render the <code><colgroup></code> and
subscribe to <code>columnChange</code> events.</p>
</div>
</div>
<div id="method_initializer" class="method item protected">
<h3 class="name"><code>initializer</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l601"><code>datatable/js/scroll.js:601</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Sets up event handlers and AOP advice methods to bind the DataTable's natural
behaviors with the scrolling APIs and state.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The config object passed to the constructor (ignored)</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_isRoot" class="method item inherited">
<h3 class="name"><code>isRoot</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_isRoot">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l267"><code>widget-child/js/Widget-Child.js:267</code></a>
</p>
</div>
<div class="description">
<p>Determines if the Widget is the root Widget in the
object hierarchy.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
Boolean indicating if Widget is the root Widget in the
object hierarchy.
</div>
</div>
</div>
<div id="method_modifyAttr" class="method item inherited">
<h3 class="name"><code>modifyAttr</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>:
<a href="../files/attribute_js_AttributeExtras.js.html#l40"><code>attribute/js/AttributeExtras.js:40</code></a>
</p>
</div>
<div class="description">
<p>Updates the configuration of an attribute which has already been added.</p>
<p>
The properties which can be modified through this interface are limited
to the following subset of attributes, which can be safely modified
after a value has already been set on the attribute: readOnly, writeOnce,
broadcast and getter.
</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute whose configuration is to be updated.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_modifyColumn" class="method item">
<h3 class="name"><code>modifyColumn</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l114"><code>datatable/js/mutable.js:114</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Updates an existing column definition. Fires the <code>modifyColumn</code> event.</p>
<p>For example:</p>
<pre class="code prettyprint"><code>// Add a formatter to the existing 'price' column definition
table.modifyColumn('price', { formatter: currencyFormatter });
// Change the label on a header cell in a set of nested headers three rows
// deep. The index array translates to
// [ 2, -- in the third column's children
// 1, -- the second child
// 3 ] -- the fourth child column
table.modifyColumn([2, 1, 3], { label: 'Experience' });
</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The column key, name, index, or
current configuration object</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The new column configuration properties</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_modifyRow" class="method item">
<h3 class="name"><code>modifyRow</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code>data</code>
</li>
<li class="arg">
<code class="optional">[config]</code>
</li>
<li class="arg">
<code class="optional">[callback]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l329"><code>datatable/js/mutable.js:329</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Updates an existing record in the DataTable's <code>data</code> ModelList. The record
can be provided explicitly or targeted by it's <code>id</code> (see ModelList's
<code>getById</code> method), <code>clientId</code>, or index in the ModelList.</p>
<p>After locating the target Model, this relays the all other passed
arguments to the Model's <code>setAttrs</code> method.</p>
<p>If a configuration object is passed as a second argument, and that object
has <code>sync: true</code> set, the underlying Model will be <code>save()</code>d.</p>
<p>If the DataTable's <code>autoSync</code> attribute is set to <code>true</code>, the additional
argument is not needed.</p>
<p>If syncing and the last argument is a function, that function will be used
as a callback to the Model's <code>save()</code> method.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The Model instance or identifier</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>New data values for the Model</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[config]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Configuration to pass along to <code>setAttrs()</code></p>
</div>
</li>
<li class="param">
<code class="param-name optional">[callback]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Callback function for Model's <code>save()</code></p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">err</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span>
<div class="param-description">
<p>If an error occurred or validation
failed, this parameter will contain the error. If the sync operation
succeeded, <em>err</em> will be <code>null</code>.</p>
</div>
</li>
<li class="param">
<code class="param-name">response</code>
<span class="type">Any</span>
<div class="param-description">
<p>The server's response. This value will
be passed to the <code>parse()</code> method, which is expected to parse it and
return an attribute hash.</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_moveColumn" class="method item">
<h3 class="name"><code>moveColumn</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>index</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l153"><code>datatable/js/mutable.js:153</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Moves an existing column to a new location. Fires the <code>moveColumn</code> event.</p>
<p>The destination index can be a number or array of numbers to place a column
header in a nested header row.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The column key, name, index, or
current configuration object</p>
</div>
</li>
<li class="param">
<code class="param-name">index</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span>
<div class="param-description">
<p>The destination index of the column</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_next" class="method item inherited">
<h3 class="name"><code>next</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>circular</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_next">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l191"><code>widget-child/js/Widget-Child.js:191</code></a>
</p>
</div>
<div class="description">
<p>Returns the Widget's next sibling.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">circular</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>Boolean indicating if the parent's first child
should be returned if the child has no next sibling.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:
Widget instance.
</div>
</div>
</div>
<div id="method_on" class="method item inherited">
<h3 class="name"><code>on</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
<li class="arg">
<code>fn</code>
</li>
<li class="arg">
<code class="optional">[context]</code>
</li>
<li class="arg">
<code class="optional">[arg*]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_on">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l188"><code>event-custom/js/event-target.js:188</code></a>
</p>
</div>
<div class="description">
<p>Subscribe a callback function to a custom event fired by this object or
from an object that bubbles its events to this object.</p>
<p>Callback functions for events published with <code>emitFacade = true</code> will
receive an <code>EventFacade</code> as the first argument (typically named "e").
These callbacks can then call <code>e.preventDefault()</code> to disable the
behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code>
API for all available properties and methods. Subscribers to
non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code>
after the event name.</p>
<p>To subscribe to multiple events at once, pass an object as the first
argument, where the key:value pairs correspond to the eventName:callback,
or pass an array of event names as the first argument to subscribe to
all listed events with the same callback.</p>
<p>Returning <code>false</code> from a callback is supported as an alternative to
calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is
recommended to use the event methods whenever possible.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the event</p>
</div>
</li>
<li class="param">
<code class="param-name">fn</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>The callback to execute in response to the event</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[context]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Override <code>this</code> object in callback</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[arg*]</code>
<span class="type">Any</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>0..n additional arguments to supply to the subscriber</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
A subscription handle capable of detaching that
subscription
</div>
</div>
</div>
<div id="method_once" class="method item inherited">
<h3 class="name"><code>once</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
<li class="arg">
<code>fn</code>
</li>
<li class="arg">
<code class="optional">[context]</code>
</li>
<li class="arg">
<code class="optional">[arg*]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_once">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l124"><code>event-custom/js/event-target.js:124</code></a>
</p>
</div>
<div class="description">
<p>Listen to a custom event hosted by this object one time.
This is the equivalent to <code>on</code> except the
listener is immediatelly detached when it is executed.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the event</p>
</div>
</li>
<li class="param">
<code class="param-name">fn</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>The callback to execute in response to the event</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[context]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Override <code>this</code> object in callback</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[arg*]</code>
<span class="type">Any</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>0..n additional arguments to supply to the subscriber</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
A subscription handle capable of detaching the
subscription
</div>
</div>
</div>
<div id="method_onceAfter" class="method item inherited">
<h3 class="name"><code>onceAfter</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
<li class="arg">
<code>fn</code>
</li>
<li class="arg">
<code class="optional">[context]</code>
</li>
<li class="arg">
<code class="optional">[arg*]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l146"><code>event-custom/js/event-target.js:146</code></a>
</p>
</div>
<div class="description">
<p>Listen to a custom event hosted by this object one time.
This is the equivalent to <code>after</code> except the
listener is immediatelly detached when it is executed.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the event</p>
</div>
</li>
<li class="param">
<code class="param-name">fn</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>The callback to execute in response to the event</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[context]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Override <code>this</code> object in callback</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[arg*]</code>
<span class="type">Any</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>0..n additional arguments to supply to the subscriber</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
A subscription handle capable of detaching that
subscription
</div>
</div>
</div>
<div id="method_parseType" class="method item inherited">
<h3 class="name"><code>parseType</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
<li class="arg">
<code class="optional">[pre=this._yuievt.config.prefix]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_parseType">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l168"><code>event-custom/js/event-target.js:168</code></a>
</p>
<p>Available since 3.3.0</p>
</div>
<div class="description">
<p>Takes the type parameter passed to 'on' and parses out the
various pieces that could be included in the type. If the
event type is passed without a prefix, it will be expanded
to include the prefix one is supplied or the event target
is configured with a default prefix.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>the type</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[pre=this._yuievt.config.prefix]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>the prefix</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
an array containing:
* the detach category, if supplied,
* the prefixed event type,
* whether or not this is an after listener,
* the supplied event type
</div>
</div>
</div>
<div id="method_previous" class="method item inherited">
<h3 class="name"><code>previous</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>circular</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_previous">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l216"><code>widget-child/js/Widget-Child.js:216</code></a>
</p>
</div>
<div class="description">
<p>Returns the Widget's previous sibling.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">circular</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p>Boolean indicating if the parent's last child
should be returned if the child has no previous sibling.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:
Widget instance.
</div>
</div>
</div>
<div id="method_publish" class="method item inherited">
<h3 class="name"><code>publish</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
<li class="arg">
<code>opts</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_publish">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l493"><code>event-custom/js/event-target.js:493</code></a>
</p>
</div>
<div class="description">
<p>Creates a new custom event of the specified type. If a custom event
by that name already exists, it will not be re-created. In either
case the custom event is returned.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>the type, or name of the event</p>
</div>
</li>
<li class="param">
<code class="param-name">opts</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>optional config params. Valid properties are:</p>
<p><ul>
<li>
'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)
</li>
<li>
'bubbles': whether or not this event bubbles (true)
Events can only bubble if emitFacade is true.
</li>
<li>
'context': the default execution context for the listeners (this)
</li>
<li>
'defaultFn': the default function to execute when this event fires if preventDefault was not called
</li>
<li>
'emitFacade': whether or not this event emits a facade (false)
</li>
<li>
'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
</li>
<li>
'fireOnce': if an event is configured to fire once, new subscribers after
the fire will be notified immediately.
</li>
<li>
'async': fireOnce event listeners will fire synchronously if the event has already
fired unless async is true.
</li>
<li>
'preventable': whether or not preventDefault() has an effect (true)
</li>
<li>
'preventedFn': a function that is executed when preventDefault is called
</li>
<li>
'queuable': whether or not this event can be queued during bubbling (false)
</li>
<li>
'silent': if silent is true, debug messages are not provided for this event.
</li>
<li>
'stoppedFn': a function that is executed when stopPropagation is called
</li></p>
<p><li>
'monitored': specifies whether or not this event should send notifications about
when the event has been attached, detached, or published.
</li>
<li>
'type': the event type (valid option if not provided as the first parameter to publish)
</li>
</ul></p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
the custom event
</div>
</div>
</div>
<div id="method_removeAttr" class="method item inherited">
<h3 class="name"><code>removeAttr</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:
<a href="../files/attribute_js_AttributeExtras.js.html#l79"><code>attribute/js/AttributeExtras.js:79</code></a>
</p>
</div>
<div class="description">
<p>Removes an attribute from the host object</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute to be removed.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_removeColumn" class="method item">
<h3 class="name"><code>removeColumn</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l178"><code>datatable/js/mutable.js:178</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes an existing column. Fires the <code>removeColumn</code> event.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The column key, name, index, or
current configuration object</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_removeRow" class="method item">
<h3 class="name"><code>removeRow</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code class="optional">[config]</code>
</li>
<li class="arg">
<code class="optional">[callback]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l255"><code>datatable/js/mutable.js:255</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes a record from the DataTable's <code>data</code> ModelList. The record can be
provided explicitly or targeted by it's <code>id</code> (see ModelList's <code>getById</code>
method), <code>clientId</code>, or index in the ModelList.</p>
<p>After locating the target Model, this relays the Model and all other passed
arguments to the <code>data</code> ModelList's <code>remove</code> method.</p>
<p>If a configuration object is passed as a second argument, and that object
has <code>sync: true</code> set, the underlying Model will be destroyed, passing
<code>{ delete: true }</code> to trigger calling the Model's sync layer.</p>
<p>If the DataTable's <code>autoSync</code> attribute is set to <code>true</code>, the additional
argument is not needed.</p>
<p>If syncing and the last argument is a function, that function will be used
as a callback to the Model's <code>destroy()</code> method.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The Model instance or identifier</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[config]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Configuration to pass along</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[callback]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Callback function for Model's <code>save()</code></p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">err</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span>
<div class="param-description">
<p>If an error occurred or validation
failed, this parameter will contain the error. If the sync operation
succeeded, <em>err</em> will be <code>null</code>.</p>
</div>
</li>
<li class="param">
<code class="param-name">response</code>
<span class="type">Any</span>
<div class="param-description">
<p>The server's response. This value will
be passed to the <code>parse()</code> method, which is expected to parse it and
return an attribute hash.</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_removeTarget" class="method item inherited">
<h3 class="name"><code>removeTarget</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:
<a href="../files/event-custom_js_event-facade.js.html#l489"><code>event-custom/js/event-facade.js:489</code></a>
</p>
</div>
<div class="description">
<p>Removes a bubble target</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
<div class="param-description">
<p>the target to remove</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_render" class="method item inherited">
<h3 class="name"><code>render</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>parentNode</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag final">final</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_render">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l513"><code>widget/js/Widget.js:513</code></a>
</p>
</div>
<div class="description">
<p>Establishes the initial DOM for the widget. Invoking this
method will lead to the creating of all DOM elements for
the widget (or the manipulation of existing DOM elements
for the progressive enhancement use case).</p>
<p>
This method should only be invoked once for an initialized
widget.
</p>
<p>
It delegates to the widget specific renderer method to do
the actual work.
</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">parentNode</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>Optional. The Node under which the
Widget is to be rendered. This can be a Node instance or a CSS selector string.</p>
<p>
If the selector string returns more than one Node, the first node will be used
as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox
are not currently in the document. If it's not provided, the Widget will be rendered
to the body of the current document in this case.
</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_renderer" class="method item protected inherited">
<h3 class="name"><code>renderer</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_renderer">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l588"><code>widget/js/Widget.js:588</code></a>
</p>
</div>
<div class="description">
<p>Creates DOM (or manipulates DOM for progressive enhancement)
This method is invoked by render() and is not chained
automatically for the class hierarchy (unlike initializer, destructor)
so it should be chained manually for subclasses if required.</p>
</div>
</div>
<div id="method_renderUI" class="method item protected inherited">
<h3 class="name"><code>renderUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_renderUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l622"><code>widget/js/Widget.js:622</code></a>
</p>
</div>
<div class="description">
<p>Adds nodes to the DOM</p>
<p>This method is not called by framework and is not chained
automatically for the class hierarchy.</p>
</div>
</div>
<div id="method_reset" class="method item inherited">
<h3 class="name"><code>reset</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</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 chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:
<a href="../files/attribute_js_AttributeExtras.js.html#l89"><code>attribute/js/AttributeExtras.js:89</code></a>
</p>
</div>
<div class="description">
<p>Resets the attribute (or all attributes) to its initial value, as long as
the attribute is not readOnly, or writeOnce.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
A reference to the host object.
</div>
</div>
</div>
<div id="method_scrollTo" class="method item">
<h3 class="name"><code>scrollTo</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l79"><code>datatable/js/scroll.js:79</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Scrolls a given row or cell into view if the table is scrolling. Pass the
<code>clientId</code> of a Model from the DataTable's <code>data</code> ModelList or its row
index to scroll to a row or a [row index, column index] array to scroll to
a cell. Alternately, to scroll to any element contained within the table's
scrolling areas, pass its ID, or the Node itself (though you could just as
well call <code>node.scrollIntoView()</code> yourself, but hey, whatever).</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>A row clientId, row index, cell
coordinate array, id string, or Node</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_set" class="method item inherited">
<h3 class="name"><code>set</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>value</code>
</li>
<li class="arg">
<code class="optional">[opts]</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 chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeObservable.html#method_set">
AttributeObservable
</a>
but overwritten in
<a href="../files/attribute_js_AttributeCore.js.html#l410"><code>attribute/js/AttributeCore.js:410</code></a>
</p>
</div>
<div class="description">
<p>Sets the value of an attribute.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The name of the attribute. If the
current value of the attribute is an Object, dot notation can be used
to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>
</div>
</li>
<li class="param">
<code class="param-name">value</code>
<span class="type">Any</span>
<div class="param-description">
<p>The value to set the attribute to.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[opts]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Optional data providing the circumstances for the change.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
A reference to the host object.
</div>
</div>
</div>
<div id="method_setAttrs" class="method item inherited">
<h3 class="name"><code>setAttrs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>attrs</code>
</li>
<li class="arg">
<code class="optional">[opts]</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 chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/AttributeObservable.html#method_setAttrs">
AttributeObservable
</a>
but overwritten in
<a href="../files/attribute_js_AttributeCore.js.html#l729"><code>attribute/js/AttributeCore.js:729</code></a>
</p>
</div>
<div class="description">
<p>Sets multiple attribute values.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">attrs</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>An object with attributes name/value pairs.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[opts]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Optional data providing the circumstances for the change.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
A reference to the host object.
</div>
</div>
</div>
<div id="method_setColumnWidth" class="method item">
<h3 class="name"><code>setColumnWidth</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code>width</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-column-widths.html">datatable-column-widths</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_colwidths.js.html#l138"><code>datatable/js/colwidths.js:138</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Assigns the style width of the <code><col></code> representing the column identifed by
<code>id</code> and updates the column configuration.</p>
<p>Pass the empty string for <code>width</code> to return a column to auto sizing.</p>
<p>This does not trigger a <code>columnsChange</code> event today, but I can be convinced
that it should.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The column config object or key, name, or
index of a column in the host's <code>_displayColumns</code> array.</p>
</div>
</li>
<li class="param">
<code class="param-name">width</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>CSS width value. Numbers are treated as pixels</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_show" class="method item inherited">
<h3 class="name"><code>show</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_show">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l654"><code>widget/js/Widget.js:654</code></a>
</p>
</div>
<div class="description">
<p>Shows the Widget by setting the "visible" attribute to "true".</p>
</div>
</div>
<div id="method_showMessage" class="method item">
<h3 class="name"><code>showMessage</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>message</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l71"><code>datatable/js/message.js:71</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Display the message node and set its content to <code>message</code>. If there is a
localized <code>strings</code> entry for the value of <code>message</code>, that string will be
used.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">message</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The message name or message itself to display</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_sort" class="method item">
<h3 class="name"><code>sort</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>fields</code>
</li>
<li class="arg">
<code class="optional">[payload]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l173"><code>datatable/js/sort.js:173</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Sort the data in the <code>data</code> ModelList and refresh the table with the new
order.</p>
<p>Acceptable values for <code>fields</code> are <code>key</code> strings or objects with a single
property, the column <code>key</code>, with a value of 1, -1, "asc", or "desc". E.g.
<code>{ username: 'asc' }</code>. String values are assumed to be ascending.</p>
<p>Example values would be:</p>
<ul>
<li><code>"username"</code> - sort by the data's <code>username</code> field or the <code>key</code>
associated to a column with that <code>name</code>.</li>
<li><code>{ username: "desc" }</code> - sort by <code>username</code> in descending order.
Alternately, use values "asc", 1 (same as "asc"), or -1 (same as "desc").</li>
<li><code>["lastName", "firstName"]</code> - ascending sort by <code>lastName</code>, but for
records with the same <code>lastName</code>, ascending subsort by <code>firstName</code>.
Array can have as many items as you want.</li>
<li><code>[{ lastName: -1 }, "firstName"]</code> - descending sort by <code>lastName</code>,
ascending subsort by <code>firstName</code>. Mixed types are ok.</li>
</ul>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">fields</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
<div class="param-description">
<p>The field(s) to sort by</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[payload]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Extra <code>sort</code> event payload you want to send along</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_subscribe" class="method item deprecated inherited">
<h3 class="name"><code>subscribe</code></h3>
<span class="paren">()</span>
<span class="flag deprecated" title="use on">deprecated</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l336"><code>event-custom/js/event-target.js:336</code></a>
</p>
<p>Deprecated: use on</p>
</div>
<div class="description">
<p>subscribe to an event</p>
</div>
</div>
<div id="method_syncUI" class="method item inherited">
<h3 class="name"><code>syncUI</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_syncUI">
Widget
</a>
but overwritten in
<a href="../files/datatable_js_base.js.html#l512"><code>datatable/js/base.js:512</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Fires the <code>renderView</code> event, delegating UI updates to the configured View.</p>
</div>
</div>
<div id="method_toggleSort" class="method item">
<h3 class="name"><code>toggleSort</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>fields</code>
</li>
<li class="arg">
<code class="optional">[payload]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l229"><code>datatable/js/sort.js:229</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Reverse the current sort direction of one or more fields currently being
sorted by.</p>
<p>Pass the <code>key</code> of the column or columns you want the sort order reversed
for.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">fields</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span>
<div class="param-description">
<p>The field(s) to reverse sort order for</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[payload]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Extra <code>sort</code> event payload you want to send along</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>:
</div>
</div>
</div>
<div id="method_toString" class="method item inherited">
<h3 class="name"><code>toString</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#method_toString">
BaseCore
</a>
but overwritten in
<a href="../files/widget_js_Widget.js.html#l1107"><code>widget/js/Widget.js:1107</code></a>
</p>
</div>
<div class="description">
<p>Generic toString implementation for all widgets.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
The default string value for the widget [ displays the NAME of the instance, and the unique id ]
</div>
</div>
</div>
<div id="method_unsubscribe" class="method item deprecated inherited">
<h3 class="name"><code>unsubscribe</code></h3>
<span class="paren">()</span>
<span class="flag deprecated" title="use detach">deprecated</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l459"><code>event-custom/js/event-target.js:459</code></a>
</p>
<p>Deprecated: use detach</p>
</div>
<div class="description">
<p>detach a listener</p>
</div>
</div>
<div id="method_unsubscribeAll" class="method item deprecated inherited">
<h3 class="name"><code>unsubscribeAll</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag deprecated" title="use detachAll">deprecated</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:
<a href="../files/event-custom_js_event-target.js.html#l480"><code>event-custom/js/event-target.js:480</code></a>
</p>
<p>Deprecated: use detachAll</p>
</div>
<div class="description">
<p>Removes all listeners from the specified event. If the event type
is not specified, all listeners from all hosted custom events will
be removed.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The type, or name of the event</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property__allowAdHocAttrs" class="property item protected">
<h3 class="name"><code>_allowAdHocAttrs</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>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#property__allowAdHocAttrs">
BaseCore
</a>
but overwritten in
<a href="../files/datatable_js_core.js.html#l295"><code>datatable/js/core.js:295</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>This tells <code>Y.Base</code> that it should create ad-hoc attributes for config
properties passed to DataTable's constructor. This is useful for setting
configurations on the DataTable that are intended for the rendering View(s).</p>
</div>
<p><strong>Default:</strong> true</p>
</div>
<div id="property__CAPTION_TABLE_TEMPLATE" class="property item protected">
<h3 class="name"><code>_CAPTION_TABLE_TEMPLATE</code></h3>
<span class="type">HTML</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l122"><code>datatable/js/scroll.js:122</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Template for the <code><table></code> that is used to fix the caption in place when
the table is horizontally scrolling.</p>
</div>
</div>
<div id="property__columnMap" class="property item protected">
<h3 class="name"><code>_columnMap</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 protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l308"><code>datatable/js/core.js:308</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>A map of column key to column configuration objects parsed from the
<code>columns</code> attribute.</p>
</div>
<p><strong>Default:</strong> undefined (initially unset)</p>
</div>
<div id="property__displayColumns" class="property item inherited">
<h3 class="name"><code>_displayColumns</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#property__displayColumns">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l377"><code>datatable/js/base.js:377</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Array of the columns that correspond to those with value cells in the
data rows. Excludes colspan header columns (configured with <code>children</code>).</p>
</div>
</div>
<div id="property__messageNode" class="property item">
<h3 class="name"><code>_messageNode</code></h3>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l237"><code>datatable/js/message.js:237</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Node used to display messages from <code>showMessage</code>.</p>
</div>
</div>
<div id="property__SCROLL_LINER_TEMPLATE" class="property item protected">
<h3 class="name"><code>_SCROLL_LINER_TEMPLATE</code></h3>
<span class="type">HTML</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l134"><code>datatable/js/scroll.js:134</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Template used to create sizable element liners around header content to
synchronize fixed header column widths.</p>
</div>
</div>
<div id="property__SCROLLBAR_TEMPLATE" class="property item protected">
<h3 class="name"><code>_SCROLLBAR_TEMPLATE</code></h3>
<span class="type">HTML</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l146"><code>datatable/js/scroll.js:146</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Template for the virtual scrollbar needed in "y" and "xy" scrolling setups.</p>
</div>
</div>
<div id="property__sortable" class="property item protected">
<h3 class="name"><code>_sortable</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 protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l718"><code>datatable/js/sort.js:718</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Array of column configuration objects of those columns that need UI setup
for user interaction.</p>
</div>
</div>
<div id="property__sortBy" class="property item protected">
<h3 class="name"><code>_sortBy</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 protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l729"><code>datatable/js/sort.js:729</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Array of column configuration objects for those columns that are currently
being used to sort the data. Fake column objects are used for fields that
are not rendered as columns.</p>
</div>
</div>
<div id="property__tableNode" class="property item protected">
<h3 class="name"><code>_tableNode</code></h3>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l320"><code>datatable/js/core.js:320</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>The Node instance of the table containing the data rows. This is set when
the table is rendered. It may also be set by progressive enhancement,
though this extension does not provide the logic to parse from source.</p>
</div>
<p><strong>Default:</strong> undefined (initially unset)</p>
</div>
<div id="property__UI_ATTRS" class="property item private inherited">
<h3 class="name"><code>_UI_ATTRS</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#property__UI_ATTRS">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1249"><code>widget/js/Widget.js:1249</code></a>
</p>
</div>
<div class="description">
<p>The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations</p>
</div>
</div>
<div id="property__X_SCROLLER_TEMPLATE" class="property item protected">
<h3 class="name"><code>_X_SCROLLER_TEMPLATE</code></h3>
<span class="type">HTML</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l157"><code>datatable/js/scroll.js:157</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Template for the <code><div></code> that is used to contain the table when the table is
horizontally scrolling.</p>
</div>
</div>
<div id="property__xScroll" class="property item private">
<h3 class="name"><code>_xScroll</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>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l1324"><code>datatable/js/scroll.js:1324</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Indicates horizontal table scrolling is enabled.</p>
</div>
<p><strong>Default:</strong> undefined (not initially set)</p>
</div>
<div id="property__xScrollNode" class="property item protected">
<h3 class="name"><code>_xScrollNode</code></h3>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l1368"><code>datatable/js/scroll.js:1368</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Overflow Node used to contain the table headers and data in a horizontally
scrolling table.</p>
</div>
<p><strong>Default:</strong> undefined (not initially set)</p>
</div>
<div id="property__Y_SCROLL_HEADER_TEMPLATE" class="property item protected">
<h3 class="name"><code>_Y_SCROLL_HEADER_TEMPLATE</code></h3>
<span class="type">HTML</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l169"><code>datatable/js/scroll.js:169</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Template for the <code><table></code> used to contain the fixed column headers for
vertically scrolling tables.</p>
</div>
</div>
<div id="property__Y_SCROLLER_TEMPLATE" class="property item protected">
<h3 class="name"><code>_Y_SCROLLER_TEMPLATE</code></h3>
<span class="type">HTML</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l181"><code>datatable/js/scroll.js:181</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Template for the <code><div></code> that is used to contain the rows when the table is
vertically scrolling.</p>
</div>
</div>
<div id="property__yScroll" class="property item private">
<h3 class="name"><code>_yScroll</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>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l1335"><code>datatable/js/scroll.js:1335</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Indicates vertical table scrolling is enabled.</p>
</div>
<p><strong>Default:</strong> undefined (not initially set)</p>
</div>
<div id="property__yScrollHeader" class="property item protected">
<h3 class="name"><code>_yScrollHeader</code></h3>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l1346"><code>datatable/js/scroll.js:1346</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Fixed column header <code><table></code> Node for vertical scrolling tables.</p>
</div>
<p><strong>Default:</strong> undefined (not initially set)</p>
</div>
<div id="property__yScrollNode" class="property item protected">
<h3 class="name"><code>_yScrollNode</code></h3>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l1357"><code>datatable/js/scroll.js:1357</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Overflow Node used to contain the data rows in a vertically scrolling table.</p>
</div>
<p><strong>Default:</strong> undefined (not initially set)</p>
</div>
<div id="property_BOUNDING_TEMPLATE" class="property item inherited">
<h3 class="name"><code>BOUNDING_TEMPLATE</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>Inherited from
<a href="../classes/Widget.html#property_BOUNDING_TEMPLATE">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1145"><code>widget/js/Widget.js:1145</code></a>
</p>
</div>
<div class="description">
<p>Property defining the markup template for bounding box.</p>
</div>
</div>
<div id="property_COL_TEMPLATE" class="property item">
<h3 class="name"><code>COL_TEMPLATE</code></h3>
<span class="type">HTML</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-column-widths.html">datatable-column-widths</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_colwidths.js.html#l118"><code>datatable/js/colwidths.js:118</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>The HTML template used to create the table's <code><col></code>s.</p>
</div>
<p><strong>Default:</strong> '<col/>'</p>
</div>
<div id="property_COLGROUP_TEMPLATE" class="property item">
<h3 class="name"><code>COLGROUP_TEMPLATE</code></h3>
<span class="type">HTML</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-column-widths.html">datatable-column-widths</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_colwidths.js.html#l128"><code>datatable/js/colwidths.js:128</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>The HTML template used to create the table's <code><colgroup></code>.</p>
</div>
<p><strong>Default:</strong> '<colgroup/>'</p>
</div>
<div id="property_CONTENT_TEMPLATE" class="property item inherited">
<h3 class="name"><code>CONTENT_TEMPLATE</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>Inherited from
<a href="../classes/Widget.html#property_CONTENT_TEMPLATE">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1135"><code>widget/js/Widget.js:1135</code></a>
</p>
</div>
<div class="description">
<p>Property defining the markup template for content box. If your Widget doesn't
need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null,
and contentBox and boundingBox will both point to the same Node.</p>
</div>
</div>
<div id="property_data" class="property item">
<h3 class="name"><code>data</code></h3>
<span class="type"><a href="../classes/ModelList.html" class="crosslink">ModelList</a></span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l201"><code>datatable/js/core.js:201</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>The ModelList that manages the table's data.</p>
</div>
<p><strong>Default:</strong> undefined (initially unset)</p>
</div>
<div id="property_DEF_PARENT_NODE" class="property item inherited">
<h3 class="name"><code>DEF_PARENT_NODE</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#property_DEF_PARENT_NODE">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1126"><code>widget/js/Widget.js:1126</code></a>
</p>
</div>
<div class="description">
<p>Default node to render the bounding box to. If not set,
will default to the current document body.</p>
</div>
</div>
<div id="property_DEF_UNIT" class="property item inherited">
<h3 class="name"><code>DEF_UNIT</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>Inherited from
<a href="../classes/Widget.html#property_DEF_UNIT">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1118"><code>widget/js/Widget.js:1118</code></a>
</p>
</div>
<div class="description">
<p>Default unit to use for dimension values</p>
</div>
</div>
<div id="property_MESSAGE_TEMPLATE" class="property item">
<h3 class="name"><code>MESSAGE_TEMPLATE</code></h3>
<span class="type">HTML</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l46"><code>datatable/js/message.js:46</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Template used to generate the node that will be used to report messages.</p>
</div>
<p><strong>Default:</strong> <tbody class="{className}"><td class="{contentClass}" colspan="{colspan}"></td></tbody></p>
</div>
<div id="property_name" class="property item deprecated inherited">
<h3 class="name"><code>name</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>
<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#property_name">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l242"><code>base/js/BaseCore.js:242</code></a>
</p>
<p>Deprecated: Use this.constructor.NAME</p>
</div>
<div class="description">
<p>The string used to identify the class of this object.</p>
</div>
</div>
<div id="property_SORTABLE_HEADER_TEMPLATE" class="property item">
<h3 class="name"><code>SORTABLE_HEADER_TEMPLATE</code></h3>
<span class="type">HTML</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l218"><code>datatable/js/sort.js:218</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Template for the node that will wrap the header content for sortable
columns.</p>
</div>
</div>
<div id="property_UI_EVENTS" class="property item inherited">
<h3 class="name"><code>UI_EVENTS</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#property_UI_EVENTS">Widget</a>:
<a href="../files/widget_js_WidgetUIEvents.js.html#l52"><code>widget/js/WidgetUIEvents.js:52</code></a>
</p>
</div>
<div class="description">
<p>Map of DOM events that should be fired as Custom Events by the
Widget instance.</p>
</div>
</div>
</div>
<div id="attrs" class="api-class-tabpanel">
<h2 class="off-left">Attributes</h2>
<div id="attr_autoSync" class="attr item">
<a name="config_autoSync"></a>
<h3 class="name"><code>autoSync</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>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l40"><code>datatable/js/mutable.js:40</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Controls whether <code>addRow</code>, <code>removeRow</code>, and <code>modifyRow</code> should trigger the
underlying Model's sync layer by default.</p>
<p>When <code>true</code>, it is unnecessary to pass the "sync" configuration property to
those methods to trigger per-operation sync.</p>
</div>
<p><strong>Default:</strong> `false`</p>
<div class="emits box">
<h4>Fires event <code>autoSyncChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>autoSync</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_bodyConfig" class="attr item protected inherited">
<a name="config_bodyConfig"></a>
<h3 class="name"><code>bodyConfig</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 protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#attr_bodyConfig">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l662"><code>datatable/js/base.js:662</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Configuration object passed to the class constructor in <code>bodyView</code>
during render.</p>
</div>
<p><strong>Default:</strong> undefined (initially unset)</p>
<div class="emits box">
<h4>Fires event <code>bodyConfigChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>bodyConfig</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_bodyView" class="attr item inherited">
<a name="config_bodyView"></a>
<h3 class="name"><code>bodyView</code></h3>
<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="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#attr_bodyView">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l639"><code>datatable/js/base.js:639</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>If the View class assigned to the DataTable's <code>view</code> attribute supports
it, this class will be used for rendering the contents of the <code><tbody></code>
including all data rows.</p>
<p>Similar to <code>view</code>, the instance of this View will be assigned to the
DataTable instance's <code>body</code> property.</p>
<p>It is not strictly necessary that the class function assigned here be
a View subclass. It must however have a <code>render()</code> method.</p>
</div>
<p><strong>Default:</strong> Y.DataTable.BodyView</p>
<div class="emits box">
<h4>Fires event <code>bodyViewChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>bodyView</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_boundingBox" class="attr item inherited">
<a name="config_boundingBox"></a>
<h3 class="name"><code>boundingBox</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_boundingBox">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l175"><code>widget/js/Widget.js:175</code></a>
</p>
</div>
<div class="description">
<p>The outermost DOM node for the Widget, used for sizing and positioning
of a Widget as well as a containing element for any decorator elements used
for skinning.</p>
</div>
<div class="emits box">
<h4>Fires event <code>boundingBoxChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>boundingBox</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_caption" class="attr item">
<a name="config_caption"></a>
<h3 class="name"><code>caption</code></h3>
<span class="type">HTML</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l153"><code>datatable/js/core.js:153</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>HTML content of an optional <code><caption></code> element to appear above the table.
Leave this config unset or set to a falsy value to remove the caption.</p>
</div>
<p><strong>Default:</strong> '' (empty string)</p>
<div class="emits box">
<h4>Fires event <code>captionChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>caption</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_columns" class="attr item">
<a name="config_columns"></a>
<h3 class="name"><code>columns</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l39"><code>datatable/js/core.js:39</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Columns to include in the rendered table.</p>
<p>If omitted, the attributes on the configured <code>recordType</code> or the first item
in the <code>data</code> collection will be used as a source.</p>
<p>This attribute takes an array of strings or objects (mixing the two is
fine). Each string or object is considered a column to be rendered.
Strings are converted to objects, so <code>columns: ['first', 'last']</code> becomes
<code>columns: [{ key: 'first' }, { key: 'last' }]</code>.</p>
<p>DataTable.Core only concerns itself with a few properties of columns.
These properties are:</p>
<ul>
<li><code>key</code> - Used to identify the record field/attribute containing content for
this column. Also used to create a default Model if no <code>recordType</code> or
<code>data</code> are provided during construction. If <code>name</code> is not specified, this
is assigned to the <code>_id</code> property (with added incrementer if the key is
used by multiple columns).</li>
<li><code>children</code> - Traversed to initialize nested column objects</li>
<li><code>name</code> - Used in place of, or in addition to, the <code>key</code>. Useful for
columns that aren't bound to a field/attribute in the record data. This
is assigned to the <code>_id</code> property.</li>
<li><code>id</code> - For backward compatibility. Implementers can specify the id of
the header cell. This should be avoided, if possible, to avoid the
potential for creating DOM elements with duplicate IDs.</li>
<li><code>field</code> - For backward compatibility. Implementers should use <code>name</code>.</li>
<li><code>_id</code> - Assigned unique-within-this-instance id for a column. By order
of preference, assumes the value of <code>name</code>, <code>key</code>, <code>id</code>, or <code>_yuid</code>.
This is used by the rendering views as well as feature module
as a means to identify a specific column without ambiguity (such as
multiple columns using the same <code>key</code>.</li>
<li><code>_yuid</code> - Guid stamp assigned to the column object.</li>
<li><code>_parent</code> - Assigned to all child columns, referencing their parent
column.</li>
</ul>
</div>
<p><strong>Default:</strong> (from `recordType` ATTRS or first item in the `data`)</p>
<div class="emits box">
<h4>Fires event <code>columnsChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>columns</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_columnset" class="attr item deprecated">
<a name="config_columnset"></a>
<h3 class="name"><code>columnset</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 deprecated" title="Use the `columns` attribute">deprecated</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l181"><code>datatable/js/core.js:181</code></a>
</p>
<p>Deprecated: Use the `columns` attribute</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Deprecated as of 3.5.0. Passes through to the <code>columns</code> attribute.</p>
<p>WARNING: <code>get('columnset')</code> will NOT return a Columnset instance as of
3.5.0. This is a break in backward compatibility.</p>
</div>
<div class="emits box">
<h4>Fires event <code>columnsetChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>columnset</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_contentBox" class="attr item inherited">
<a name="config_contentBox"></a>
<h3 class="name"><code>contentBox</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_contentBox">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l189"><code>widget/js/Widget.js:189</code></a>
</p>
</div>
<div class="description">
<p>A DOM node that is a direct descendant of a Widget's bounding box that
houses its content.</p>
</div>
<div class="emits box">
<h4>Fires event <code>contentBoxChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>contentBox</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_data" class="attr item">
<a name="config_data"></a>
<h3 class="name"><code>data</code></h3>
<span class="type"><a href="../classes/ModelList.html" class="crosslink">ModelList</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l119"><code>datatable/js/core.js:119</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>The collection of data records to display. This attribute is a pass
through to a <code>data</code> property, which is a ModelList instance.</p>
<p>If this attribute is passed a ModelList or subclass, it will be assigned to
the property directly. If an array of objects is passed, a new ModelList
will be created using the configured <code>recordType</code> as its <code>model</code> property
and seeded with the array.</p>
<p>Retrieving this attribute will return the ModelList stored in the <code>data</code>
property.</p>
</div>
<p><strong>Default:</strong> `new ModelList()`</p>
<div class="emits box">
<h4>Fires event <code>dataChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>data</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_destroyed" class="attr item inherited">
<a name="config_destroyed"></a>
<h3 class="name"><code>destroyed</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>
<span class="flag readonly">readonly</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>
</p>
</div>
<div class="description">
<p>Flag indicating whether or not this object
has been through the destroy lifecycle phase.</p>
</div>
<p><strong>Default:</strong> false</p>
<div class="emits box">
<h4>Fires event <code>destroyedChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>destroyed</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_disabled" class="attr item inherited">
<a name="config_disabled"></a>
<h3 class="name"><code>disabled</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>Inherited from
<a href="../classes/Widget.html#attr_disabled">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l231"><code>widget/js/Widget.js:231</code></a>
</p>
</div>
<div class="description">
<p>Boolean indicating if the Widget should be disabled. The disabled implementation
is left to the specific classes extending widget.</p>
</div>
<p><strong>Default:</strong> false</p>
<div class="emits box">
<h4>Fires event <code>disabledChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>disabled</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_focused" class="attr item inherited">
<a name="config_focused"></a>
<h3 class="name"><code>focused</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>
<span class="flag readonly">readonly</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_focused">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l218"><code>widget/js/Widget.js:218</code></a>
</p>
</div>
<div class="description">
<p>Boolean indicating if the Widget, or one of its descendants,
has focus.</p>
</div>
<p><strong>Default:</strong> false</p>
<div class="emits box">
<h4>Fires event <code>focusedChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>focused</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_footerConfig" class="attr item protected inherited">
<a name="config_footerConfig"></a>
<h3 class="name"><code>footerConfig</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 protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#attr_footerConfig">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l627"><code>datatable/js/base.js:627</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Configuration object passed to the class constructor in <code>footerView</code>
during render.</p>
</div>
<p><strong>Default:</strong> undefined (initially unset)</p>
<div class="emits box">
<h4>Fires event <code>footerConfigChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>footerConfig</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_footerView" class="attr item inherited">
<a name="config_footerView"></a>
<h3 class="name"><code>footerView</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/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#attr_footerView">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l607"><code>datatable/js/base.js:607</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>If the View class assigned to the DataTable's <code>view</code> attribute supports
it, this class will be used for rendering the contents of the <code><tfoot></code>.</p>
<p>Similar to <code>view</code>, the instance of this View will be assigned to the
DataTable instance's <code>foot</code> property.</p>
<p>It is not strictly necessary that the class function assigned here be
a View subclass. It must however have a <code>render()</code> method.</p>
</div>
<div class="emits box">
<h4>Fires event <code>footerViewChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>footerView</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_headerConfig" class="attr item protected inherited">
<a name="config_headerConfig"></a>
<h3 class="name"><code>headerConfig</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 protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#attr_headerConfig">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l595"><code>datatable/js/base.js:595</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Configuration object passed to the class constructor in <code>headerView</code>
during render.</p>
</div>
<p><strong>Default:</strong> undefined (initially unset)</p>
<div class="emits box">
<h4>Fires event <code>headerConfigChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>headerConfig</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_headerView" class="attr item inherited">
<a name="config_headerView"></a>
<h3 class="name"><code>headerView</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/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#attr_headerView">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l572"><code>datatable/js/base.js:572</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>If the View class assigned to the DataTable's <code>view</code> attribute supports
it, this class will be used for rendering the contents of the
<code><thead></code>—the column headers for the table.</p>
<p>Similar to <code>view</code>, the instance of this View will be assigned to the
DataTable instance's <code>head</code> property.</p>
<p>It is not strictly necessary that the class function assigned here be
a View subclass. It must however have a <code>render()</code> method.</p>
</div>
<p><strong>Default:</strong> Y.DataTable.HeaderView</p>
<div class="emits box">
<h4>Fires event <code>headerViewChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>headerView</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_height" class="attr item inherited">
<a name="config_height"></a>
<h3 class="name"><code>height</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_height">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l252"><code>widget/js/Widget.js:252</code></a>
</p>
</div>
<div class="description">
<p>String with units, or number, representing the height of the Widget. If a number is provided,
the default unit, defined by the Widgets DEF_UNIT, property is used.</p>
</div>
<p><strong>Default:</strong> EMPTY_STR</p>
<div class="emits box">
<h4>Fires event <code>heightChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>height</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_id" class="attr item inherited">
<a name="config_id"></a>
<h3 class="name"><code>id</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>Inherited from
<a href="../classes/Widget.html#attr_id">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l149"><code>widget/js/Widget.js:149</code></a>
</p>
</div>
<div class="description">
</div>
<p><strong>Default:</strong> Generated using guid()</p>
<div class="emits box">
<h4>Fires event <code>idChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>id</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_initialized" class="attr item inherited">
<a name="config_initialized"></a>
<h3 class="name"><code>initialized</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>
<span class="flag readonly">readonly</span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:
<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>
</p>
</div>
<div class="description">
<p>Flag indicating whether or not this object
has been through the init lifecycle phase.</p>
</div>
<p><strong>Default:</strong> false</p>
<div class="emits box">
<h4>Fires event <code>initializedChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>initialized</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_locale" class="attr item deprecated inherited">
<a name="config_locale"></a>
<h3 class="name"><code>locale</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>
<span class="flag deprecated" title="Use Y.config.lang and Y.Intl externalization support">deprecated</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_locale">Widget</a>:
<a href="../files/widget_js_WidgetLocale.js.html#l17"><code>widget/js/WidgetLocale.js:17</code></a>
</p>
<p>Deprecated: Use Y.config.lang and Y.Intl externalization support</p>
</div>
<div class="description">
<p>The default locale for the widget. NOTE: Using get/set on the "strings" attribute will
return/set strings for this locale.</p>
</div>
<p><strong>Default:</strong> "en"</p>
<div class="emits box">
<h4>Fires event <code>localeChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>locale</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_recordset" class="attr item deprecated">
<a name="config_recordset"></a>
<h3 class="name"><code>recordset</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a> | <a href="../classes/Recordset.html" class="crosslink">Recordset</a></span>
<span class="flag deprecated" title="Use the `data` attribute">deprecated</span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l164"><code>datatable/js/core.js:164</code></a>
</p>
<p>Deprecated: Use the `data` attribute</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Deprecated as of 3.5.0. Passes through to the <code>data</code> attribute.</p>
<p>WARNING: <code>get('recordset')</code> will NOT return a Recordset instance as of
3.5.0. This is a break in backward compatibility.</p>
</div>
<div class="emits box">
<h4>Fires event <code>recordsetChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>recordset</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_recordType" class="attr item">
<a name="config_recordType"></a>
<h3 class="name"><code>recordType</code></h3>
<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="meta">
<p>Provided by the <a href="../modules/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l87"><code>datatable/js/core.js:87</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Model subclass to use as the <code>model</code> for the ModelList stored in the <code>data</code>
attribute.</p>
<p>If not provided, it will try really hard to figure out what to use. The
following attempts will be made to set a default value:</p>
<ol>
<li>If the <code>data</code> attribute is set with a ModelList instance and its <code>model</code>
property is set, that will be used.</li>
<li>If the <code>data</code> attribute is set with a ModelList instance, and its
<code>model</code> property is unset, but it is populated, the <code>ATTRS</code> of the
`constructor of the first item will be used.</li>
<li>If the <code>data</code> attribute is set with a non-empty array, a Model subclass
will be generated using the keys of the first item as its <code>ATTRS</code> (see
the <code>_createRecordClass</code> method).</li>
<li>If the <code>columns</code> attribute is set, a Model subclass will be generated
using the columns defined with a <code>key</code>. This is least desirable because
columns can be duplicated or nested in a way that's not parsable.</li>
<li>If neither <code>data</code> nor <code>columns</code> is set or populated, a change event
subscriber will listen for the first to be changed and try all over
again.</li>
</ol>
</div>
<p><strong>Default:</strong> (see description)</p>
<div class="emits box">
<h4>Fires event <code>recordTypeChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>recordType</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_render" class="attr item inherited">
<a name="config_render"></a>
<h3 class="name"><code>render</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_render">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l286"><code>widget/js/Widget.js:286</code></a>
</p>
</div>
<div class="description">
<p>Whether or not to render the widget automatically after init, and optionally, to which parent node.</p>
</div>
<div class="emits box">
<h4>Fires event <code>renderChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>render</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_rendered" class="attr item inherited">
<a name="config_rendered"></a>
<h3 class="name"><code>rendered</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>
<span class="flag readonly">readonly</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_rendered">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l161"><code>widget/js/Widget.js:161</code></a>
</p>
</div>
<div class="description">
<p>Flag indicating whether or not this Widget
has been through the render lifecycle phase.</p>
</div>
<p><strong>Default:</strong> false</p>
<div class="emits box">
<h4>Fires event <code>renderedChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>rendered</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_scrollable" class="attr item">
<a name="config_scrollable"></a>
<h3 class="name"><code>scrollable</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-scroll.html">datatable-scroll</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_scroll.js.html#l55"><code>datatable/js/scroll.js:55</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Activates or deactivates scrolling in the table. Acceptable values are:</p>
<ul>
<li><code>false</code> - (default) Scrolling is disabled.</li>
<li><code>true</code> or 'xy' - If <code>height</code> is set, vertical scrolling will be
activated, if <code>width</code> is set, horizontal scrolling will be activated.</li>
<li>'x' - Activate horizontal scrolling only. Requires the <code>width</code> attribute
is also set.</li>
<li>'y' - Activate vertical scrolling only. Requires the <code>height</code> attribute
is also set.</li>
</ul>
</div>
<div class="emits box">
<h4>Fires event <code>scrollableChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>scrollable</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_showMessages" class="attr item">
<a name="config_showMessages"></a>
<h3 class="name"><code>showMessages</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>Provided by the <a href="../modules/datatable-message.html">datatable-message</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_message.js.html#l29"><code>datatable/js/message.js:29</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Enables the display of messages in the table. Setting this to false will
prevent the message Node from being created and <code>showMessage</code> from doing
anything.</p>
</div>
<p><strong>Default:</strong> true</p>
<div class="emits box">
<h4>Fires event <code>showMessagesChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>showMessages</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_sortable" class="attr item">
<a name="config_sortable"></a>
<h3 class="name"><code>sortable</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l112"><code>datatable/js/sort.js:112</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Controls which column headers can trigger sorting by user clicks.</p>
<p>Acceptable values are:</p>
<ul>
<li>"auto" - (default) looks for <code>sortable: true</code> in the column configurations</li>
<li><code>true</code> - all columns are enabled</li>
<li>`false - no UI sortable is enabled</li>
<li>{String[]} - array of key names to give sortable headers</li>
</ul>
</div>
<p><strong>Default:</strong> "auto"</p>
<div class="emits box">
<h4>Fires event <code>sortableChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>sortable</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_sortBy" class="attr item">
<a name="config_sortBy"></a>
<h3 class="name"><code>sortBy</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l132"><code>datatable/js/sort.js:132</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>The current sort configuration to maintain in the data.</p>
<p>Accepts column <code>key</code> strings or objects with a single property, the column
<code>key</code>, with a value of 1, -1, "asc", or "desc". E.g. <code>{ username: 'asc'
}</code>. String values are assumed to be ascending.</p>
<p>Example values would be:</p>
<ul>
<li><code>"username"</code> - sort by the data's <code>username</code> field or the <code>key</code>
associated to a column with that <code>name</code>.</li>
<li><code>{ username: "desc" }</code> - sort by <code>username</code> in descending order.
Alternately, use values "asc", 1 (same as "asc"), or -1 (same as "desc").</li>
<li><code>["lastName", "firstName"]</code> - ascending sort by <code>lastName</code>, but for
records with the same <code>lastName</code>, ascending subsort by <code>firstName</code>.
Array can have as many items as you want.</li>
<li><code>[{ lastName: -1 }, "firstName"]</code> - descending sort by <code>lastName</code>,
ascending subsort by <code>firstName</code>. Mixed types are ok.</li>
</ul>
</div>
<div class="emits box">
<h4>Fires event <code>sortByChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>sortBy</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_srcNode" class="attr item inherited">
<a name="config_srcNode"></a>
<h3 class="name"><code>srcNode</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_srcNode">Widget</a>:
<a href="../files/widget_js_WidgetHTMLParser.js.html#l58"><code>widget/js/WidgetHTMLParser.js:58</code></a>
</p>
</div>
<div class="description">
<p>The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition</p>
</div>
<div class="emits box">
<h4>Fires event <code>srcNodeChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>srcNode</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_strings" class="attr item">
<a name="config_strings"></a>
<h3 class="name"><code>strings</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_strings">
Widget
</a>
but overwritten in
<a href="../files/datatable_js_sort.js.html#l160"><code>datatable/js/sort.js:160</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Strings containing language for sorting tooltips.</p>
</div>
<p><strong>Default:</strong> (strings for current lang configured in the YUI instance config)</p>
<div class="emits box">
<h4>Fires event <code>stringsChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>strings</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_summary" class="attr item">
<a name="config_summary"></a>
<h3 class="name"><code>summary</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/datatable-core.html">datatable-core</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_core.js.html#l142"><code>datatable/js/core.js:142</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Content for the <code><table summary="ATTRIBUTE VALUE HERE"></code>. Values assigned
to this attribute will be HTML escaped for security.</p>
</div>
<p><strong>Default:</strong> '' (empty string)</p>
<div class="emits box">
<h4>Fires event <code>summaryChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>summary</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_tabIndex" class="attr item inherited">
<a name="config_tabIndex"></a>
<h3 class="name"><code>tabIndex</code></h3>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_tabIndex">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l202"><code>widget/js/Widget.js:202</code></a>
</p>
</div>
<div class="description">
<p>Number (between -32767 to 32767) indicating the widget's
position in the default tab flow. The value is used to set the
"tabIndex" attribute on the widget's bounding box. Negative values allow
the widget to receive DOM focus programmatically (by calling the focus
method), while being removed from the default tab flow. A value of
null removes the "tabIndex" attribute from the widget's bounding box.</p>
</div>
<p><strong>Default:</strong> null</p>
<div class="emits box">
<h4>Fires event <code>tabIndexChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>tabIndex</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_view" class="attr item inherited">
<a name="config_view"></a>
<h3 class="name"><code>view</code></h3>
<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="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#attr_view">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l538"><code>datatable/js/base.js:538</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>The View class used to render the <code><table></code> into the Widget's
<code>contentBox</code>. This View can handle the entire table rendering itself
or delegate to other Views.</p>
<p>It is not strictly necessary that the class function assigned here be
a View subclass. It must however have a <code>render()</code> method.</p>
<p>When the DataTable is rendered, an instance of this View will be
created and its <code>render()</code> method called. The View instance will be
assigned to the DataTable instance's <code>view</code> property.</p>
</div>
<p><strong>Default:</strong> Y.DataTable.TableView</p>
<div class="emits box">
<h4>Fires event <code>viewChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>view</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_viewConfig" class="attr item protected inherited">
<a name="config_viewConfig"></a>
<h3 class="name"><code>viewConfig</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 protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DataTable.Base.html#attr_viewConfig">DataTable.Base</a>:
<a href="../files/datatable_js_base.js.html#l560"><code>datatable/js/base.js:560</code></a>
</p>
<p>Available since 3.6.0</p>
</div>
<div class="description">
<p>Configuration object passed to the class constructor in <code>view</code>
during render.</p>
</div>
<p><strong>Default:</strong> undefined (initially unset)</p>
<div class="emits box">
<h4>Fires event <code>viewConfigChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>viewConfig</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_visible" class="attr item inherited">
<a name="config_visible"></a>
<h3 class="name"><code>visible</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>Inherited from
<a href="../classes/Widget.html#attr_visible">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l242"><code>widget/js/Widget.js:242</code></a>
</p>
</div>
<div class="description">
<p>Boolean indicating whether or not the Widget is visible.</p>
</div>
<p><strong>Default:</strong> TRUE</p>
<div class="emits box">
<h4>Fires event <code>visibleChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>visible</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_width" class="attr item inherited">
<a name="config_width"></a>
<h3 class="name"><code>width</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_width">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l263"><code>widget/js/Widget.js:263</code></a>
</p>
</div>
<div class="description">
<p>String with units, or number, representing the width of the Widget. If a number is provided,
the default unit, defined by the Widgets DEF_UNIT, property is used.</p>
</div>
<p><strong>Default:</strong> EMPTY_STR</p>
<div class="emits box">
<h4>Fires event <code>widthChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>width</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_addColumn" class="events item">
<h3 class="name"><code>addColumn</code></h3>
<span class="type"></span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l592"><code>datatable/js/mutable.js:592</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Fired by the <code>addColumn</code> method.</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">column</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The new column definition object</p>
</div>
</li>
<li class="param">
<code class="param-name">index</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span>
<div class="param-description">
<p>The array index to insert the new column</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_destroy" class="events item inherited">
<h3 class="name"><code>destroy</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseObservable.html#event_destroy">BaseObservable</a>:
<a href="../files/base_js_BaseObservable.js.html#l151"><code>base/js/BaseObservable.js:151</code></a>
</p>
</div>
<div class="description">
<p>
Lifecycle event for the destroy phase,
fired prior to destruction. Invoking the preventDefault
method on the event object provided to subscribers will
prevent destruction from proceeding.
</p>
<p>
Subscribers to the "after" moment of this event, will be notified
after destruction is complete (and as a result cannot prevent
destruction).
</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">e</code>
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
<div class="param-description">
<p>Event object</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_init" class="events item inherited">
<h3 class="name"><code>init</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/BaseObservable.html#event_init">BaseObservable</a>:
<a href="../files/base_js_BaseObservable.js.html#l62"><code>base/js/BaseObservable.js:62</code></a>
</p>
</div>
<div class="description">
<p>
Lifecycle event for the init phase, fired prior to initialization.
Invoking the preventDefault() method on the event object provided
to subscribers will prevent initialization from occuring.
</p>
<p>
Subscribers to the "after" momemt of this event, will be notified
after initialization of the object is complete (and therefore
cannot prevent initialization).
</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">e</code>
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
<div class="param-description">
<p>Event object, with a cfg property which
refers to the configuration object passed to the constructor.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_modifyColumn" class="events item">
<h3 class="name"><code>modifyColumn</code></h3>
<span class="type"></span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l611"><code>datatable/js/mutable.js:611</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Fired by the <code>modifyColumn</code> method.</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">column</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span>
<div class="param-description">
<p>The column definition object or identifier</p>
</div>
</li>
<li class="param">
<code class="param-name">newColumnDef</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The properties to assign to the column</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_moveColumn" class="events item">
<h3 class="name"><code>moveColumn</code></h3>
<span class="type"></span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l621"><code>datatable/js/mutable.js:621</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Fired by the <code>moveColumn</code> method.</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">column</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span>
<div class="param-description">
<p>The column definition object or identifier</p>
</div>
</li>
<li class="param">
<code class="param-name">index</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The destination index to move to</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_removeColumn" class="events item">
<h3 class="name"><code>removeColumn</code></h3>
<span class="type"></span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-mutable.html">datatable-mutable</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_mutable.js.html#l602"><code>datatable/js/mutable.js:602</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Fired by the <code>removeColumn</code> method.</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">column</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Number.html" class="crosslink">Number</a> | <a href="../classes/Number.html" class="crosslink">Number[]</a></span>
<div class="param-description">
<p>The column definition object or identifier</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_render" class="events item inherited">
<h3 class="name"><code>render</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#event_render">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l543"><code>widget/js/Widget.js:543</code></a>
</p>
</div>
<div class="description">
<p>Lifecycle event for the render phase, fired prior to rendering the UI
for the widget (prior to invoking the widget's renderer method).</p>
<p>
Subscribers to the "on" moment of this event, will be notified
before the widget is rendered.
</p>
<p>
Subscribers to the "after" moment of this event, will be notified
after rendering is complete.
</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">e</code>
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
<div class="param-description">
<p>The Event Facade</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_sort" class="events item">
<h3 class="name"><code>sort</code></h3>
<span class="type"></span>
<div class="meta">
<p>Provided by the <a href="../modules/datatable-sort.html">datatable-sort</a> module.</p>
<p>
Defined in
<a href="../files/datatable_js_sort.js.html#l201"><code>datatable/js/sort.js:201</code></a>
</p>
</div>
<div class="description">
<p>Notifies of an impending sort, either from clicking on a column
header, or from a call to the <code>sort</code> or <code>toggleSort</code> method.</p>
<p>The requested sort is available in the <code>sortBy</code> property of the event.</p>
<p>The default behavior of this event sets the table's <code>sortBy</code> attribute.</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">sortBy</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
<div class="param-description">
<p>The requested sort</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_widget:contentUpdate" class="events item inherited">
<h3 class="name"><code>widget:contentUpdate</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#event_widget:contentUpdate">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l397"><code>widget/js/Widget.js:397</code></a>
</p>
</div>
<div class="description">
<p>Notification event, which widget implementations can fire, when
they change the content of the widget. This event has no default
behavior and cannot be prevented, so the "on" or "after"
moments are effectively equivalent (with on listeners being invoked before
after listeners).</p>
</div>
<div class="params">
<h4>Event Payload:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">e</code>
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
<div class="param-description">
<p>The Event Facade</p>
</div>
</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>