#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# DataTable Class

Extends DataTable.Base
Defined in: `datatable/js/base.js:16`
Module: datatable-base
Parent Module: datatable

Available since 3.5.0

A Widget for displaying tabular data. Before feature modules are `use()`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.

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.

    // 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
    });

### Column Configuration

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.

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 `columns` configuration attribute will be rendered.

Other column configuration properties are supported by the configured `view`, 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.

Some examples of column configurations would be:

    // 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: 'unknown' }
    ];

### Row Data Configuration

The `data` 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:

1. An array of simple objects with key:value pairs
2. A ModelList of Base-based class instances (presumably Model subclass instances)

If an array of objects is passed, it will be translated into a ModelList filled with instances of the class provided to the `recordType` attribute. This attribute can also create a custom Model subclass from an array of field names or an object of attribute configurations. If no `recordType` is provided, one will be created for you from available information (see `_initRecordType`). Providing either your own ModelList instance for `data`, or at least Model class for `recordType`, is the best way to control client-server synchronization when modifying data on the client side.

The ModelList instance that manages the table's data is available in the `data` property on the DataTable instance.

### Rendering

Table rendering is a collaborative process between the DataTable and its configured `view`. The DataTable creates an instance of the configured `view` (DataTable.TableView by default), and calls its `render()` method. DataTable.TableView, for instance, then creates the `<table>` and `<caption>`, then delegates the rendering of the specific sections of the table to subviews, which can be configured as `headerView`, `bodyView`, and `footerView`. DataTable.TableView defaults the `headerView` to DataTable.HeaderView and the `bodyView` to DataTable.BodyView, but leaves the `footerView` unassigned. Setting any subview to `null` will result in that table section not being rendered.

- Index
- Methods
- Properties
- Attributes
- Events

## Item Index

### Methods

- @renderUI
- _addAttrs
- _addLazyAttr
- _addScrollbarPadding
- _afterChildSelectedChange
- _afterColumnsChange
- _afterDataChange
- _afterDisplayColumnsChange
- _afterMessageColumnsChange
- _afterMessageDataChange
- _afterRecordTypeChange
- _afterScrollableChange
- _afterScrollCaptionChange
- _afterScrollColumnsChange
- _afterScrollDataChange
- _afterScrollHeightChange
- _afterScrollWidthChange
- _afterShowMessagesChange
- _afterSortByChange
- _afterSortDataChange
- _afterSortRecordChange
- _aggregateAttrs
- _applyParsedConfig
- _applyParser
- _attrCfgHash
- _baseDestroy
- _baseInit
- _bindAttrUI
- _bindDOM
- _bindMessageUI
- _bindScrollbar
- _bindScrollResize
- _bindScrollUI
- _bindSortUI
- _bindUI
- _bindUIChild
- _clearScrollLock
- _cloneDefaultValue
- _createColumnGroup
- _createRecordClass
- _createScrollbar
- _createScrollCaptionTable
- _createUIEvent
- _createXScrollNode
- _createYScrollHeader
- _createYScrollNode
- _defAddColumnFn
- _defAttrChangeFn
- _defaultCB
- _defDestroyFn
- _defInitFn
- _defModifyColumnFn
- _defMoveColumnFn
- _defRemoveColumnFn
- _defRenderFn
- _defRenderViewFn
- _defSortFn
- _destroyBox
- _destroyHierarchy
- _destroyUIEvents
- _disableScrolling
- _disableXScrolling
- _disableYScrolling
- _extractDisplayColumns
- _filterAdHocAttrs
- _filterAttrCfgs
- _filterUIEvent
- _fireAttrChange
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getClasses
- _getColumns
- _getColumnset deprecated
- _getFullType
- _getHtmlParser
- _getNodeToParse
- _getRecordType
- _getSortBy
- _getSrcNode
- _getStateVal
- _getStrings
- _getType
- _getUIEventNode
- _guid
- _initAttrHost
- _initAttribute
- _initAttrs
- _initBase
- _initColumns
- _initCoreEvents
- _initData
- _initDataProperty
- _initHierarchy
- _initHierarchyData
- _initMessageNode
- _initMessageStrings
- _initSortFn
- _initSortStrings
- _initUIEvent
- _isLazyAttr
- _isUIEvent
- _mapInstance
- _monitor
- _normAttrVals
- _onDocFocus
- _onDocMouseDown
- _onUITriggerSort
- _parseSortable
- _parseType
- _preInitEventCfg
- _protectAttrs deprecated
- _publish
- _relayCoreAttrChange
- _removeLoadingClassNames
- _removeScrollbar
- _removeScrollCaptionTable
- _removeXScrollNode
- _removeYScrollContainer
- _removeYScrollHeader
- _removeYScrollNode
- _renderBox
- _renderBoxClassNames
- _renderSortable
- _renderUI
- _set
- _setAttr
- _setAttrs
- _setAttrUI
- _setAttrVal
- _setBB
- _setBox
- _setCB
- _setColumnMap
- _setColumns
- _setColumnset deprecated
- _setColumnWidth
- _setData
- _setRecordset deprecated
- _setRecordType
- _setScrollable
- _setScrollProperties
- _setSortBy
- _setStateVal
- _setStrings
- _sortComparator
- _strSetter
- _syncAttrUI
- _syncMessageUI
- _syncScrollCaptionUI
- _syncScrollColumnWidths
- _syncScrollHeaders
- _syncScrollPosition
- _syncScrollUI
- _syncUI
- _syncUIChild
- _syncXScrollUI
- _syncYScrollUI
- _uiSetChildSelected
- _uiSetColumnWidths
- _uiSetDim
- _uiSetDisabled
- _uiSetFocused
- _uiSetHeight
- _uiSetMessage
- _uiSetScrollable
- _uiSetScrollbarHeight
- _uiSetScrollbarPosition
- _uiSetSortable
- _uiSetTabIndex
- _uiSetVisible
- _uiSetWidth
- _uiSetYScrollWidth
- _uiSizeCB
- _unbindDOM
- _unbindScrollbar
- _unbindScrollResize
- _unbindUI
- _validateSortable
- _validateSortBy
- _validateView
- _validTabIndex
- addAttr
- addAttrs
- addColumn
- addRow
- addRows
- addTarget
- after
- ancestor
- attrAdded
- before
- bindUI
- blur
- bubble
- delegate
- destroy
- destructor
- destructor
- detach
- detachAll
- disable
- enable
- fire
- focus
- get
- getAttrs
- getCell
- getClassName
- getColumn
- getDefaultLocale
- getEvent
- getRecord
- getRow
- getSkinName
- getString deprecated
- getStrings deprecated
- getTargets
- hide
- hideMessage
- init
- initializer
- initializer
- initializer
- initializer
- initializer
- initializer
- isRoot
- modifyAttr
- modifyColumn
- modifyRow
- moveColumn
- next
- on
- once
- onceAfter
- parseType
- previous
- publish
- removeAttr
- removeColumn
- removeRow
- removeTarget
- render
- renderer
- renderUI
- reset
- scrollTo
- set
- setAttrs
- setColumnWidth
- show
- showMessage
- sort
- subscribe deprecated
- syncUI
- toggleSort
- toString
- unsubscribe deprecated
- unsubscribeAll deprecated

### Properties

- _allowAdHocAttrs
- _CAPTION_TABLE_TEMPLATE
- _columnMap
- _displayColumns
- _messageNode
- _SCROLL_LINER_TEMPLATE
- _SCROLLBAR_TEMPLATE
- _sortable
- _sortBy
- _tableNode
- _UI_ATTRS
- _X_SCROLLER_TEMPLATE
- _xScroll
- _xScrollNode
- _Y_SCROLL_HEADER_TEMPLATE
- _Y_SCROLLER_TEMPLATE
- _yScroll
- _yScrollHeader
- _yScrollNode
- BOUNDING_TEMPLATE
- COL_TEMPLATE
- COLGROUP_TEMPLATE
- CONTENT_TEMPLATE
- data
- DEF_PARENT_NODE
- DEF_UNIT
- MESSAGE_TEMPLATE
- name deprecated
- SORTABLE_HEADER_TEMPLATE
- UI_EVENTS

### Attributes

- autoSync
- bodyConfig
- bodyView
- boundingBox
- caption
- columns
- columnset
- contentBox
- data
- destroyed
- disabled
- focused
- footerConfig
- footerView
- headerConfig
- headerView
- height
- id
- initialized
- locale
- recordset
- recordType
- render
- rendered
- scrollable
- showMessages
- sortable
- sortBy
- srcNode
- strings
- summary
- tabIndex
- view
- viewConfig
- visible
- width

### Events

- addColumn
- destroy
- init
- modifyColumn
- moveColumn
- removeColumn
- render
- sort
- widget:contentUpdate

## Methods

### `@renderUI`

() protected

Inherited from DataTable.Base: `datatable/js/base.js:425`

Available since 3.6.0

Instantiates the configured `view` class that will be responsible for setting up the View class.

### `_addAttrs`

(

- `cfgs`
- `values`
- `lazy`

)
private

Inherited from AttributeCore: `attribute/js/AttributeCore.js:836`

Implementation behind the public addAttrs method.

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).

#### Parameters:

- `cfgs` Object

  An object with attribute name/configuration pairs.

- `values` Object

  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.

- `lazy` Boolean

  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 addAttr.

### `_addLazyAttr`

(

- `name`
- `[lazyCfg]`

)
private

Inherited from AttributeCore: `attribute/js/AttributeCore.js:382`

Finishes initializing an attribute which has been lazily added.

#### Parameters:

- `name` Object

  The name of the attribute

- `[lazyCfg]` Object optional

  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.

### `_addScrollbarPadding`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:193`

Available since 3.5.0

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.

### `_afterChildSelectedChange`

(

- `event`

)
protected

Inherited from Widget: `widget-child/js/Widget-Child.js:327`

Default attribute change listener for the `selected` attribute, responsible for updating the UI, in response to attribute changes.

#### Parameters:

- `event` EventFacade

  The event facade for the attribute change.

### `_afterColumnsChange`

(

- `e`

)
protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:333`

Available since 3.5.0

Updates the `_columnMap` property in response to changes in the `columns` attribute.

#### Parameters:

- `e` EventFacade

  The `columnsChange` event object

### `_afterDataChange`

(

- `e`

)
protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:346`

Available since 3.5.0

Updates the `modelList` attributes of the rendered views in response to the `data` attribute being assigned a new ModelList.

#### Parameters:

- `e` EventFacade

  the `dataChange` event

### `_afterDisplayColumnsChange`

(

- `e`

)
protected

Inherited from DataTable.Base: `datatable/js/base.js:305`

Available since 3.6.0

Updates the `_displayColumns` property.

#### Parameters:

- `e` EventFacade

  The `columnsChange` event

### `_afterMessageColumnsChange`

(

- `e`

)
protected

Provided by the datatable-message module.

Defined in `datatable/js/message.js:110`

Available since 3.5.0

Updates the colspan of the `<td>` used to display the messages.

#### Parameters:

- `e` EventFacade

  The columnsChange event

### `_afterMessageDataChange`

(

- `e`

)
protected

Provided by the datatable-message module.

Defined in `datatable/js/message.js:133`

Available since 3.5.0

Relays to `_uiSetMessage` to hide or show the message node.

#### Parameters:

- `e` EventFacade

  The dataChange event

### `_afterRecordTypeChange`

(

- `e`

)
protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:367`

Available since 3.6.0

Assigns to the new recordType as the model for the data ModelList

#### Parameters:

- `e` EventFacade

  recordTypeChange event

### `_afterScrollableChange`

(

- `e`

)
protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:218`

Available since 3.5.0

Reacts to changes in the `scrollable` attribute by updating the `_xScroll` and `_yScroll` properties and syncing the scrolling structure accordingly.

#### Parameters:

- `e` EventFacade

  The relevant change event (ignored)

### `_afterScrollCaptionChange`

(

- `e`

)
protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:242`

Available since 3.5.0

Reacts to changes in the `caption` attribute by adding, removing, or syncing the caption table when the table is set to scroll.

#### Parameters:

- `e` EventFacade

  The relevant change event (ignored)

### `_afterScrollColumnsChange`

(

- `e`

)
protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:257`

Available since 3.5.0

Reacts to changes in the `columns` attribute of vertically scrolling tables by refreshing the fixed headers, scroll container, and virtual scrollbar position.

#### Parameters:

- `e` EventFacade

  The relevant change event (ignored)

### `_afterScrollDataChange`

(

- `e`

)
protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:277`

Available since 3.5.0

Reacts to changes in vertically scrolling table's `data` ModelList by synchronizing the fixed column header widths and virtual scrollbar height.

#### Parameters:

- `e` EventFacade

  The relevant change event (ignored)

### `_afterScrollHeightChange`

(

- `e`

)
protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:292`

Available since 3.5.0

Reacts to changes in the `height` attribute of vertically scrolling tables by updating the height of the `<div>` wrapping the data table and the virtual scrollbar. If `scrollable` was set to "y" or "xy" but lacking a declared `height` until the received change, `_syncScrollUI` is called to create the fixed headers etc.

#### Parameters:

- `e` EventFacade

  The relevant change event (ignored)

### `_afterScrollWidthChange`

(

- `e`

)
protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:331`

Available since 3.5.0

Reacts to changes in the width of scrolling tables by expanding the width of the `<div>` wrapping the data table for horizontally scrolling tables or upding the position of the virtual scrollbar for vertically scrolling tables.

#### Parameters:

- `e` EventFacade

  The relevant change event (ignored)

### `_afterShowMessagesChange`

(

- `e`

)
protected

Provided by the datatable-message module.

Defined in `datatable/js/message.js:145`

Available since 3.5.0

Removes the message node if `showMessages` is `false`, or relays to `_uiSetMessage` if `true`.

#### Parameters:

- `e` EventFacade

  The showMessagesChange event

### `_afterSortByChange`

(

- `e`

)
protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:288`

