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 four built in features:
info
- 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 official extensions for DataTables.
The following option shows the layout
option being used to disable the default pageLength
at the top left of the table and to place a paging control at the top right.
new DataTable('#myTable', {
layout: {
topStart: null
topEnd: 'paging'
}
} );
Library | Name | Summary |
---|---|---|
Built in - Info | Table information display | |
Built in - Info | Information display callback | |
Built in - Info | Empty table text | |
Built in - Info | Information string postfix | |
Built in - Info | Appended to the info string when searching is active | |
Built in - Info | Table summary information display string | |
Built in - Page Length | Paging length control | |
Built in - Page Length | Text for page length control | |
Built in - Page Length | Text for page length control | |
Built in - Paging | Pagination buttons | |
Built in - Paging | Include (or not) the leading first and last page in the numbers. | |
Built in - Paging | Set the maximum number of paging number buttons | |
Built in - Paging | Include (or not) the first and last buttons in the paging control. | |
Built in - Paging | Include (or not) the numbers in the paging control. | |
Built in - Paging | Include (or not) the previous and next buttons in the paging control. | |
Built in - Paging | Paging button display options | |
Built in - Search | Global search input | |
Built in - Search | Placeholder for the input element | |
Built in - Search | Show processing indicator when searching | |
Built in - Search | Text for search control | |
Built in - Div | Text / HTML container | |
Built in - Div | Set the class name for the created element. | |
Built in - Div | Set the HTML content for the element. | |
Built in - Div | Set the ID for the created element. | |
Built in - Div | Set the text content for the element. | |
Buttons | 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 | |
SearchBuilder | 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 | |
SearchPanes | Enable Search Panes | |
SearchPanes | Allow panes to cascade under selection | |
SearchPanes | Disable buttons to allow quick clearing of selections in panes | |
SearchPanes | Allow the SearchPanes to be collapsed | |
SearchPanes | Select which columns should be considered when displaying panes | |
SearchPanes | Hide the control buttons and disable searching in all panes | |
SearchPanes | Define properties of the DataTables being used as Panes | |
SearchPanes | Deprecated. Set custom empty message | |
SearchPanes | Function to update title text when selections are made. | |
SearchPanes | Hide the count column in all panes | |
SearchPanes | Container for options for language | |
SearchPanes | Set the message to be displayed in the Clear button | |
SearchPanes | Set the message to be displayed in the SearchPanes Button | |
SearchPanes | Set the message to be displayed in the Collapse button | |
SearchPanes | Set the message to be displayed in the count column when not searching | |
SearchPanes | Set the message to be displayed in the count column when searching | |
SearchPanes | Add internationalisation to the empty message displayed as a pane option | |
SearchPanes | Add internationalisation to the message shown when no panes are displayed | |
SearchPanes | Add internationalisation to the message shown when the panes are loading | |
SearchPanes | Set the message to be displayed in the Show button | |
SearchPanes | Add internationalisation to the title showing how many panes are selected | |
SearchPanes | Collapse the SearchPanes on initialisation | |
SearchPanes | Set the layout of how the panes are displayed on the page | |
SearchPanes | Set the order of the Panes | |
SearchPanes | Hide the ordering buttons in all panes | |
SearchPanes | Define custom panes to filter across all columns | |
SearchPanes | Add a custom class for a custom pane | |
SearchPanes | Define the DataTables options for a custom pane | |
SearchPanes | Define the header for custom panes | |
SearchPanes | Define the options for custom panes | |
SearchPanes | Add classes to specific options of a custom pane | |
SearchPanes | Define the label for an option of a custom pane | |
SearchPanes | Define the value for an option of a custom pane | |
SearchPanes | Deprecated. Define any preSelections for the custom panes | |
SearchPanes | Pre-selected options in a pane | |
SearchPanes | Set the minimum ratio of unique values to total values needed in a column to display it's pane | |
SearchPanes | Show the count column in all panes | |
SearchPanes | Update the count column when searching to show visible count |