Features
The table controls and information elements that are placed around a DataTable are termed "features", each with its own configuration options. Placement of the features is defined by the layout option, where each slot can contain a feature descriptor.
DataTables has five built in features:
div- Create a text / HTML containerinfo- Summary information about the tablepageLength- Page length controlpaging- Pagination controlsearch- Global search input
New features can be added using the DataTable.feature.register() method and this is extensively used by the extensions for DataTables.
The table below lists the full set of features and their options that are available through DataTables and its extensions.
| Name | Summary | Library | Group |
|---|---|---|---|
Table control buttons | Buttons | ||
List of buttons to be created | Buttons | ||
Action to take when the button is activated | Buttons | ||
Indicate that a button's action processing should be performed asynchronously. | Buttons | ||
Collection of attribute key / values to set for a button | Buttons | ||
Ensure that any requirements have been satisfied before initialising a button | Buttons | ||
Set the class name for the button | Buttons | ||
Function that is called when the button is destroyed | Buttons | ||
Show a dropdown (further action) icon | Buttons | ||
Set a button's initial enabled state | Buttons | ||
Define which button type the button should be based on | Buttons | ||
Initialisation function that can be used to add events specific to this button | Buttons | ||
Define an activation key for a button | Buttons | ||
Set a name for each selection | Buttons | ||
Unique namespace for every button | Buttons | ||
Split dropdown buttons | Buttons | ||
Set the tag for the button | Buttons | ||
The text to show in the button | Buttons | ||
Button | Buttons | ||
Set a name for the instance for the group selector | Buttons | ||
Text / HTML container | DataTables | div | |
Set the class name for the created element. | DataTables | div | |
Set the HTML content for the element. | DataTables | div | |
Set the ID for the created element. | DataTables | div | |
Set the text content for the element. | DataTables | div | |
Table information display | DataTables | info | |
Information display callback | DataTables | info | |
Empty table text | DataTables | info | |
Information string postfix | DataTables | info | |
Appended to the info string when searching is active | DataTables | info | |
Table summary information display string | DataTables | info | |
Paging length control | DataTables | pageLength | |
Text for page length control | DataTables | pageLength | |
Text for page length control | DataTables | pageLength | |
Pagination buttons | DataTables | paging | |
Include (or not) the leading first and last page in the numbers. | DataTables | paging | |
Set the maximum number of paging number buttons | DataTables | paging | |
Include (or not) the first and last buttons in the paging control. | DataTables | paging | |
Include (or not) the numbers in the paging control. | DataTables | paging | |
Include (or not) the previous and next buttons in the paging control. | DataTables | paging | |
Paging button display options | DataTables | paging | |
Global search input | DataTables | search | |
Limit the search to a specific subset of columns | DataTables | search | |
Placeholder for the input element | DataTables | search | |
Show processing indicator when searching | DataTables | search | |
Text for search control | DataTables | search | |
Enable and configure the SearchBuilder extension for DataTables | SearchBuilder | ||
Restrict which columns can be filtered on | SearchBuilder | ||
Define custom conditions for SearchBuilder | SearchBuilder | ||
Impose a limit on the depth of the groups | SearchBuilder | ||
Trigger a search on the enter key rather than every keypress | SearchBuilder | ||
Function to update title text when selections are made. | SearchBuilder | ||
Removes the colours from SearchBuilder | SearchBuilder | ||
Control live search operation | SearchBuilder | ||
Set the default logic operator | SearchBuilder | ||
Set a predefined search query | SearchBuilder |