Available since 3.5.0

Sorts the `data` ModelList based on the new `sortBy` configuration.

#### Parameters:

- `e` EventFacade

  The `sortByChange` event

### `_afterSortDataChange`

(

- `e`

)
protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:313`

Available since 3.5.0

Applies the sorting logic to the new ModelList if the `newVal` is a new ModelList.

#### Parameters:

- `e` EventFacade

  the `dataChange` event

### `_afterSortRecordChange`

(

- `e`

)
protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:332`

Available since 3.5.0

Checks if any of the fields in the modified record are fields that are currently being sorted by, and if so, resorts the `data` ModelList.

#### Parameters:

- `e` EventFacade

  The Model's `change` event

### `_aggregateAttrs`

(

- `allAttrs`

)
Object private

Inherited from BaseCore: `base/js/BaseCore.js:575`

A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy.

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).

#### Parameters:

- `allAttrs` Array

  An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)

#### Returns:

Object: The aggregate set of ATTRS definitions for the instance

### `_applyParsedConfig`

() Object protected

Inherited from Widget: `widget/js/WidgetHTMLParser.js:83`

#### Returns:

Object: The merged configuration literal

### `_applyParser`

(

- `config`

)
protected

Inherited from Widget: `widget/js/WidgetHTMLParser.js:92`

Utility method used to apply the `HTML_PARSER` configuration for the instance, to retrieve config data values.

#### Parameters:

- `config` Object

  User configuration object (will be populated with values from Node)

### `_attrCfgHash`

() private

Inherited from BaseCore: `base/js/BaseCore.js:538`

Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.

### `_baseDestroy`

() private

Inherited from BaseCore: `base/js/BaseCore.js:309`

Internal destroy implementation for BaseCore

### `_baseInit`

() private

Inherited from BaseCore: `base/js/BaseCore.js:281`

Internal initialization implementation for BaseCore

### `_bindAttrUI`

(

- `attrs`

)
private

Inherited from Widget: `widget/js/Widget.js:1170`

Binds after listeners for the list of attributes provided

#### Parameters:

- `attrs` Array

### `_bindDOM`

() protected

Inherited from Widget: `widget/js/Widget.js:902`

Sets up DOM listeners, on elements rendered by the widget.

### `_bindMessageUI`

() protected

Provided by the datatable-message module.

Defined in `datatable/js/message.js:166`

Available since 3.5.0

Binds the events necessary to keep the message node in sync with the current table and configuration state.

### `_bindScrollbar`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:348`

Available since 3.5.0

Binds virtual scrollbar interaction to the `_yScrollNode`'s `scrollTop` and vice versa.

### `_bindScrollResize`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:368`

Available since 3.5.0

Binds to the window resize event to update the vertical scrolling table headers and wrapper `<div>` dimensions.

### `_bindScrollUI`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:385`

Available since 3.5.0

Attaches internal subscriptions to keep the scrolling structure up to date with changes in the table's `data`, `columns`, `caption`, or `height`. The `width` is taken care of already.

This executes after the table's native `bindUI` method.

### `_bindSortUI`

() protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:352`

Available since 3.5.0

Subscribes to state changes that warrant updating the UI, and adds the click handler for triggering the sort operation from the UI.

### `_bindUI`

() protected

Inherited from Widget: `widget/js/Widget.js:883`

Sets up DOM and CustomEvent listeners for the widget.

### `_bindUIChild`

() protected

Inherited from Widget: `widget-child/js/Widget-Child.js:356`

Binds event listeners responsible for updating the UI state in response to WidgetChild related state changes.

This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.

### `_clearScrollLock`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:413`

Available since 3.5.0

Clears the lock and timer used to manage synchronizing the scroll position between the vertical scroll container and the virtual scrollbar.

### `_cloneDefaultValue`

(

- `cfg`

)
private

Inherited from BaseCore: `base/js/BaseCore.js:549`

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.

#### Parameters:

- `cfg` Object

### `_createColumnGroup`

() protected

Provided by the datatable-column-widths module.

Defined in `datatable/js/colwidths.js:175`

Available since 3.5.0

Renders the table's `<colgroup>` and populates the `_colgroupNode` property.

### `_createRecordClass`

(

- `attrs`

)
Model protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:391`

Available since 3.5.0

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 `data` attribute if no `recordType` is set.

#### Parameters:

- `attrs` String[] | Object

  Names assigned to the Model subclass's `ATTRS` or its entire `ATTRS` definition object

#### Returns:

Model:

### `_createScrollbar`

() Node protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:428`

Available since 3.5.0

Creates a virtual scrollbar from the `_SCROLLBAR_TEMPLATE`, assigning it to the `_scrollbarNode` property.

#### Returns:

Node: The created Node

### `_createScrollCaptionTable`

() Node protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:454`

Available since 3.5.0

Creates a separate table to contain the caption when the table is configured to scroll vertically or horizontally.

#### Returns:

Node: The created Node

### `_createUIEvent`

(

- `type`

)
private

Inherited from Widget: `widget/js/WidgetUIEvents.js:73`

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.

#### Parameters:

- `type` String

  String representing the name of the event

### `_createXScrollNode`

() Node protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:476`

Available since 3.5.0

Populates the `_xScrollNode` property by creating the `<div>` Node described by the `_X_SCROLLER_TEMPLATE`.

#### Returns:

Node: The created Node

### `_createYScrollHeader`

() Node protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:496`

Available since 3.5.0

Populates the `_yScrollHeader` property by creating the `<table>` Node described by the `_Y_SCROLL_HEADER_TEMPLATE`.

#### Returns:

Node: The created Node

### `_createYScrollNode`

() Node protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:518`

Available since 3.5.0

Populates the `_yScrollNode` property by creating the `<div>` Node described by the `_Y_SCROLLER_TEMPLATE`.

#### Returns:

Node: The created Node

### `_defAddColumnFn`

(

- `e`

)
protected

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:394`

Available since 3.5.0

Default function for the `addColumn` event.

Inserts the specified column at the provided index.

#### Parameters:

- `e` EventFacade

  The `addColumn` event

  - `column` Object

    The new column definition object

  - `index` Number | Number[]

    The array index to insert the new column

### `_defAttrChangeFn`

(

- `e`

)
private

Inherited from AttributeObservable: `attribute/js/AttributeObservable.js:186`

Default function for attribute change events.

#### Parameters:

- `e` EventFacade

  The event object for attribute change events.

### `_defaultCB`

() protected

Inherited from Widget: `widget/js/Widget.js:780`

Returns the default value for the contentBox attribute.

For the Widget class, this will be the srcNode if provided, otherwise null (resulting in a new contentBox node instance being created)

### `_defDestroyFn`

(

- `e`

)
protected

Inherited from BaseObservable: `base/js/BaseObservable.js:190`

Default destroy event handler

#### Parameters:

- `e` EventFacade

  Event object

### `_defInitFn`

(

- `e`

)
protected

Inherited from BaseObservable: `base/js/BaseObservable.js:178`

Default init event handler

#### Parameters:

- `e` EventFacade

  Event object, with a cfg property which refers to the configuration object passed to the constructor.

### `_defModifyColumnFn`

(

- `e`

)
protected

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:424`

Available since 3.5.0

Default function for the `modifyColumn` event.

Mixes the new column properties into the specified column definition.

#### Parameters:

- `e` EventFacade

  The `modifyColumn` event

  - `column` Object | String | Number | Number[]

    The column definition object or identifier

  - `newColumnDef` Object

    The properties to assign to the column

### `_defMoveColumnFn`

(

- `e`

)
protected

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:448`

Available since 3.5.0

Default function for the `moveColumn` event.

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).

#### Parameters:

- `e` EventFacade

  The `moveColumn` event

  - `column` Object | String | Number | Number[]

    The column definition object or identifier

  - `index` Object

    The destination index to move to

### `_defRemoveColumnFn`

(

- `e`

)
protected

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:501`

Available since 3.5.0

Default function for the `removeColumn` event.

Splices the specified column from its containing columns array.

#### Parameters:

- `e` EventFacade

  The `removeColumn` event

  - `column` Object | String | Number | Number[]

    The column definition object or identifier

### `_defRenderFn`

(

- `e`
- `parentNode`

)
protected

Inherited from Widget: `widget/js/Widget.js:571`

Default render handler

#### Parameters:

- `e` EventFacade

  The Event object

- `parentNode` Node

  The parent node to render to, if passed in to the `render` method

### `_defRenderViewFn`

(

- `e`

)
protected

Inherited from DataTable.Base: `datatable/js/base.js:336`

The default behavior of the `renderView` event. Calls `render()` on the `View` instance on the event.

#### Parameters:

- `e` EventFacade

  The `renderView` event

### `_defSortFn`

(

- `e`

)
protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:376`

Available since 3.5.0

Sets the `sortBy` attribute from the `sort` event's `e.sortBy` value.

#### Parameters:

- `e` EventFacade

  The `sort` event

### `_destroyBox`

() protected

Inherited from Widget: `widget/js/Widget.js:476`

Removes and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.

### `_destroyHierarchy`

() private

Inherited from BaseCore: `base/js/BaseCore.js:721`

Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.

### `_destroyUIEvents`

() private

Inherited from Widget: `widget/js/WidgetUIEvents.js:20`

Destructor logic for UI event infrastructure, invoked during Widget destruction.

### `_disableScrolling`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:546`

Available since 3.5.0

Removes the nodes used to create horizontal and vertical scrolling and rejoins the caption to the main table if needed.

### `_disableXScrolling`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:563`

Available since 3.5.0

Removes the nodes used to allow horizontal scrolling.

### `_disableYScrolling`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:574`

Available since 3.5.0

Removes the nodes used to allow vertical scrolling.

### `_extractDisplayColumns`

(

- `columns`

)
protected

Inherited from DataTable.Base: `datatable/js/base.js:348`

Processes the full column array, distilling the columns down to those that correspond to cell data columns.

#### Parameters:

- `columns` Object[]

  The full set of table columns

### `_filterAdHocAttrs`

(

- `allAttrs`
- `userVals`

)
Object private

Inherited from BaseCore: `base/js/BaseCore.js:427`

#### Parameters:

- `allAttrs` Object

  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.

- `userVals` Object

  The config object passed in by the user, from which adhoc attrs are to be filtered.

#### Returns:

Object: The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.

### `_filterAttrCfgs`

(

- `clazz`
- `allCfgs`

)
Object private

Inherited from BaseCore: `base/js/BaseCore.js:356`

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.

#### Parameters:

- `clazz` Function

  The class for which the desired attributes are required.

- `allCfgs` Object

  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.

#### Returns:

Object: The set of attributes belonging to the class passed in, in the form of an object with attribute name/configuration pairs.

### `_filterUIEvent`

(

- `evt`

)
Boolean private

Inherited from Widget: `widget/js/WidgetUIEvents.js:117`

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.

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.

#### Parameters:

- `evt` DOMEventFacade

#### Returns:

Boolean: true if it's OK to fire the custom UI event, false if not.

### `_fireAttrChange`

(

- `attrName`
- `subAttrName`
- `currVal`
- `newVal`
- `opts`
- `[cfg]`

)
private

Inherited from AttributeObservable: `attribute/js/AttributeObservable.js:120`

Utility method to help setup the event payload and fire the attribute change event.

#### Parameters:

- `attrName` String

  The name of the attribute

- `subAttrName` String

  The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.

- `currVal` Any

  The current value of the attribute

- `newVal` Any

  The new value of the attribute

- `opts` Object

  Any additional event data to mix into the attribute change event's event facade.

- `[cfg]` Object optional

  The attribute config stored in State, if already available.

### `_getAttr`

(

- `name`

)
Any protected chainable

Inherited from AttributeCore: `attribute/js/AttributeCore.js:543`

Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.

See get for argument details.

#### Parameters:

- `name` String

  The name of the attribute.

#### Returns:

Any: The value of the attribute.

### `_getAttrCfg`

(

- `name`

)
Object protected

Inherited from AttributeExtras: `attribute/js/AttributeExtras.js:114`

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.

#### Parameters:

- `name` String

  Optional. The attribute name. If not provided, the method will return the configuration for all attributes.

#### Returns:

Object: The configuration properties for the given attribute, or all attributes.

### `_getAttrCfgs`

() Object protected

Inherited from BaseCore: `base/js/BaseCore.js:339`

Returns an aggregated set of attribute configurations, by traversing the class hierarchy.

#### Returns:

Object: 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.

### `_getAttrInitVal`

(

- `attr`
- `cfg`
- `initValues`

)
Any private

Inherited from AttributeCore: `attribute/js/AttributeCore.js:945`

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.

#### Parameters:

- `attr` String

  The name of the attribute

- `cfg` Object

  The attribute configuration object

- `initValues` Object

  The object with simple and complex attribute name/value pairs returned from _normAttrVals

#### Returns:

Any: The initial value of the attribute.

### `_getAttrs`

(

- `attrs`

)
Object protected

Inherited from AttributeCore: `attribute/js/AttributeCore.js:774`

Implementation behind the public getAttrs method, to get multiple attribute values.

#### Parameters:

- `attrs` Array | boolean

  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.

#### Returns:

Object: An object with attribute name/value pairs.

### `_getClasses`

() Function[] protected

Inherited from BaseCore: `base/js/BaseCore.js:323`

Returns the class hierarchy for this object, with BaseCore being the last class in the array.

#### Returns:

Function[]: 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.

### `_getColumns`

