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 container
  • info - Summary information about the table
  • pageLength - Page length control
  • paging - Pagination control
  • search - 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

buttons

Table control buttons

Buttons

buttons.buttons

List of buttons to be created

Buttons

buttons.buttons.action

Action to take when the button is activated

Buttons

buttons.buttons.async

Indicate that a button's action processing should be performed asynchronously.

Buttons

buttons.buttons.attr

Collection of attribute key / values to set for a button

Buttons

buttons.buttons.available

Ensure that any requirements have been satisfied before initialising a button

Buttons

buttons.buttons.className

Set the class name for the button

Buttons

buttons.buttons.destroy

Function that is called when the button is destroyed

Buttons

buttons.buttons.dropIcon

Show a dropdown (further action) icon

Buttons

buttons.buttons.enabled

Set a button's initial enabled state

Buttons

buttons.buttons.extend

Define which button type the button should be based on

Buttons

buttons.buttons.init

Initialisation function that can be used to add events specific to this button

Buttons

buttons.buttons.key

Define an activation key for a button

Buttons

buttons.buttons.name

Set a name for each selection

Buttons

buttons.buttons.namespace

Unique namespace for every button

Buttons

buttons.buttons.split

Split dropdown buttons

Buttons

buttons.buttons.tag

Set the tag for the button

Buttons

buttons.buttons.text

The text to show in the button

Buttons

buttons.buttons.titleAttr

Button title attribute text

Buttons

buttons.name

Set a name for the instance for the group selector

Buttons

div

Text / HTML container

DataTablesdiv

div.className

Set the class name for the created element.

DataTablesdiv

div.html

Set the HTML content for the element.

DataTablesdiv

div.id

Set the ID for the created element.

DataTablesdiv

div.text

Set the text content for the element.

DataTablesdiv

info

Table information display

DataTablesinfo

info.callback

Information display callback

DataTablesinfo

info.empty

Empty table text

DataTablesinfo

info.postfix

Information string postfix

DataTablesinfo

info.search

Appended to the info string when searching is active

DataTablesinfo

info.text

Table summary information display string

DataTablesinfo

pageLength

Paging length control

DataTablespageLength

pageLength.menu

Text for page length control

DataTablespageLength

pageLength.text

Text for page length control

DataTablespageLength

paging

Pagination buttons

DataTablespaging

paging.boundaryNumbers

Include (or not) the leading first and last page in the numbers.

DataTablespaging

paging.buttons

Set the maximum number of paging number buttons

DataTablespaging

paging.firstLast

Include (or not) the first and last buttons in the paging control.

DataTablespaging

paging.numbers

Include (or not) the numbers in the paging control.

DataTablespaging

paging.previousNext

Include (or not) the previous and next buttons in the paging control.

DataTablespaging

paging.type

Paging button display options

DataTablespaging

search

Global search input

DataTablessearch

search.columns

Limit the search to a specific subset of columns

DataTablessearch

search.placeholder

Placeholder for the input element

DataTablessearch

search.processing

Show processing indicator when searching

DataTablessearch

search.text

Text for search control

DataTablessearch

searchBuilder

Enable and configure the SearchBuilder extension for DataTables

SearchBuilder

searchBuilder.columns

Restrict which columns can be filtered on

SearchBuilder

searchBuilder.conditions

Define custom conditions for SearchBuilder

SearchBuilder

searchBuilder.depthLimit

Impose a limit on the depth of the groups

SearchBuilder

searchBuilder.enterSearch

Trigger a search on the enter key rather than every keypress

SearchBuilder

searchBuilder.filterChanged

Function to update title text when selections are made.

SearchBuilder

searchBuilder.greyscale

Removes the colours from SearchBuilder

SearchBuilder

searchBuilder.liveSearch

Control live search operation

SearchBuilder

searchBuilder.logic

Set the default logic operator

SearchBuilder

searchBuilder.preDefined

Set a predefined search query

SearchBuilder