#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# datatable Module

User Guide & Examples
Defined in: `datatable/js/table.js:16`

A Widget for displaying tabular data. The base implementation of DataTable provides the ability to dynamically generate an HTML table from a set of column configurations and row data.

Two classes are included in the `datatable-base` module: `Y.DataTable` and `Y.DataTable.Base`.

This module provides the following classes:

- DataTable
- DataTable.Base
- DataTable.BodyView
- DataTable.BodyView.Formatters
- DataTable.ColumnWidths
- DataTable.Core
- DataTable.HeaderView
- DataTable.Message
- DataTable.Mutable
- DataTable.Sortable
- DataTable.TableView
- Plugin.DataTableDataSource

This module is a rollup of the following modules:

- datatable-base
  A Widget for displaying tabular data. The base implementation of DataTable provides the ability to dynamically generate an HTML table from a set of column configurations and row data. Two classes are included in the `datatable-base` module: `Y.DataTable` and `Y.DataTable.Base`.
- datatable-body
  View class responsible for rendering the `<tbody>` section of a table. Used as the default `bodyView` for `Y.DataTable.Base` and `Y.DataTable` classes.
- datatable-column-widths
  Adds basic, programmatic column width support to DataTable via column configuration property `width` and method `table.setColumnWidth(id, width);`.
- datatable-core
  The core implementation of the `DataTable` and `DataTable.Base` Widgets.
- datatable-datasource
  Plugs DataTable with DataSource integration.
- datatable-formatters
  Adds predefined cell formatters to `Y.DataTable.BodyView`.
- datatable-head
  View class responsible for rendering the `<thead>` section of a table. Used as the default `headerView` for `Y.DataTable.Base` and `Y.DataTable` classes.
- datatable-message
  Adds support for a message container to appear in the table. This can be used to indicate loading progress, lack of records, or any other communication needed.
- datatable-mutable
  Adds mutation convenience methods such as `table.addRow(data)` to `Y.DataTable`. (or other built class).
- datatable-sort
  Adds support for sorting the table data by API methods `table.sort(...)` or `table.toggleSort(...)` or by clicking on column headers in the rendered UI.
- datatable-table
  View class responsible for rendering a `<table>` from provided data. Used as the default `view` for `Y.DataTable.Base` and `Y.DataTable` classes.