(

- `columns`
- `name`

)
protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:431`

Available since 3.5.0

The getter for the `columns` attribute. Returns the array of column configuration objects if `instance.get('columns')` is called, or the specific column object if `instance.get('columns.columnKey')` is called.

#### Parameters:

- `columns` Object[]

  The full array of column objects

- `name` String

  The attribute name requested (e.g. 'columns' or 'columns.foo');

### `_getColumnset`

(

- `ignored`
- `name`

)
deprecated protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:450`

Deprecated: This will be removed with the `columnset` attribute in a future version.

Available since 3.5.0

Relays the `get()` request for the deprecated `columnset` attribute to the `columns` attribute.

THIS BREAKS BACKWARD COMPATIBILITY. 3.4.1 and prior implementations will expect a Columnset instance returned from `get('columnset')`.

#### Parameters:

- `ignored` Object

  The current value stored in the `columnset` state

- `name` String

  The attribute name requested (e.g. 'columnset' or 'columnset.foo');

### `_getFullType`

(

- `type`

)
String private

Inherited from EventTarget: `event-custom/js/event-target.js:586`

Returns the fully qualified type, given a short type string. That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.

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.

#### Parameters:

- `type` String

  The short type to prefix

#### Returns:

String: The prefixed type, if a prefix is set, otherwise the type passed in

### `_getHtmlParser`

() Object private

Inherited from Widget: `widget/js/WidgetHTMLParser.js:149`

Gets the HTMLPARSER definition for this instance, by merging HTMLPARSER definitions across the class hierarchy.

#### Returns:

Object: HTML_PARSER definition for this instance

### `_getNodeToParse`

() Node private

Inherited from Widget: `widget/js/WidgetHTMLParser.js:134`

Determines whether we have a node reference which we should try and parse.

The current implementation does not parse nodes generated from CONTENT_TEMPLATE, only explicitly set srcNode, or contentBox attributes.

#### Returns:

Node: The node reference to apply HTML_PARSER to.

### `_getRecordType`

(

- `val`

)
Model

Provided by the datatable-core module.

Defined in `datatable/js/core.js:470`

Returns the Model class of the instance's `data` attribute ModelList. If not set, returns the explicitly configured value.

#### Parameters:

- `val` Model

  The currently configured value

#### Returns:

Model:

### `_getSortBy`

(

- `val`
- `detail`

)
protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:388`

Available since 3.5.0

Getter for the `sortBy` attribute.

Supports the special subattribute "sortBy.state" to get a normalized JSON version of the current sort state. Otherwise, returns the last assigned value.

For example:

    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 }]

#### Parameters:

- `val` String | String[] | Object | Object[]

  The current sortBy value

- `detail` String

  String passed to `get(HERE)`. to parse subattributes

### `_getSrcNode`

() Node protected

Inherited from Widget: `widget/js/WidgetHTMLParser.js:74`

#### Returns:

Node: The Node to apply HTML_PARSER to

### `_getStateVal`

(

- `name`
- `[cfg]`

)
Any private

Inherited from AttributeCore: `attribute/js/AttributeCore.js:600`

Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits

#### Parameters:

- `name` String

  The name of the attribute

- `[cfg]` Object optional

  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.

#### Returns:

Any: The stored value of the attribute

### `_getStrings`

(

- `locale`

)
protected

Inherited from Widget: `widget/js/WidgetLocale.js:56`

Returns the strings key/value hash for a paricular locale, without locale lookup applied.

#### Parameters:

- `locale` Object

### `_getType`

() private

Inherited from EventTarget: `event-custom/js/event-target.js:36`

If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.

### `_getUIEventNode`

() protected

Inherited from Widget but overwritten in `widget-child/js/Widget-Child.js:167`

Returns the node on which to bind delegate listeners.

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.

### `_guid`

() protected

Inherited from Widget: `widget/js/Widget.js:1153`

### `_initAttrHost`

(

- `attrs`
- `values`
- `lazy`

)
private

Inherited from AttributeCore: `attribute/js/AttributeCore.js:140`

Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.

#### Parameters:

- `attrs` Object

  The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.

- `values` Object

  The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.

- `lazy` Boolean

  Whether or not to add attributes lazily (passed through to addAttrs).

### `_initAttribute`

() private

Inherited from BaseObservable but overwritten in `base/js/BaseCore.js:254`

Initializes AttributeCore

### `_initAttrs`

(

- `attrs`
- `values`
- `lazy`

)
protected

Inherited from AttributeCore: `attribute/js/AttributeCore.js:1011`

Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.

#### Parameters:

- `attrs` Object

  The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.

- `values` Object

  The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.

- `lazy` Boolean

  Whether or not to add attributes lazily (passed through to addAttrs).

### `_initBase`

(

- `config`

)
private

Inherited from BaseCore: `base/js/BaseCore.js:219`

Internal construction logic for BaseCore.

#### Parameters:

- `config` Object

  The constructor configuration object

### `_initColumns`

() protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:488`

Available since 3.5.0

Initializes the `_columnMap` property from the configured `columns` attribute. If `columns` is not set, but there are records in the `data` ModelList, use `ATTRS` of that class.

### `_initCoreEvents`

() protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:517`

Available since 3.6.0

Sets up the change event subscriptions to maintain internal state.

### `_initData`

() ModelList protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:532`

Available since 3.6.0

Defaults the `data` attribute to an empty ModelList if not set during construction. Uses the configured `recordType` for the ModelList's `model` proeprty if set.

#### Returns:

ModelList:

### `_initDataProperty`

(

- `data`

)
protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:554`

Available since 3.6.0

Initializes the instance's `data` property from the value of the `data` attribute. If the attribute value is a ModelList, it is assigned directly to `this.data`. If it is an array, a ModelList is created, its `model` property is set to the configured `recordType` class, and it is seeded with the array data. This ModelList is then assigned to `this.data`.

#### Parameters:

- `data` Array | ModelList | ArrayList

  Collection of data to populate the DataTable

### `_initHierarchy`

(

- `userVals`

)
private

Inherited from BaseCore: `base/js/BaseCore.js:659`

Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.

#### Parameters:

- `userVals` Object

  Object with configuration property name/value pairs

### `_initHierarchyData`

() private

Inherited from BaseCore: `base/js/BaseCore.js:457`

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.

### `_initMessageNode`

() protected

Provided by the datatable-message module.

Defined in `datatable/js/message.js:203`

Available since 3.5.0

Creates the `_messageNode` property from the configured `MESSAGE_TEMPLATE` and inserts it before the `<table>`'s `<tbody>` node.

### `_initMessageStrings`

() protected

Provided by the datatable-message module.

Defined in `datatable/js/message.js:224`

Available since 3.5.0

Add the messaging related strings to the `strings` map.

### `_initSortFn`

() protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:477`

Available since 3.5.0

Creates a `_compare` function for the `data` ModelList to allow custom sorting by multiple fields.

### `_initSortStrings`

() protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:532`

Available since 3.5.0

Add the sort related strings to the `strings` map.

### `_initUIEvent`

(

- `type`

)
String private

Inherited from Widget: `widget/js/WidgetUIEvents.js:176`

Sets up infrastructure required to fire a UI event.

#### Parameters:

- `type` String

  String representing the name of the event

#### Returns:

String:

### `_isLazyAttr`

(

- `name`

)
Boolean private

Inherited from AttributeCore: `attribute/js/AttributeCore.js:369`

Checks whether or not the attribute is one which has been added lazily and still requires initialization.

#### Parameters:

- `name` String

  The name of the attribute

#### Returns:

Boolean: true if it's a lazily added attribute, false otherwise.

### `_isUIEvent`

(

- `type`

)
String private

Inherited from Widget: `widget/js/WidgetUIEvents.js:143`

Determines if the specified event is a UI event.

#### Parameters:

- `type` String

  String representing the name of the event

#### Returns:

String: Event Returns the name of the UI Event, otherwise undefined.

### `_mapInstance`

(

- `The`

)
protected

Inherited from Widget: `widget/js/Widget.js:414`

Utility method used to add an entry to the boundingBox id to instance map.

This method can be used to populate the instance with lazily created boundingBox Node references.

#### Parameters:

- `The` String

  boundingBox id

### `_monitor`

(

- `what`
- `eventType`
- `o`

)
private

Inherited from EventTarget: `event-custom/js/event-target.js:658`

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 -> clickattach, clickdetach, 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.

#### Parameters:

- `what` String

  'attach', 'detach', 'fire', or 'publish'

- `eventType` String | CustomEvent

  The prefixed name of the event being monitored, or the CustomEvent object.

- `o` Object

  Information about the event interaction, such as fire() args, subscription category, publish config

### `_normAttrVals`

(

- `valueHash`

)
Object private

Inherited from AttributeCore: `attribute/js/AttributeCore.js:897`

Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.

#### Parameters:

- `valueHash` Object

  An object with attribute name/value pairs

#### Returns:

Object: 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.

### `_onDocFocus`

(

- `evt`

)
protected

Inherited from Widget: `widget/js/Widget.js:1081`

DOM focus event handler, used to sync the state of the Widget with the DOM

#### Parameters:

- `evt` EventFacade

  The event facade for the DOM focus event

### `_onDocMouseDown`

(

- `evt`

)
protected

Inherited from Widget: `widget/js/Widget.js:1068`

"mousedown" event handler for the owner document of the widget's bounding box.

#### Parameters:

- `evt` EventFacade

  The event facade for the DOM focus event

### `_onUITriggerSort`

(

- `e`

)
protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:545`

Available since 3.5.0

Fires the `sort` event in response to user clicks on sortable column headers.

#### Parameters:

- `e` DOMEventFacade

  The `click` event

### `_parseSortable`

() protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:595`

Available since 3.5.0

Normalizes the possible input values for the `sortable` attribute, storing the results in the `_sortable` property.

### `_parseType`

() private

Inherited from EventTarget: `event-custom/js/event-target.js:52`

Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)

### `_preInitEventCfg`

(

- `config`

)
private

Inherited from BaseObservable: `base/js/BaseObservable.js:98`

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.

#### Parameters:

- `config` Object

  The user configuration object

### `_protectAttrs`

(

- `attrs`

)
Object deprecated protected

Inherited from AttributeCore: `attribute/js/AttributeCore.js:883`

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.

#### Parameters:

- `attrs` Object

  A hash of attribute to configuration object pairs.

#### Returns:

Object: A protected version of the attrs argument.

### `_publish`

(

- `fullType`
- `etOpts`
- `ceOpts`

)
CustomEvent private

Inherited from EventTarget: `event-custom/js/event-target.js:610`

The low level event publish implementation. It expects all the massaging to have been done outside of this method. e.g. the `type` to `fullType` conversion. It's designed to be a fast path publish, which can be used by critical code paths to improve performance.

#### Parameters:

- `fullType` String

  The prefixed type of the event to publish.

- `etOpts` Object

  The EventTarget specific configuration to mix into the published event.

- `ceOpts` Object

  The publish specific configuration to mix into the published event.

#### Returns:

CustomEvent: The published event. If called without `etOpts` or `ceOpts`, this will be the default `CustomEvent` instance, and can be configured independently.

### `_relayCoreAttrChange`

(

- `e`

)
protected

Inherited from DataTable.Base: `datatable/js/base.js:411`

Available since 3.6.0

Relays attribute changes to the instance's `view`.

#### Parameters:

- `e` EventFacade

  The change event

### `_removeLoadingClassNames`

() protected

Inherited from Widget: `widget/js/Widget.js:862`

Removes class names representative of the widget's loading state from the boundingBox.

### `_removeScrollbar`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:713`

Available since 3.5.0

Removes the virtual scrollbar used by scrolling tables.

### `_removeScrollCaptionTable`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:621`

Available since 3.5.0

Removes the table used to house the caption when the table is scrolling.

### `_removeXScrollNode`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:640`

Available since 3.5.0

Removes the `<div>` wrapper used to contain the data table when the table is horizontally scrolling.

### `_removeYScrollContainer`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:659`

Available since 3.5.0

Removes the `<div>` wrapper used to contain the data table and fixed header when the table is vertically scrolling.

### `_removeYScrollHeader`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:678`

Available since 3.5.0

Removes the `<table>` used to contain the fixed column headers when the table is vertically scrolling.

### `_removeYScrollNode`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:694`

Available since 3.5.0

Removes the `<div>` wrapper used to contain the data table when the table is vertically scrolling.

### `_renderBox`

(

- `parentNode`

)
private

Inherited from Widget: `widget/js/Widget.js:710`

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.

#### Parameters:

- `parentNode` Node

  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.

### `_renderBoxClassNames`

() protected

Inherited from Widget: `widget/js/Widget.js:838`

Applies standard class names to the boundingBox and contentBox

### `_renderSortable`

() protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:637`

Available since 3.5.0

Initial application of the sortable UI.

### `_renderUI`

() protected

Inherited from Widget: `widget/js/Widget.js:827`

Initializes the UI state for the Widget's bounding/content boxes.

### `_set`

(

- `name`
- `val`
- `[opts]`

)
Object protected chainable

Inherited from AttributeObservable but overwritten in `attribute/js/AttributeCore.js:427`

Allows setting of readOnly/writeOnce attributes. See set for argument details.

#### Parameters:

- `name` String

  The name of the attribute.

- `val` Any

  The value to set the attribute to.

- `[opts]` Object optional

  Optional data providing the circumstances for the change.

#### Returns:

Object: A reference to the host object.

### `_setAttr`

(

- `name`
- `value`
- `[opts]`
- `force`

)
Object protected chainable

Inherited from AttributeCore: `attribute/js/AttributeCore.js:443`

Provides the common implementation for the public set and protected _set methods.

See set for argument details.

#### Parameters:

- `name` String

  The name of the attribute.

- `value` Any

  The value to set the attribute to.

- `[opts]` Object optional

  Optional data providing the circumstances for the change.

- `force` Boolean

  If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.

#### Returns:

Object: A reference to the host object.

### `_setAttrs`

(

- `attrs`
- `[opts]`

)
Object protected chainable

Inherited from AttributeObservable but overwritten in `attribute/js/AttributeCore.js:742`

Implementation behind the public setAttrs method, to set multiple attribute values.

#### Parameters:

- `attrs` Object

  An object with attributes name/value pairs.

- `[opts]` Object optional

  Optional data providing the circumstances for the change

#### Returns:

Object: A reference to the host object.

### `_setAttrUI`

(

- `e`

)
private

Inherited from Widget: `widget/js/Widget.js:1201`

#### Parameters:

- `e` EventFacade

### `_setAttrVal`

(

- `attrName`
- `subAttrName`
- `prevVal`
- `newVal`
- `[opts]`
- `[attrCfg]`

)
Booolean private

Inherited from AttributeCore: `attribute/js/AttributeCore.js:640`

Updates the stored value of the attribute in the privately held State object, if validation and setter passes.

#### Parameters:

- `attrName` String

  The attribute name.

- `subAttrName` String

  The sub-attribute name, if setting a sub-attribute property ("x.y.z").

- `prevVal` Any

  The currently stored value of the attribute.

- `newVal` Any

  The value which is going to be stored.

- `[opts]` Object optional

  Optional data providing the circumstances for the change.

- `[attrCfg]` Object optional

  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.

#### Returns:

Booolean: true if the new attribute value was stored, false if not.

### `_setBB`

(

- `Node/String`

)
private

Inherited from Widget: `widget/js/Widget.js:756`

Setter for the boundingBox attribute

#### Parameters:

- `Node/String` Object

#### Returns:

Node

### `_setBox`

(

- `id`
- `node`
- `template`
- `true`

)
Node private

Inherited from Widget: `widget/js/Widget.js:793`

Helper method to set the bounding/content box, or create it from the provided template if not found.

#### Parameters:

- `id` String

  The node's id attribute

- `node` Node | String

  The node reference

- `template` String

  HTML string template for the node

- `true` Boolean

  if this is the boundingBox, false if it's the contentBox

#### Returns:

Node: The node

### `_setCB`

(

- `node`

)
private

Inherited from Widget: `widget/js/Widget.js:768`

Setter for the contentBox attribute

#### Parameters:

- `node` Node | String

#### Returns:

Node

### `_setColumnMap`

(

- `columns`

)
protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:640`

Available since 3.6.0

Iterates the array of column configurations to capture all columns with a `key` 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 `_columnMap` property.

#### Parameters:

- `columns` Object[] | String[]

  The array of column config objects

### `_setColumns`

(

- `val`

)
Null | Object[] protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:684`

Translates string columns into objects with that string as the value of its `key` property.

All columns are assigned a `_yuid` stamp and `_id` property corresponding to the column's configured `name` or `key` property with any spaces replaced with dashes. If the same `name` or `key` appears in multiple columns, subsequent appearances will have their `_id` appended with an incrementing number (e.g. if column "foo" is included in the `columns` attribute twice, the first will get `_id` of "foo", and the second an `_id` of "foo1"). Columns that are children of other columns will have the `_parent` property added, assigned the column object to which they belong.

#### Parameters:

- `val` Null | Object[] | String[]

  Array of config objects or strings

#### Returns:

Null | Object[]:

### `_setColumnset`

(

- `val`

)
deprecated protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:792`

Deprecated: This will be removed with the deprecated `columnset` attribute in a later version.

Available since 3.5.0

Relays attribute assignments of the deprecated `columnset` attribute to the `columns` attribute. If a Columnset is object is passed, its basic object structure is mined.

#### Parameters:

- `val` Array | Columnset

  The columnset value to relay

### `_setColumnWidth`

(

- `colIndex`
- `width`

)
protected

Provided by the datatable-column-widths module.

Defined in `datatable/js/colwidths.js:198`

Available since 3.5.0

Sets a columns's `<col>` element width style. This is needed to get around browser rendering differences.

The colIndex corresponds to the item index of the `<col>` in the table's `<colgroup>`.

To unset the width, pass a falsy value for the `width`.

#### Parameters:

- `colIndex` Number

  The display column index

- `width` Number | String

  The desired width

### `_setData`

() protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:810`

Available since 3.5.0

Accepts an object with `each` and `getAttrs` (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 `model` property to the class in the `recordType` attribute, which will be defaulted if not yet set.

If the `data` property is already set with a ModelList, passing an array as the value will call the ModelList's `reset()` method with that array rather than replacing the stored ModelList wholesale.

Any non-ModelList-ish and non-array value is invalid.

### `_setRecordset`

(

- `val`

)
deprecated protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:853`

Deprecated: This will be removed with the deprecated `recordset` attribute in a later version.

Available since 3.5.0

Relays the value assigned to the deprecated `recordset` attribute to the `data` attribute. If a Recordset instance is passed, the raw object data will be culled from it.

#### Parameters:

- `val` Object[] | Recordset

  The recordset value to relay

### `_setRecordType`

(

- `val`

)
Function protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:881`

Available since 3.5.0

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 `ATTRS` of the new class).

Any other value is invalid.

#### Parameters:

- `val` Function | String[] | Object

  The Model subclass, array of attribute names, or the `ATTRS` definition for a custom model subclass

#### Returns:

Function: A Base/Model subclass

### `_setScrollable`

(

- `val`

)
String protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:733`

Available since 3.5.0

Accepts (case insensitive) values "x", "y", "xy", `true`, and `false`. `true` is translated to "xy" and upper case values are converted to lower case. All other values are invalid.

#### Parameters:

- `val` String | Boolea

  Incoming value for the `scrollable` attribute

#### Returns:

String:

### `_setScrollProperties`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:758`

Available since 3.5.0

Assigns the `_xScroll` and `_yScroll` properties to true if an appropriate value is set in the `scrollable` attribute and the `height` and/or `width` is set.

### `_setSortBy`

() protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:650`

Available since 3.5.0

Parses the current `sortBy` attribute into a normalized structure for the `data` ModelList's `_compare` method. Also updates the column configurations' `sortDir` properties.

### `_setStateVal`

(

- `name`
- `value`

)
private

Inherited from AttributeCore: `attribute/js/AttributeCore.js:622`

Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits

#### Parameters:

- `name` String

  The name of the attribute

- `value` Any

  The value of the attribute

### `_setStrings`

(

- `strings`
- `locale`

)
protected

Inherited from Widget: `widget/js/WidgetLocale.js:35`

Sets strings for a particular locale, merging with any existing strings which may already be defined for the locale.

#### Parameters:

- `strings` Object

  The hash of string key/values to set

- `locale` Object

  The locale for the string values being set

### `_sortComparator`

(

- `item`

)
Model protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:741`

Available since 3.5.0

Replacement `comparator` for the `data` ModelList that defers sorting logic to the `_compare` method. The deferral is accomplished by returning `this`.

#### Parameters:

- `item` Model

  The record being evaluated for sort position

#### Returns:

Model: The record

### `_strSetter`

(

- `strings`

)
String protected

Inherited from Widget: `widget/js/Widget.js:1212`

The default setter for the strings attribute. Merges partial sets into the full string set, to allow users to partial sets of strings

#### Parameters:

- `strings` Object

#### Returns:

String: The full set of strings to set

### `_syncAttrUI`

(

- `attrs`

)
private

Inherited from Widget: `widget/js/Widget.js:1186`

Invokes the _uiSet=ATTR NAME> method for the list of attributes provided

#### Parameters:

- `attrs` Array

### `_syncMessageUI`

() protected

Provided by the datatable-message module.

Defined in `datatable/js/message.js:247`

Available since 3.5.0

Synchronizes the message UI with the table state.

### `_syncScrollCaptionUI`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:805`

Available since 3.5.0

Splits the caption from the data `<table>` if the table is configured to scroll. If not, rejoins the caption to the data `<table>` if it needs to be.

### `_syncScrollColumnWidths`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:844`

Available since 3.5.0

Assigns widths to the fixed header columns to match the columns in the data table.

### `_syncScrollHeaders`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:886`

Available since 3.5.0

Creates matching headers in the fixed header table for vertically scrolling tables and synchronizes the column widths.

### `_syncScrollPosition`

(

- `e`

)
protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:776`

Available since 3.5.0

Keeps the virtual scrollbar and the scrolling `<div>` wrapper around the data table in vertically scrolling tables in sync.

#### Parameters:

- `e` DOMEventFacade

  The scroll event

### `_syncScrollUI`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:934`

Available since 3.5.0

Wraps the table for X and Y scrolling, if necessary, if the `scrollable` attribute is set. Synchronizes dimensions and DOM placement of all scrolling related nodes.

### `_syncUI`

() protected

Inherited from Widget: `widget/js/Widget.js:964`

Updates the widget UI to reflect the attribute state.

### `_syncUIChild`

() protected

Inherited from Widget: `widget-child/js/Widget-Child.js:341`

Synchronizes the UI to match the WidgetChild state.

This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.

### `_syncXScrollUI`

(

- `xy`

)
protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:995`

Available since 3.5.0

Wraps the table in a scrolling `<div>` of the configured width for "x" scrolling.

#### Parameters:

- `xy` Boolean

  True if the table is configured with scrollable ="xy"

### `_syncYScrollUI`

(

- `xy`

)
protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:1064`

Available since 3.5.0

Wraps the table in a scrolling `<div>` of the configured height (accounting for the caption if there is one) if "y" scrolling is enabled. Otherwise, unwraps the table if necessary.

#### Parameters:

- `xy` Boolean

  True if the table is configured with scrollable = "xy"

### `_uiSetChildSelected`

(

- `selected`

)
protected

Inherited from Widget: `widget-child/js/Widget-Child.js:305`

Updates the UI to reflect the `selected` attribute value.

#### Parameters:

- `selected` Number

  The selected value to be reflected in the UI.

### `_uiSetColumnWidths`

() protected

Provided by the datatable-column-widths module.

Defined in `datatable/js/colwidths.js:254`

Available since 3.5.0

Populates the table's `<colgroup>` with a `<col>` per item in the `columns` attribute without children. It is assumed that these are the columns that have data cells renderered for them.

### `_uiSetDim`

(

- `dim`
- `val`

)
private

Inherited from Widget: `widget/js/Widget.js:997`

#### Parameters:

- `dim` String

  The dimension - "width" or "height"

- `val` Number | String

  The value to set

### `_uiSetDisabled`

(

- `val`

)
protected

Inherited from Widget: `widget/js/Widget.js:1018`

Sets the disabled state for the UI

#### Parameters:

- `val` Boolean

### `_uiSetFocused`

(

- `val`
- `src`

)
protected

Inherited from Widget: `widget/js/Widget.js:1029`

Sets the focused state for the UI

#### Parameters:

- `val` Boolean
- `src` String

  String representing the source that triggered an update to the UI.

### `_uiSetHeight`

(

- `val`

)
protected

Inherited from Widget: `widget/js/Widget.js:974`

Sets the height on the widget's bounding box element

#### Parameters:

- `val` String | Number

### `_uiSetMessage`

(

- `e`

)
protected

Provided by the datatable-message module.

Defined in `datatable/js/message.js:258`

Available since 3.5.0

Calls `hideMessage` or `showMessage` as appropriate based on the presence of records in the `data` ModelList.

This is called when `data` is reset or records are added or removed. Also, if the `showMessages` attribute is updated. In either case, if the triggering event has a `message` property on the EventFacade, it will be passed to `showMessage` (if appropriate). If no such property is on the facade, the `emptyMessage` will be used (see the strings).

#### Parameters:

- `e` EventFacade

  The columnsChange event

### `_uiSetScrollable`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:1164`

Available since 3.5.0

Assigns the appropriate class to the `boundingBox` to identify the DataTable as horizontally scrolling, vertically scrolling, or both (adds both classes).

Classes added are "yui3-datatable-scrollable-x" or "...-y"

### `_uiSetScrollbarHeight`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:1180`

Available since 3.5.0

Updates the virtual scrollbar's height to avoid overlapping with the fixed headers.

### `_uiSetScrollbarPosition`

(

- `scroller`

)
protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:1203`

Available since 3.5.0

Updates the virtual scrollbar's placement to avoid overlapping the fixed headers or the data table.

#### Parameters:

- `scroller` Node

  Reference node to position the scrollbar over

### `_uiSetSortable`

() protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:756`

Available since 3.5.0

Applies the appropriate classes to the `boundingBox` and column headers to indicate sort state and sortability.

Also currently wraps the header content of sortable columns in a `<div>` liner to give a CSS anchor for sort indicators.

### `_uiSetTabIndex`

(

- `Number`

)
protected

Inherited from Widget: `widget/js/Widget.js:1051`

Set the tabIndex on the widget's rendered UI

#### Parameters:

- `Number` Object

### `_uiSetVisible`

(

- `val`

)
protected

Inherited from Widget: `widget/js/Widget.js:1007`

Sets the visible state for the UI

#### Parameters:

- `val` Boolean

### `_uiSetWidth`

(

- `val`

)
protected

Inherited from Widget: `widget/js/Widget.js:986`

Sets the width on the widget's bounding box element

#### Parameters:

- `val` String | Number

### `_uiSetYScrollWidth`

(

- `width`

)
protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:1238`

Available since 3.5.0

Assigns the width of the `<div>` wrapping the data table in vertically scrolling tables.

If the table can't compress to the specified width, the container is expanded accordingly.

#### Parameters:

- `width` String

  The CSS width to attempt to set

### `_uiSizeCB`

(

- `expand`

)
protected

Inherited from Widget: `widget/js/Widget.js:701`

#### Parameters:

- `expand` Boolean

### `_unbindDOM`

() protected

Inherited from Widget: `widget/js/Widget.js:933`

### `_unbindScrollbar`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:1294`

Available since 3.5.0

Detaches the scroll event subscriptions used to maintain scroll position parity between the scrollable `<div>` wrapper around the data table and the virtual scrollbar for vertically scrolling tables.

### `_unbindScrollResize`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:1309`

Available since 3.5.0

Detaches the resize event subscription used to maintain column parity for vertically scrolling tables with percentage widths.

### `_unbindUI`

() protected

Inherited from Widget: `widget/js/Widget.js:894`

### `_validateSortable`

(

- `val`

)
Boolean protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:858`

Available since 3.5.0

Allows values `true`, `false`, "auto", or arrays of column names through.

#### Parameters:

- `val` Any

  The input value to `set("sortable", VAL)`

#### Returns:

Boolean:

### `_validateSortBy`

(

- `val`

)
Boolean protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:871`

Available since 3.5.0

Allows strings, arrays of strings, objects, or arrays of objects.

#### Parameters:

- `val` String | String[] | Object | Object[]

  The new `sortBy` value

#### Returns:

Boolean:

### `_validateView`

() protected

Inherited from DataTable.Base: `datatable/js/base.js:524`

Available since 3.5.0

Verifies the input value is a function with a `render` method on its prototype. `null` is also accepted to remove the default View.

### `_validTabIndex`

(

- `tabIndex`

)
protected

Inherited from Widget: `widget/js/Widget.js:1161`

#### Parameters:

- `tabIndex` Number

### `addAttr`

(

- `name`
- `config`
- `lazy`

)
Object chainable

Inherited from AttributeCore: `attribute/js/AttributeCore.js:157`

Adds an attribute with the provided configuration to the host object.

The config argument object supports the following properties:

value <Any>
  The initial value to set on the attribute
valueFn <Function | String>

  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.

  valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.

readOnly <boolean>
  Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
writeOnce <boolean> or <string>
  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.

  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)

setter <Function | String>

  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 Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.

  setter can also be set to a string, representing the name of the instance method to be used as the setter function.

getter <Function | String>

  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.

  getter can also be set to a string, representing the name of the instance method to be used as the getter function.

validator <Function | String>

  The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.

  validator can also be set to a string, representing the name of the instance method to be used as the validator function.

lazyAdd <boolean>
  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 addAttrs method.

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.

Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.

#### Parameters:

- `name` String

  The name of the attribute.

- `config` Object

  An object with attribute configuration property/value pairs, specifying the configuration for the attribute.

  NOTE: 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.

- `lazy` Boolean

  (optional) Whether or not to add this attribute lazily (on the first call to get/set).

#### Returns:

Object: A reference to the host object.

### `addAttrs`

(

- `cfgs`
- `values`
- `lazy`

)
Object chainable

Inherited from AttributeCore: `attribute/js/AttributeCore.js:805`

Configures a group of attributes, and sets initial values.

NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.

#### Parameters:

- `cfgs` Object

  An object with attribute name/configuration pairs.

- `values` Object

  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.

- `lazy` Boolean

  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 addAttr.

#### Returns:

Object: A reference to the host object.

### `addColumn`

(

- `config`
- `[index]`

)
DataTable chainable

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:60`

Available since 3.5.0

Adds the column configuration to the DataTable's `columns` configuration. If the `index` 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.

The `index` parameter is required if adding a nested column.

This method is a convienience method for fetching the DataTable's `columns` attribute, updating it, and calling `table.set('columns', _updatedColumnsDefs_)`

For example:

    // 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 ]);

#### Parameters:

- `config` Object | String

  The new column configuration object

- `[index]` Number | Number[] optional

  the insertion index

#### Returns:

DataTable:

### `addRow`

(

- `data`
- `[config]`
- `[callback]`

)
DataTable chainable

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:198`

Available since 3.5.0

Adds a new record to the DataTable's `data` ModelList. Record data can be an object of field values or an instance of the DataTable's configured `recordType` class.

This relays all parameters to the `data` ModelList's `add` method.

If a configuration object is passed as a second argument, and that object has `sync: true` set, the underlying Model will be `save()`d.

If the DataTable's `autoSync` attribute is set to `true`, the additional argument is not needed.

If syncing and the last argument is a function, that function will be used as a callback to the Model's `save()` method.

#### Parameters:

- `data` Object

  The data or Model instance for the new record

- `[config]` Object optional

  Configuration to pass along

- `[callback]` Function optional

  Callback function for Model's `save()`

  - `err` Error | Null

    If an error occurred or validation failed, this parameter will contain the error. If the sync operation succeeded, err will be `null`.

  - `response` Any

    The server's response. This value will be passed to the `parse()` method, which is expected to parse it and return an attribute hash.

#### Returns:

DataTable:

### `addRows`

(

- `data`
- `[config]`
- `[callback]`

)
DataTable chainable

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:552`

Available since 3.5.0

Adds an array of new records to the DataTable's `data` ModelList. Record data can be an array of objects containing field values or an array of instance of the DataTable's configured `recordType` class.

This relays all parameters to the `data` ModelList's `add` method.

Technically, this is an alias to `addRow`, but please use the appropriately named method for readability.

If a configuration object is passed as a second argument, and that object has `sync: true` set, the underlying Models will be `save()`d.

If the DataTable's `autoSync` attribute is set to `true`, the additional argument is not needed.

If syncing and the last argument is a function, that function will be used as a callback to each Model's `save()` method.

#### Parameters:

- `data` Object[]

  The data or Model instances to add

- `[config]` Object optional

  Configuration to pass along

- `[callback]` Function optional

  Callback function for each Model's `save()`

  - `err` Error | Null

    If an error occurred or validation failed, this parameter will contain the error. If the sync operation succeeded, err will be `null`.

  - `response` Any

    The server's response. This value will be passed to the `parse()` method, which is expected to parse it and return an attribute hash.

#### Returns:

DataTable:

### `addTarget`

(

- `o`

)

Inherited from EventTarget: `event-custom/js/event-facade.js:455`

Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified.

Events can only bubble if emitFacade is true.

Included in the event-custom-complex submodule.

#### Parameters:

- `o` EventTarget

  the target to add

### `after`

(

- `type`
- `fn`
- `[context]`
- `[arg*]`

)
EventHandle

Inherited from EventTarget: `event-custom/js/event-target.js:833`

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.

#### Parameters:

- `type` String

  The name of the event

- `fn` Function

  The callback to execute in response to the event

- `[context]` Object optional

  Override `this` object in callback

- `[arg*]` Any optional

  0..n additional arguments to supply to the subscriber

#### Returns:

EventHandle: A subscription handle capable of detaching the subscription

### `ancestor`

(

- `depth`

)
Widget

Inherited from Widget: `widget-child/js/Widget-Child.js:279`

Returns the Widget instance at the specified depth.

#### Parameters:

- `depth` Number

  Number representing the depth of the ancestor.

#### Returns:

Widget: Widget instance.

### `attrAdded`

(

- `name`

)
Boolean

Inherited from AttributeCore: `attribute/js/AttributeCore.js:341`

Checks if the given attribute has been added to the host

#### Parameters:

- `name` String

  The name of the attribute to check.

#### Returns:

Boolean: 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.

### `before`

()

Inherited from EventTarget: `event-custom/js/event-target.js:870`

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.

For DOM and custom events: type, callback, context, 0-n arguments

For methods: callback, object (method host), methodName, context, 0-n arguments

#### Returns:

detach handle

### `bindUI`

() protected

Inherited from Widget but overwritten in `datatable/js/base.js:319`

Available since 3.6.0

Attaches subscriptions to relay core change events to the view.

### `blur`

() chainable

Inherited from Widget: `widget/js/Widget.js:673`

Causes the Widget to lose focus by setting the "focused" attribute to "false"

### `bubble`

(

- `evt`

)
Boolean

Inherited from EventTarget: `event-custom/js/event-facade.js:507`

Propagate an event. Requires the event-custom-complex module.

#### Parameters:

- `evt` CustomEvent

  the custom event to propagate

#### Returns:

Boolean: the aggregated return value from Event.Custom.fire

### `delegate`

(

- `type`
- `fn`
- `spec`
- `context`
- `args`

)
EventHandle

Inherited from DataTable.Base: `datatable/js/base.js:219`

Available since 3.5.0

Pass through to `delegate()` called from the `contentBox`.

#### Parameters:

- `type` String

  the event type to delegate

- `fn` Function

  the callback function to execute. This function will be provided the event object for the delegated event.

- `spec` String | Function

  a selector that must match the target of the event or a function to test target and its parents for a match

- `context` Object

  optional argument that specifies what 'this' refers to

- `args` Any multiple

  0..n additional arguments to pass on to the callback function. These arguments will be added after the event object.

#### Returns:

EventHandle: the detach handle

### `destroy`

(

- `destroyAllNodes`

)
Widget chainable

Inherited from BaseObservable but overwritten in `widget/js/Widget.js:452`

Destroy lifecycle method. Fires the destroy event, prior to invoking destructors for the class hierarchy. Overrides Base's implementation, to support arguments to destroy

Subscribers to the destroy event can invoke preventDefault on the event object, to prevent destruction from proceeding.

#### Parameters:

- `destroyAllNodes` Boolean

  If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.

#### Returns:

Widget: A reference to this object

### `destructor`

() protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:588`

Available since 3.5.0

Cleans up external event subscriptions.

### `destructor`

() protected

Inherited from Widget but overwritten in `datatable/js/core.js:420`

Available since 3.6.0

Tears down the instance.

### `detach`

(

- `type`
- `fn`
- `context`

)
EventTarget

Inherited from EventTarget: `event-custom/js/event-target.js:346`

Detach one or more listeners the from the specified event

#### Parameters:

- `type` String | Object

  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.

- `fn` Function

  The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.

- `context` Object

  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)

#### Returns:

EventTarget: the host

### `detachAll`

(

- `type`

)

Inherited from EventTarget: `event-custom/js/event-target.js:469`

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

#### Parameters:

- `type` String

  The type, or name of the event

### `disable`

() chainable

Inherited from Widget: `widget/js/Widget.js:692`

Set the Widget's "disabled" attribute to "true".

### `enable`

() chainable

Inherited from Widget: `widget/js/Widget.js:683`

Set the Widget's "disabled" attribute to "false".

### `fire`

(

- `type`
- `arguments`

)
EventTarget

Inherited from EventTarget: `event-custom/js/event-target.js:695`

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.

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.

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.

#### Parameters:

- `type` String | Object

  The type of the event, or an object that contains a 'type' property.

- `arguments` Object*

  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.

#### Returns:

EventTarget: the event host

### `focus`

() chainable

Inherited from Widget: `widget/js/Widget.js:663`

Causes the Widget to receive the focus by setting the "focused" attribute to "true".

### `get`

(

- `name`

)
Any

Inherited from AttributeCore: `attribute/js/AttributeCore.js:353`

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.

#### Parameters:

- `name` String

  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. `get("x.y.z")`)

#### Returns:

Any: The value of the attribute

### `getAttrs`

(

- `attrs`

)
Object

Inherited from AttributeCore: `attribute/js/AttributeCore.js:762`

Gets multiple attribute values.

#### Parameters:

- `attrs` Array | boolean

  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.

#### Returns:

Object: An object with attribute name/value pairs.

### `getCell`

(

- `seed`
- `[shift]`

)
Node

Inherited from DataTable.Base: `datatable/js/base.js:253`

Available since 3.5.0

Returns the `<td>` Node from the given row and column index. Alternately, the `seed` can be a Node. If so, the nearest ancestor cell is returned. If the `seed` is a cell, it is returned. If there is no cell at the given coordinates, `null` is returned.

Optionally, include an offset array or string to return a cell near the cell identified by the `seed`. 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".

    // Previous cell in the previous row
    var cell = table.getCell(e.target, [-1, -1]);

    // Next cell
    var cell = table.getCell(e.target, 'next');
    var cell = table.getCell(e.taregt, [0, 1];

This is actually just a pass through to the `view` instance's method by the same name.

#### Parameters:

- `seed` Number[] | Node

  Array of row and column indexes, or a Node that is either the cell itself or a descendant of one.

- `[shift]` Number[] | String optional

  Offset by which to identify the returned cell Node

#### Returns:

Node:

### `getClassName`

(

- `args`

)

Inherited from Widget but overwritten in `widget/js/Widget.js:309`

Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined by the `Y.config.classNamePrefix` attribute used by `ClassNameManager` and `Widget.NAME.toLowerCase()` (e.g. "yui-widget-xxxxx-yyyyy", based on default values for the prefix and widget class name).

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.

#### Parameters:

- `args` String* multiple

  0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name

### `getColumn`

(

- `name`

)
Object

Provided by the datatable-core module.

Defined in `datatable/js/core.js:213`

Available since 3.5.0

Gets the column configuration object for the given key, name, or index. For nested columns, `name` can be an array of indexes, each identifying the index of that column in the respective parent's "children" array.

If you pass a column object, it will be returned.

For columns with keys, you can also fetch the column with `instance.get('columns.foo')`.

#### Parameters:

- `name` String | Number | Number[]

  Key, "name", index, or index array to identify the column

#### Returns:

Object: the column configuration object

### `getDefaultLocale`

() String

Inherited from Widget: `widget/js/WidgetLocale.js:153`

Returns the default locale for the widget (the locale value defined by the widget class, or provided by the user during construction).

#### Returns:

String: The default locale for the widget

### `getEvent`

(

- `type`
- `prefixed`

)
CustomEvent

Inherited from EventTarget: `event-custom/js/event-target.js:814`

Returns the custom event of the provided type has been created, a falsy value otherwise

#### Parameters:

- `type` String

  the type, or name of the event

- `prefixed` String

  if true, the type is prefixed already

#### Returns:

CustomEvent: the custom event or null

### `getRecord`

(

- `seed`

)
Model

Provided by the datatable-core module.

Defined in `datatable/js/core.js:262`

Available since 3.5.0

Returns the Model associated to the record `id`, `clientId`, or index (not row index). If none of those yield a Model from the `data` ModelList, the arguments will be passed to the `view` instance's `getRecord` method if it has one.

If no Model can be found, `null` is returned.

#### Parameters:

- `seed` Number | String | Node

  Record `id`, `clientId`, index, Node, or identifier for a row or child element

#### Returns:

Model:

### `getRow`

(

- `id`

)
Node

Inherited from DataTable.Base: `datatable/js/base.js:287`

Available since 3.5.0

Returns the `<tr>` Node from the given row index, Model, or Model's `clientId`. If the rows haven't been rendered yet, or if the row can't be found by the input, `null` is returned.

This is actually just a pass through to the `view` instance's method by the same name.

#### Parameters:

- `id` Number | String | Model

  Row index, Model instance, or clientId

#### Returns:

Node:

### `getSkinName`

(

- `[skinPrefix]`

)
String

Inherited from Widget: `widget/js/WidgetSkin.js:12`

Returns the name of the skin that's currently applied to the widget.

Searches up the Widget's ancestor axis for, by default, a class yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.

This is only really useful after the widget's DOM structure is in the document, either by render or by progressive enhancement.

#### Parameters:

- `[skinPrefix]` String optional

  The prefix which the implementation uses for the skin ("yui3-skin-" is the default).

  NOTE: skinPrefix will be used as part of a regular expression:

      new RegExp('\\b' + skinPrefix + '(\\S+)')

  Although an unlikely use case, literal characters which may result in an invalid regular expression should be escaped.

#### Returns:

String: The name of the skin, or null, if a matching skin class is not found.

### `getString`

(

- `key`

)
String deprecated

Inherited from Widget but overwritten in `widget/js/Widget.js:1225`

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get a specific string value

#### Parameters:

- `key` String

#### Returns:

String: The string

### `getStrings`

(

- `key`

)
String deprecated

Inherited from Widget but overwritten in `widget/js/Widget.js:1237`

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get the complete set of strings for the widget

#### Parameters:

- `key` String

#### Returns:

String: The strings

### `getTargets`

()

Inherited from EventTarget: `event-custom/js/event-facade.js:479`

Returns an array of bubble targets for this object.

#### Returns:

EventTarget[]

### `hide`

() chainable

Inherited from Widget: `widget/js/Widget.js:645`

Hides the Widget by setting the "visible" attribute to "false".

### `hideMessage`

() DataTable chainable

Provided by the datatable-message module.

Defined in `datatable/js/message.js:56`

Available since 3.5.0

Hides the message node.

#### Returns:

DataTable:

### `init`

(

- `cfg`

)
BaseCore chainable

Inherited from BaseObservable but overwritten in `base/js/BaseCore.js:264`

Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.

#### Parameters:

- `cfg` Object

  Object with configuration property name/value pairs

#### Returns:

BaseCore: A reference to this object

### `initializer`

() protected

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:530`

Available since 3.5.0

Publishes the events used by the mutation methods:

- addColumn
- removeColumn
- modifyColumn
- moveColumn

### `initializer`

(

- `config`

)
protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:597`

Available since 3.5.0

Initializes the columns, `recordType` and data ModelList.

#### Parameters:

- `config` Object

  Configuration object passed to constructor

### `initializer`

() protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:442`

Available since 3.5.0

Sets up the initial sort state and instance properties. Publishes events and subscribes to attribute change events to maintain internal state.

### `initializer`

() protected

Provided by the datatable-message module.

Defined in `datatable/js/message.js:184`

Available since 3.5.0

Merges in the message related strings and hooks into the rendering cycle to also render and bind the message node.

### `initializer`

() protected

Inherited from Widget but overwritten in `datatable/js/colwidths.js:186`

Available since 3.5.0

Hooks up to the rendering lifecycle to also render the `<colgroup>` and subscribe to `columnChange` events.

### `initializer`

(

- `config`

)
protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:601`

Available since 3.5.0

Sets up event handlers and AOP advice methods to bind the DataTable's natural behaviors with the scrolling APIs and state.

#### Parameters:

- `config` Object

  The config object passed to the constructor (ignored)

### `isRoot`

() Boolean

Inherited from Widget: `widget-child/js/Widget-Child.js:267`

Determines if the Widget is the root Widget in the object hierarchy.

#### Returns:

Boolean: Boolean indicating if Widget is the root Widget in the object hierarchy.

### `modifyAttr`

(

- `name`
- `config`

)

Inherited from AttributeExtras: `attribute/js/AttributeExtras.js:40`

Updates the configuration of an attribute which has already been added.

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.

#### Parameters:

- `name` String

  The name of the attribute whose configuration is to be updated.

- `config` Object

  An object with configuration property/value pairs, specifying the configuration properties to modify.

### `modifyColumn`

(

- `name`
- `config`

)
DataTable chainable

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:114`

Available since 3.5.0

Updates an existing column definition. Fires the `modifyColumn` event.

For example:

    // 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' });

#### Parameters:

- `name` String | Number | Number[] | Object

  The column key, name, index, or current configuration object

- `config` Object

  The new column configuration properties

#### Returns:

DataTable:

### `modifyRow`

(

- `id`
- `data`
- `[config]`
- `[callback]`

)
DataTable chainable

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:329`

Available since 3.5.0

Updates an existing record in the DataTable's `data` ModelList. The record can be provided explicitly or targeted by it's `id` (see ModelList's `getById` method), `clientId`, or index in the ModelList.

After locating the target Model, this relays the all other passed arguments to the Model's `setAttrs` method.

If a configuration object is passed as a second argument, and that object has `sync: true` set, the underlying Model will be `save()`d.

If the DataTable's `autoSync` attribute is set to `true`, the additional argument is not needed.

If syncing and the last argument is a function, that function will be used as a callback to the Model's `save()` method.

#### Parameters:

- `id` Object | String | Number

  The Model instance or identifier

- `data` Object

  New data values for the Model

- `[config]` Object optional

  Configuration to pass along to `setAttrs()`

- `[callback]` Function optional

  Callback function for Model's `save()`

  - `err` Error | Null

    If an error occurred or validation failed, this parameter will contain the error. If the sync operation succeeded, err will be `null`.

  - `response` Any

    The server's response. This value will be passed to the `parse()` method, which is expected to parse it and return an attribute hash.

#### Returns:

DataTable:

### `moveColumn`

(

- `name`
- `index`

)
DataTable chainable

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:153`

Available since 3.5.0

Moves an existing column to a new location. Fires the `moveColumn` event.

The destination index can be a number or array of numbers to place a column header in a nested header row.

#### Parameters:

- `name` String | Number | Number[] | Object

  The column key, name, index, or current configuration object

- `index` Number | Number[]

  The destination index of the column

#### Returns:

DataTable:

### `next`

(

- `circular`

)
Widget

Inherited from Widget: `widget-child/js/Widget-Child.js:191`

Returns the Widget's next sibling.

#### Parameters:

- `circular` Boolean

  Boolean indicating if the parent's first child should be returned if the child has no next sibling.

#### Returns:

Widget: Widget instance.

### `on`

(

- `type`
- `fn`
- `[context]`
- `[arg*]`

)
EventHandle

Inherited from EventTarget: `event-custom/js/event-target.js:188`

Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.

Callback functions for events published with `emitFacade = true` will receive an `EventFacade` as the first argument (typically named "e"). These callbacks can then call `e.preventDefault()` to disable the behavior published to that event's `defaultFn`. See the `EventFacade` API for all available properties and methods. Subscribers to non-`emitFacade` events will receive the arguments passed to `fire()` after the event name.

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.

Returning `false` from a callback is supported as an alternative to calling `e.preventDefault(); e.stopPropagation();`. However, it is recommended to use the event methods whenever possible.

#### Parameters:

- `type` String

  The name of the event

- `fn` Function

  The callback to execute in response to the event

- `[context]` Object optional

  Override `this` object in callback

- `[arg*]` Any optional

  0..n additional arguments to supply to the subscriber

#### Returns:

EventHandle: A subscription handle capable of detaching that subscription

### `once`

(

- `type`
- `fn`
- `[context]`
- `[arg*]`

)
EventHandle

Inherited from EventTarget: `event-custom/js/event-target.js:124`

Listen to a custom event hosted by this object one time. This is the equivalent to `on` except the listener is immediatelly detached when it is executed.

#### Parameters:

- `type` String

  The name of the event

- `fn` Function

  The callback to execute in response to the event

- `[context]` Object optional

  Override `this` object in callback

- `[arg*]` Any optional

  0..n additional arguments to supply to the subscriber

#### Returns:

EventHandle: A subscription handle capable of detaching the subscription

### `onceAfter`

(

- `type`
- `fn`
- `[context]`
- `[arg*]`

)
EventHandle

Inherited from EventTarget: `event-custom/js/event-target.js:146`

Listen to a custom event hosted by this object one time. This is the equivalent to `after` except the listener is immediatelly detached when it is executed.

#### Parameters:

- `type` String

  The name of the event

- `fn` Function

  The callback to execute in response to the event

- `[context]` Object optional

  Override `this` object in callback

- `[arg*]` Any optional

  0..n additional arguments to supply to the subscriber

#### Returns:

EventHandle: A subscription handle capable of detaching that subscription

### `parseType`

(

- `type`
- `[pre=this._yuievt.config.prefix]`

)
Array

Inherited from EventTarget: `event-custom/js/event-target.js:168`

Available since 3.3.0

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.

#### Parameters:

- `type` String

  the type

- `[pre=this._yuievt.config.prefix]` String optional

  the prefix

#### Returns:

Array: an array containing: * the detach category, if supplied, * the prefixed event type, * whether or not this is an after listener, * the supplied event type

### `previous`

(

- `circular`

)
Widget

Inherited from Widget: `widget-child/js/Widget-Child.js:216`

Returns the Widget's previous sibling.

#### Parameters:

- `circular` Boolean

  Boolean indicating if the parent's last child should be returned if the child has no previous sibling.

#### Returns:

Widget: Widget instance.

### `publish`

(

- `type`
- `opts`

)
CustomEvent

Inherited from EventTarget: `event-custom/js/event-target.js:493`

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.

#### Parameters:

- `type` String

  the type, or name of the event

- `opts` Object

  optional config params. Valid properties are:

  - 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)
  - 'bubbles': whether or not this event bubbles (true) Events can only bubble if emitFacade is true.
  - 'context': the default execution context for the listeners (this)
  - 'defaultFn': the default function to execute when this event fires if preventDefault was not called
  - 'emitFacade': whether or not this event emits a facade (false)
  - 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
  - 'fireOnce': if an event is configured to fire once, new subscribers after the fire will be notified immediately.
  - 'async': fireOnce event listeners will fire synchronously if the event has already fired unless async is true.
  - 'preventable': whether or not preventDefault() has an effect (true)
  - 'preventedFn': a function that is executed when preventDefault is called
  - 'queuable': whether or not this event can be queued during bubbling (false)
  - 'silent': if silent is true, debug messages are not provided for this event.
  - 'stoppedFn': a function that is executed when stopPropagation is called

  - 'monitored': specifies whether or not this event should send notifications about when the event has been attached, detached, or published.
  - 'type': the event type (valid option if not provided as the first parameter to publish)

#### Returns:

CustomEvent: the custom event

### `removeAttr`

(

- `name`

)

Inherited from AttributeExtras: `attribute/js/AttributeExtras.js:79`

Removes an attribute from the host object

#### Parameters:

- `name` String

  The name of the attribute to be removed.

### `removeColumn`

(

- `name`

)
DataTable chainable

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:178`

Available since 3.5.0

Removes an existing column. Fires the `removeColumn` event.

#### Parameters:

- `name` String | Number | Number[] | Object

  The column key, name, index, or current configuration object

#### Returns:

DataTable:

### `removeRow`

(

- `id`
- `[config]`
- `[callback]`

)
DataTable chainable

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:255`

Available since 3.5.0

Removes a record from the DataTable's `data` ModelList. The record can be provided explicitly or targeted by it's `id` (see ModelList's `getById` method), `clientId`, or index in the ModelList.

After locating the target Model, this relays the Model and all other passed arguments to the `data` ModelList's `remove` method.

If a configuration object is passed as a second argument, and that object has `sync: true` set, the underlying Model will be destroyed, passing `{ delete: true }` to trigger calling the Model's sync layer.

If the DataTable's `autoSync` attribute is set to `true`, the additional argument is not needed.

If syncing and the last argument is a function, that function will be used as a callback to the Model's `destroy()` method.

#### Parameters:

- `id` Object | String | Number

  The Model instance or identifier

- `[config]` Object optional

  Configuration to pass along

- `[callback]` Function optional

  Callback function for Model's `save()`

  - `err` Error | Null

    If an error occurred or validation failed, this parameter will contain the error. If the sync operation succeeded, err will be `null`.

  - `response` Any

    The server's response. This value will be passed to the `parse()` method, which is expected to parse it and return an attribute hash.

#### Returns:

DataTable:

### `removeTarget`

(

- `o`

)

Inherited from EventTarget: `event-custom/js/event-facade.js:489`

Removes a bubble target

#### Parameters:

- `o` EventTarget

  the target to remove

### `render`

(

- `parentNode`

)
final chainable

Inherited from Widget: `widget/js/Widget.js:513`

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).

This method should only be invoked once for an initialized widget.

It delegates to the widget specific renderer method to do the actual work.

#### Parameters:

- `parentNode` Object | String

  Optional. The Node under which the Widget is to be rendered. This can be a Node instance or a CSS selector string.

  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.

### `renderer`

() protected

Inherited from Widget: `widget/js/Widget.js:588`

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.

### `renderUI`

() protected

Inherited from Widget: `widget/js/Widget.js:622`

Adds nodes to the DOM

This method is not called by framework and is not chained automatically for the class hierarchy.

### `reset`

(

- `name`

)
Object chainable

Inherited from AttributeExtras: `attribute/js/AttributeExtras.js:89`

Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.

#### Parameters:

- `name` String

  Optional. The name of the attribute to reset. If omitted, all attributes are reset.

#### Returns:

Object: A reference to the host object.

### `scrollTo`

(

- `id`

)
DataTable chainable

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:79`

Available since 3.5.0

Scrolls a given row or cell into view if the table is scrolling. Pass the `clientId` of a Model from the DataTable's `data` 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 `node.scrollIntoView()` yourself, but hey, whatever).

#### Parameters:

- `id` String | Number | Number[] | Node

  A row clientId, row index, cell coordinate array, id string, or Node

#### Returns:

DataTable:

### `set`

(

- `name`
- `value`
- `[opts]`

)
Object chainable

Inherited from AttributeObservable but overwritten in `attribute/js/AttributeCore.js:410`

Sets the value of an attribute.

#### Parameters:

- `name` String

  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. `set("x.y.z", 5)`).

- `value` Any

  The value to set the attribute to.

- `[opts]` Object optional

  Optional data providing the circumstances for the change.

#### Returns:

Object: A reference to the host object.

### `setAttrs`

(

- `attrs`
- `[opts]`

)
Object chainable

Inherited from AttributeObservable but overwritten in `attribute/js/AttributeCore.js:729`

Sets multiple attribute values.

#### Parameters:

- `attrs` Object

  An object with attributes name/value pairs.

- `[opts]` Object optional

  Optional data providing the circumstances for the change.

#### Returns:

Object: A reference to the host object.

### `setColumnWidth`

(

- `id`
- `width`

)
DataTable chainable

Provided by the datatable-column-widths module.

Defined in `datatable/js/colwidths.js:138`

Available since 3.5.0

Assigns the style width of the `<col>` representing the column identifed by `id` and updates the column configuration.

Pass the empty string for `width` to return a column to auto sizing.

This does not trigger a `columnsChange` event today, but I can be convinced that it should.

#### Parameters:

- `id` Number | String | Object

  The column config object or key, name, or index of a column in the host's `_displayColumns` array.

- `width` Number | String

  CSS width value. Numbers are treated as pixels

#### Returns:

DataTable:

### `show`

() chainable

Inherited from Widget: `widget/js/Widget.js:654`

Shows the Widget by setting the "visible" attribute to "true".

### `showMessage`

(

- `message`

)
DataTable chainable

Provided by the datatable-message module.

Defined in `datatable/js/message.js:71`

Available since 3.5.0

Display the message node and set its content to `message`. If there is a localized `strings` entry for the value of `message`, that string will be used.

#### Parameters:

- `message` String

  The message name or message itself to display

#### Returns:

DataTable:

### `sort`

(

- `fields`
- `[payload]`

)
DataTable chainable

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:173`

Available since 3.5.0

Sort the data in the `data` ModelList and refresh the table with the new order.

Acceptable values for `fields` are `key` strings or objects with a single property, the column `key`, with a value of 1, -1, "asc", or "desc". E.g. `{ username: 'asc' }`. String values are assumed to be ascending.

Example values would be:

- `"username"` - sort by the data's `username` field or the `key` associated to a column with that `name`.
- `{ username: "desc" }` - sort by `username` in descending order. Alternately, use values "asc", 1 (same as "asc"), or -1 (same as "desc").
- `["lastName", "firstName"]` - ascending sort by `lastName`, but for records with the same `lastName`, ascending subsort by `firstName`. Array can have as many items as you want.
- `[{ lastName: -1 }, "firstName"]` - descending sort by `lastName`, ascending subsort by `firstName`. Mixed types are ok.

#### Parameters:

- `fields` String | String[] | Object | Object[]

  The field(s) to sort by

- `[payload]` Object optional

  Extra `sort` event payload you want to send along

#### Returns:

DataTable:

### `subscribe`

() deprecated

Inherited from EventTarget: `event-custom/js/event-target.js:336`

Deprecated: use on

subscribe to an event

### `syncUI`

()

Inherited from Widget but overwritten in `datatable/js/base.js:512`

Available since 3.5.0

Fires the `renderView` event, delegating UI updates to the configured View.

### `toggleSort`

(

- `fields`
- `[payload]`

)
DataTable chainable

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:229`

Available since 3.5.0

Reverse the current sort direction of one or more fields currently being sorted by.

Pass the `key` of the column or columns you want the sort order reversed for.

#### Parameters:

- `fields` String | String[]

  The field(s) to reverse sort order for

- `[payload]` Object optional

  Extra `sort` event payload you want to send along

#### Returns:

DataTable:

### `toString`

() String

Inherited from BaseCore but overwritten in `widget/js/Widget.js:1107`

Generic toString implementation for all widgets.

#### Returns:

String: The default string value for the widget [ displays the NAME of the instance, and the unique id ]

### `unsubscribe`

() deprecated

Inherited from EventTarget: `event-custom/js/event-target.js:459`

Deprecated: use detach

detach a listener

### `unsubscribeAll`

(

- `type`

)
deprecated

Inherited from EventTarget: `event-custom/js/event-target.js:480`

Deprecated: use detachAll

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

#### Parameters:

- `type` String

  The type, or name of the event

## Properties

### `_allowAdHocAttrs`

Boolean protected

Inherited from BaseCore but overwritten in `datatable/js/core.js:295`

Available since 3.6.0

This tells `Y.Base` 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).

Default: true

### `_CAPTION_TABLE_TEMPLATE`

HTML protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:122`

Available since 3.5.0

Template for the `<table>` that is used to fix the caption in place when the table is horizontally scrolling.

### `_columnMap`

Object protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:308`

Available since 3.5.0

A map of column key to column configuration objects parsed from the `columns` attribute.

Default: undefined (initially unset)

### `_displayColumns`

Object[]

Inherited from DataTable.Base: `datatable/js/base.js:377`

Available since 3.5.0

Array of the columns that correspond to those with value cells in the data rows. Excludes colspan header columns (configured with `children`).

### `_messageNode`

Node

Provided by the datatable-message module.

Defined in `datatable/js/message.js:237`

Available since 3.5.0

Node used to display messages from `showMessage`.

### `_SCROLL_LINER_TEMPLATE`

HTML protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:134`

Available since 3.5.0

Template used to create sizable element liners around header content to synchronize fixed header column widths.

### `_SCROLLBAR_TEMPLATE`

HTML protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:146`

Available since 3.5.0

Template for the virtual scrollbar needed in "y" and "xy" scrolling setups.

### `_sortable`

Object[] protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:718`

Available since 3.5.0

Array of column configuration objects of those columns that need UI setup for user interaction.

### `_sortBy`

Object[] protected

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:729`

Available since 3.5.0

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.

### `_tableNode`

Node protected

Provided by the datatable-core module.

Defined in `datatable/js/core.js:320`

Available since 3.5.0

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.

Default: undefined (initially unset)

### `_UI_ATTRS`

Object private

Inherited from Widget: `widget/js/Widget.js:1249`

The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations

### `_X_SCROLLER_TEMPLATE`

HTML protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:157`

Available since 3.5.0

Template for the `<div>` that is used to contain the table when the table is horizontally scrolling.

### `_xScroll`

Boolean private

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:1324`

Available since 3.5.0

Indicates horizontal table scrolling is enabled.

Default: undefined (not initially set)

### `_xScrollNode`

Node protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:1368`

Available since 3.5.0

Overflow Node used to contain the table headers and data in a horizontally scrolling table.

Default: undefined (not initially set)

### `_Y_SCROLL_HEADER_TEMPLATE`

HTML protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:169`

Available since 3.5.0

Template for the `<table>` used to contain the fixed column headers for vertically scrolling tables.

### `_Y_SCROLLER_TEMPLATE`

HTML protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:181`

Available since 3.5.0

Template for the `<div>` that is used to contain the rows when the table is vertically scrolling.

### `_yScroll`

Boolean private

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:1335`

Available since 3.5.0

Indicates vertical table scrolling is enabled.

Default: undefined (not initially set)

### `_yScrollHeader`

Node protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:1346`

Available since 3.5.0

Fixed column header `<table>` Node for vertical scrolling tables.

Default: undefined (not initially set)

### `_yScrollNode`

Node protected

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:1357`

Available since 3.5.0

Overflow Node used to contain the data rows in a vertically scrolling table.

Default: undefined (not initially set)

### `BOUNDING_TEMPLATE`

String

Inherited from Widget: `widget/js/Widget.js:1145`

Property defining the markup template for bounding box.

### `COL_TEMPLATE`

HTML

Provided by the datatable-column-widths module.

Defined in `datatable/js/colwidths.js:118`

Available since 3.5.0

The HTML template used to create the table's `<col>`s.

Default: '<col/>'

### `COLGROUP_TEMPLATE`

HTML

Provided by the datatable-column-widths module.

Defined in `datatable/js/colwidths.js:128`

Available since 3.5.0

The HTML template used to create the table's `<colgroup>`.

Default: '<colgroup/>'

### `CONTENT_TEMPLATE`

String

Inherited from Widget: `widget/js/Widget.js:1135`

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.

### `data`

ModelList

Provided by the datatable-core module.

Defined in `datatable/js/core.js:201`

Available since 3.5.0

The ModelList that manages the table's data.

Default: undefined (initially unset)

### `DEF_PARENT_NODE`

String | Node

Inherited from Widget: `widget/js/Widget.js:1126`

Default node to render the bounding box to. If not set, will default to the current document body.

### `DEF_UNIT`

String

Inherited from Widget: `widget/js/Widget.js:1118`

Default unit to use for dimension values

### `MESSAGE_TEMPLATE`

HTML

Provided by the datatable-message module.

Defined in `datatable/js/message.js:46`

Available since 3.5.0

Template used to generate the node that will be used to report messages.

Default: <tbody class="{className}"><td class="{contentClass}" colspan="{colspan}"></td></tbody>

### `name`

String deprecated

Inherited from BaseCore: `base/js/BaseCore.js:242`

Deprecated: Use this.constructor.NAME

The string used to identify the class of this object.

### `SORTABLE_HEADER_TEMPLATE`

HTML

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:218`

Available since 3.5.0

Template for the node that will wrap the header content for sortable columns.

### `UI_EVENTS`

Object

Inherited from Widget: `widget/js/WidgetUIEvents.js:52`

Map of DOM events that should be fired as Custom Events by the Widget instance.

## Attributes

### `autoSync`

Boolean

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:40`

Available since 3.5.0

Controls whether `addRow`, `removeRow`, and `modifyRow` should trigger the underlying Model's sync layer by default.

When `true`, it is unnecessary to pass the "sync" configuration property to those methods to trigger per-operation sync.

Default: `false`

#### Fires event `autoSyncChange`

Fires when the value for the configuration attribute `autoSync` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `bodyConfig`

Object protected

Inherited from DataTable.Base: `datatable/js/base.js:662`

Available since 3.6.0

Configuration object passed to the class constructor in `bodyView` during render.

Default: undefined (initially unset)

#### Fires event `bodyConfigChange`

Fires when the value for the configuration attribute `bodyConfig` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `bodyView`

Function

Inherited from DataTable.Base: `datatable/js/base.js:639`

Available since 3.5.0

If the View class assigned to the DataTable's `view` attribute supports it, this class will be used for rendering the contents of the `<tbody>` including all data rows.

Similar to `view`, the instance of this View will be assigned to the DataTable instance's `body` property.

It is not strictly necessary that the class function assigned here be a View subclass. It must however have a `render()` method.

Default: Y.DataTable.BodyView

#### Fires event `bodyViewChange`

Fires when the value for the configuration attribute `bodyView` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `boundingBox`

String | Node

Inherited from Widget: `widget/js/Widget.js:175`

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.

#### Fires event `boundingBoxChange`

Fires when the value for the configuration attribute `boundingBox` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `caption`

HTML

Provided by the datatable-core module.

Defined in `datatable/js/core.js:153`

Available since 3.5.0

HTML content of an optional `<caption>` element to appear above the table. Leave this config unset or set to a falsy value to remove the caption.

Default: '' (empty string)

#### Fires event `captionChange`

Fires when the value for the configuration attribute `caption` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `columns`

Object[] | String[]

Provided by the datatable-core module.

Defined in `datatable/js/core.js:39`

Available since 3.5.0

Columns to include in the rendered table.

If omitted, the attributes on the configured `recordType` or the first item in the `data` collection will be used as a source.

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 `columns: ['first', 'last']` becomes `columns: [{ key: 'first' }, { key: 'last' }]`.

DataTable.Core only concerns itself with a few properties of columns. These properties are:

- `key` - Used to identify the record field/attribute containing content for this column. Also used to create a default Model if no `recordType` or `data` are provided during construction. If `name` is not specified, this is assigned to the `_id` property (with added incrementer if the key is used by multiple columns).
- `children` - Traversed to initialize nested column objects
- `name` - Used in place of, or in addition to, the `key`. Useful for columns that aren't bound to a field/attribute in the record data. This is assigned to the `_id` property.
- `id` - 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.
- `field` - For backward compatibility. Implementers should use `name`.
- `_id` - Assigned unique-within-this-instance id for a column. By order of preference, assumes the value of `name`, `key`, `id`, or `_yuid`. 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 `key`.
- `_yuid` - Guid stamp assigned to the column object.
- `_parent` - Assigned to all child columns, referencing their parent column.

Default: (from `recordType` ATTRS or first item in the `data`)

#### Fires event `columnsChange`

Fires when the value for the configuration attribute `columns` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `columnset`

Object[] deprecated

Provided by the datatable-core module.

Defined in `datatable/js/core.js:181`

Deprecated: Use the `columns` attribute

Available since 3.5.0

Deprecated as of 3.5.0. Passes through to the `columns` attribute.

WARNING: `get('columnset')` will NOT return a Columnset instance as of 3.5.0. This is a break in backward compatibility.

#### Fires event `columnsetChange`

Fires when the value for the configuration attribute `columnset` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `contentBox`

String | Node

Inherited from Widget: `widget/js/Widget.js:189`

A DOM node that is a direct descendant of a Widget's bounding box that houses its content.

#### Fires event `contentBoxChange`

Fires when the value for the configuration attribute `contentBox` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `data`

ModelList | Object[]

Provided by the datatable-core module.

Defined in `datatable/js/core.js:119`

Available since 3.5.0

The collection of data records to display. This attribute is a pass through to a `data` property, which is a ModelList instance.

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 `recordType` as its `model` property and seeded with the array.

Retrieving this attribute will return the ModelList stored in the `data` property.

Default: `new ModelList()`

#### Fires event `dataChange`

Fires when the value for the configuration attribute `data` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `destroyed`

Boolean readonly

Inherited from BaseCore: `base/js/BaseCore.js:157`

Flag indicating whether or not this object has been through the destroy lifecycle phase.

Default: false

#### Fires event `destroyedChange`

Fires when the value for the configuration attribute `destroyed` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `disabled`

Boolean

Inherited from Widget: `widget/js/Widget.js:231`

Boolean indicating if the Widget should be disabled. The disabled implementation is left to the specific classes extending widget.

Default: false

#### Fires event `disabledChange`

Fires when the value for the configuration attribute `disabled` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `focused`

Boolean readonly

Inherited from Widget: `widget/js/Widget.js:218`

Boolean indicating if the Widget, or one of its descendants, has focus.

Default: false

#### Fires event `focusedChange`

Fires when the value for the configuration attribute `focused` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `footerConfig`

Object protected

Inherited from DataTable.Base: `datatable/js/base.js:627`

Available since 3.6.0

Configuration object passed to the class constructor in `footerView` during render.

Default: undefined (initially unset)

#### Fires event `footerConfigChange`

Fires when the value for the configuration attribute `footerConfig` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `footerView`

Function | Object

Inherited from DataTable.Base: `datatable/js/base.js:607`

Available since 3.5.0

If the View class assigned to the DataTable's `view` attribute supports it, this class will be used for rendering the contents of the `<tfoot>`.

Similar to `view`, the instance of this View will be assigned to the DataTable instance's `foot` property.

It is not strictly necessary that the class function assigned here be a View subclass. It must however have a `render()` method.

#### Fires event `footerViewChange`

Fires when the value for the configuration attribute `footerView` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `headerConfig`

Object protected

Inherited from DataTable.Base: `datatable/js/base.js:595`

Available since 3.6.0

Configuration object passed to the class constructor in `headerView` during render.

Default: undefined (initially unset)

#### Fires event `headerConfigChange`

Fires when the value for the configuration attribute `headerConfig` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `headerView`

Function | Object

Inherited from DataTable.Base: `datatable/js/base.js:572`

Available since 3.5.0

If the View class assigned to the DataTable's `view` attribute supports it, this class will be used for rendering the contents of the `<thead>`—the column headers for the table.

Similar to `view`, the instance of this View will be assigned to the DataTable instance's `head` property.

It is not strictly necessary that the class function assigned here be a View subclass. It must however have a `render()` method.

Default: Y.DataTable.HeaderView

#### Fires event `headerViewChange`

Fires when the value for the configuration attribute `headerView` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `height`

String | Number

Inherited from Widget: `widget/js/Widget.js:252`

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.

Default: EMPTY_STR

#### Fires event `heightChange`

Fires when the value for the configuration attribute `height` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `id`

String

Inherited from Widget: `widget/js/Widget.js:149`

Default: Generated using guid()

#### Fires event `idChange`

Fires when the value for the configuration attribute `id` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `initialized`

Boolean readonly

Inherited from BaseCore: `base/js/BaseCore.js:143`

Flag indicating whether or not this object has been through the init lifecycle phase.

Default: false

#### Fires event `initializedChange`

Fires when the value for the configuration attribute `initialized` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `locale`

String deprecated

Inherited from Widget: `widget/js/WidgetLocale.js:17`

Deprecated: Use Y.config.lang and Y.Intl externalization support

The default locale for the widget. NOTE: Using get/set on the "strings" attribute will return/set strings for this locale.

Default: "en"

#### Fires event `localeChange`

Fires when the value for the configuration attribute `locale` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `recordset`

Object[] | Recordset deprecated

Provided by the datatable-core module.

Defined in `datatable/js/core.js:164`

Deprecated: Use the `data` attribute

Available since 3.5.0

Deprecated as of 3.5.0. Passes through to the `data` attribute.

WARNING: `get('recordset')` will NOT return a Recordset instance as of 3.5.0. This is a break in backward compatibility.

#### Fires event `recordsetChange`

Fires when the value for the configuration attribute `recordset` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `recordType`

Function

Provided by the datatable-core module.

Defined in `datatable/js/core.js:87`

Available since 3.5.0

Model subclass to use as the `model` for the ModelList stored in the `data` attribute.

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:

1. If the `data` attribute is set with a ModelList instance and its `model` property is set, that will be used.
2. If the `data` attribute is set with a ModelList instance, and its `model` property is unset, but it is populated, the `ATTRS` of the `constructor of the first item will be used.
3. If the `data` attribute is set with a non-empty array, a Model subclass will be generated using the keys of the first item as its `ATTRS` (see the `_createRecordClass` method).
4. If the `columns` attribute is set, a Model subclass will be generated using the columns defined with a `key`. This is least desirable because columns can be duplicated or nested in a way that's not parsable.
5. If neither `data` nor `columns` is set or populated, a change event subscriber will listen for the first to be changed and try all over again.

Default: (see description)

#### Fires event `recordTypeChange`

Fires when the value for the configuration attribute `recordType` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `render`

Boolean | Node

Inherited from Widget: `widget/js/Widget.js:286`

Whether or not to render the widget automatically after init, and optionally, to which parent node.

#### Fires event `renderChange`

Fires when the value for the configuration attribute `render` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `rendered`

Boolean readonly

Inherited from Widget: `widget/js/Widget.js:161`

Flag indicating whether or not this Widget has been through the render lifecycle phase.

Default: false

#### Fires event `renderedChange`

Fires when the value for the configuration attribute `rendered` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `scrollable`

String | Boolean

Provided by the datatable-scroll module.

Defined in `datatable/js/scroll.js:55`

Available since 3.5.0

Activates or deactivates scrolling in the table. Acceptable values are:

- `false` - (default) Scrolling is disabled.
- `true` or 'xy' - If `height` is set, vertical scrolling will be activated, if `width` is set, horizontal scrolling will be activated.
- 'x' - Activate horizontal scrolling only. Requires the `width` attribute is also set.
- 'y' - Activate vertical scrolling only. Requires the `height` attribute is also set.

#### Fires event `scrollableChange`

Fires when the value for the configuration attribute `scrollable` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `showMessages`

Boolean

Provided by the datatable-message module.

Defined in `datatable/js/message.js:29`

Available since 3.5.0

Enables the display of messages in the table. Setting this to false will prevent the message Node from being created and `showMessage` from doing anything.

Default: true

#### Fires event `showMessagesChange`

Fires when the value for the configuration attribute `showMessages` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `sortable`

String | String[] | Boolean

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:112`

Available since 3.5.0

Controls which column headers can trigger sorting by user clicks.

Acceptable values are:

- "auto" - (default) looks for `sortable: true` in the column configurations
- `true` - all columns are enabled
- `false - no UI sortable is enabled
- {String[]} - array of key names to give sortable headers

Default: "auto"

#### Fires event `sortableChange`

Fires when the value for the configuration attribute `sortable` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `sortBy`

String | String[] | Object | Object[]

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:132`

Available since 3.5.0

The current sort configuration to maintain in the data.

Accepts column `key` strings or objects with a single property, the column `key`, with a value of 1, -1, "asc", or "desc". E.g. `{ username: 'asc' }`. String values are assumed to be ascending.

Example values would be:

- `"username"` - sort by the data's `username` field or the `key` associated to a column with that `name`.
- `{ username: "desc" }` - sort by `username` in descending order. Alternately, use values "asc", 1 (same as "asc"), or -1 (same as "desc").
- `["lastName", "firstName"]` - ascending sort by `lastName`, but for records with the same `lastName`, ascending subsort by `firstName`. Array can have as many items as you want.
- `[{ lastName: -1 }, "firstName"]` - descending sort by `lastName`, ascending subsort by `firstName`. Mixed types are ok.

#### Fires event `sortByChange`

Fires when the value for the configuration attribute `sortBy` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `srcNode`

String | Node

Inherited from Widget: `widget/js/WidgetHTMLParser.js:58`

The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition

#### Fires event `srcNodeChange`

Fires when the value for the configuration attribute `srcNode` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `strings`

Object

Inherited from Widget but overwritten in `datatable/js/sort.js:160`

Available since 3.5.0

Strings containing language for sorting tooltips.

Default: (strings for current lang configured in the YUI instance config)

#### Fires event `stringsChange`

Fires when the value for the configuration attribute `strings` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `summary`

String

Provided by the datatable-core module.

Defined in `datatable/js/core.js:142`

Available since 3.5.0

Content for the `<table summary="ATTRIBUTE VALUE HERE">`. Values assigned to this attribute will be HTML escaped for security.

Default: '' (empty string)

#### Fires event `summaryChange`

Fires when the value for the configuration attribute `summary` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `tabIndex`

Number

Inherited from Widget: `widget/js/Widget.js:202`

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.

Default: null

#### Fires event `tabIndexChange`

Fires when the value for the configuration attribute `tabIndex` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `view`

Function

Inherited from DataTable.Base: `datatable/js/base.js:538`

Available since 3.6.0

The View class used to render the `<table>` into the Widget's `contentBox`. This View can handle the entire table rendering itself or delegate to other Views.

It is not strictly necessary that the class function assigned here be a View subclass. It must however have a `render()` method.

When the DataTable is rendered, an instance of this View will be created and its `render()` method called. The View instance will be assigned to the DataTable instance's `view` property.

Default: Y.DataTable.TableView

#### Fires event `viewChange`

Fires when the value for the configuration attribute `view` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `viewConfig`

Object protected

Inherited from DataTable.Base: `datatable/js/base.js:560`

Available since 3.6.0

Configuration object passed to the class constructor in `view` during render.

Default: undefined (initially unset)

#### Fires event `viewConfigChange`

Fires when the value for the configuration attribute `viewConfig` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `visible`

Boolean

Inherited from Widget: `widget/js/Widget.js:242`

Boolean indicating whether or not the Widget is visible.

Default: TRUE

#### Fires event `visibleChange`

Fires when the value for the configuration attribute `visible` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

### `width`

String | Number

Inherited from Widget: `widget/js/Widget.js:263`

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.

Default: EMPTY_STR

#### Fires event `widthChange`

Fires when the value for the configuration attribute `width` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed.

#### Parameters:

- `e` EventFacade
  An Event Facade object with the following attribute-specific properties added:
  - `prevVal` Any
    The value of the attribute, prior to it being set.
  - `newVal` Any
    The value the attribute is to be set to.
  - `attrName` String
    The name of the attribute being set.
  - `subAttrName` String
    If setting a property within the attribute's value, the name of the sub-attribute property being set.

## Events

### `addColumn`

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:592`

Available since 3.5.0

Fired by the `addColumn` method.

#### Event Payload:

- `column` Object

  The new column definition object

- `index` Number | Number[]

  The array index to insert the new column

### `destroy`

Inherited from BaseObservable: `base/js/BaseObservable.js:151`

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.

Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction).

#### Event Payload:

- `e` EventFacade

  Event object

### `init`

Inherited from BaseObservable: `base/js/BaseObservable.js:62`

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.

Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).

#### Event Payload:

- `e` EventFacade

  Event object, with a cfg property which refers to the configuration object passed to the constructor.

### `modifyColumn`

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:611`

Available since 3.5.0

Fired by the `modifyColumn` method.

#### Event Payload:

- `column` Object | String | Number | Number[]

  The column definition object or identifier

- `newColumnDef` Object

  The properties to assign to the column

### `moveColumn`

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:621`

Available since 3.5.0

Fired by the `moveColumn` method.

#### Event Payload:

- `column` Object | String | Number | Number[]

  The column definition object or identifier

- `index` Object

  The destination index to move to

### `removeColumn`

Provided by the datatable-mutable module.

Defined in `datatable/js/mutable.js:602`

Available since 3.5.0

Fired by the `removeColumn` method.

#### Event Payload:

- `column` Object | String | Number | Number[]

  The column definition object or identifier

### `render`

Inherited from Widget: `widget/js/Widget.js:543`

Lifecycle event for the render phase, fired prior to rendering the UI for the widget (prior to invoking the widget's renderer method).

Subscribers to the "on" moment of this event, will be notified before the widget is rendered.

Subscribers to the "after" moment of this event, will be notified after rendering is complete.

#### Event Payload:

- `e` EventFacade

  The Event Facade

### `sort`

Provided by the datatable-sort module.

Defined in `datatable/js/sort.js:201`

Notifies of an impending sort, either from clicking on a column header, or from a call to the `sort` or `toggleSort` method.

The requested sort is available in the `sortBy` property of the event.

The default behavior of this event sets the table's `sortBy` attribute.

#### Event Payload:

- `sortBy` String | String[] | Object | Object[]

  The requested sort

### `widget:contentUpdate`

Inherited from Widget: `widget/js/Widget.js:397`

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).

#### Event Payload:

- `e` EventFacade

  The Event Facade