Options
DataTables and its extensions are extremely configurable libraries and almost every aspect of the enhancements they make to HTML tables can be customised. Features can be enabled, disabled or customised to meet your exact needs for your table implementations. Customisation of these options are performed by defining options in the $().DataTable()
constructor - for example, in the following code the scrollY
and paging
options are used to enable scrolling and disable pagination:
$('#myTable').DataTable( {
scrollY: 300,
paging: false
} );
There are a huge range of options to customise your tables, which are all fully documented below. For general information about how DataTables' initialisation options can be used, please refer to the options manual.
Library | Name | Summary |
---|---|---|
DataTables - Features | Feature control DataTables' smart column width handling | |
DataTables - Features | Feature control deferred rendering for additional speed of initialisation. | |
DataTables - Features | Feature control table information display field | |
DataTables - Features | Feature control the end user's ability to change the paging display length of the table. | |
DataTables - Features | Feature control ordering (sorting) abilities in DataTables. | |
DataTables - Features | Enable or disable table pagination. | |
DataTables - Features | Feature control the processing indicator. | |
DataTables - Features | Horizontal scrolling | |
DataTables - Features | Vertical scrolling | |
DataTables - Features | Feature control search (filtering) abilities | |
DataTables - Features | Feature control DataTables' server-side processing mode. | |
DataTables - Features | State saving - restore table state on page reload | |
DataTables - Data | Add or modify data submitted to the server upon an Ajax request | |
DataTables - Data | Data property or manipulation method for table data | |
DataTables - Data | Load data for the table's content from an Ajax source | |
DataTables - Data | Data to use as the display data for the table. | |
DataTables - Callbacks | Callback for whenever a TR element is created for the table's body. | |
DataTables - Callbacks | Function that is called every time DataTables performs a draw. | |
DataTables - Callbacks | Footer display callback function. | |
DataTables - Callbacks | Number formatting callback function. | |
DataTables - Callbacks | Header display callback function. | |
DataTables - Callbacks | Table summary information display callback. | |
DataTables - Callbacks | Initialisation complete callback. | |
DataTables - Callbacks | Pre-draw callback. | |
DataTables - Callbacks | Row draw callback. | |
DataTables - Callbacks | Callback that defines where and how a saved state should be loaded. | |
DataTables - Callbacks | State loaded callback. | |
DataTables - Callbacks | State loaded - data manipulation callback | |
DataTables - Callbacks | Callback that defines how the table state is stored and where. | |
DataTables - Callbacks | State save - data manipulation callback | |
DataTables - Options | Delay the loading of server-side data until second draw | |
DataTables - Options | Destroy any existing table matching the selector and replace with the new options. | |
DataTables - Options | Initial paging start point | |
DataTables - Options | Define the table control elements to appear on the page and in what order | |
DataTables - Options | Change the options in the page length | |
DataTables - Options | Initial order (sort) to apply to the table | |
DataTables - Options | Control which cell the order event handler will be applied to in a column | |
DataTables - Options | Highlight the columns being ordered in the table's body | |
DataTables - Options | Ordering to always be applied to the table | |
DataTables - Options | Multiple column ordering ability control. | |
DataTables - Options | Change the initial page length (number of rows per page) | |
DataTables - Options | Pagination button display options | |
DataTables - Options | Display component renderer types | |
DataTables - Options | Retrieve an existing DataTables instance | |
DataTables - Options | Data property name that DataTables will use to set | |
DataTables - Options | Allow the table to reduce in height when a limited number of rows are shown. | |
DataTables - Options | Control case-sensitive filtering option. | |
DataTables - Options | Enable / disable escaping of regular expression characters in the search term. | |
DataTables - Options | Set an initial filtering condition on the table. | |
DataTables - Options | Enable / disable DataTables' smart filtering | |
DataTables - Options | Set an initial filter in DataTables and / or filtering options. | |
DataTables - Options | Define an initial search for individual columns. | |
DataTables - Options | Set a throttle frequency for searching | |
DataTables - Options | Saved state validity duration | |
DataTables - Options | Set the zebra stripe class names for the rows in the table. | |
DataTables - Options | Tab index control for keyboard navigation | |
DataTables - Columns | Assign a column definition to one or more columns. | |
DataTables - Columns | Set column definition initialisation properties. | |
DataTables - Columns | Cell type to be created for a column | |
DataTables - Columns | Class to assign to each cell in the column | |
DataTables - Columns | Add padding to the text content used when calculating the optimal with for a table. | |
DataTables - Columns | Cell created callback to allow DOM manipulation | |
DataTables - Columns | Set the data source for the column from the rows data object / array | |
DataTables - Columns | Set default, static, content for a column | |
DataTables - Columns | Set a descriptive name for a column | |
DataTables - Columns | Enable or disable ordering on this column | |
DataTables - Columns | Define multiple column ordering as the default order for a column | |
DataTables - Columns | Live DOM sorting type assignment | |
DataTables - Columns | Order direction application sequence | |
DataTables - Columns | Render (process) the data for use in the table | |
DataTables - Columns | Enable or disable filtering on the data in this column | |
DataTables - Columns | Set the column title | |
DataTables - Columns | Set the column type - used for filtering and sorting string processing | |
DataTables - Columns | Enable or disable the display of this column | |
DataTables - Columns | Column width assignment | |
DataTables - Columns | Set column specific initialisation properties. | |
DataTables - Internationalisation | WAI-ARIA label for the first pagination button | |
DataTables - Internationalisation | WAI-ARIA label for the last pagination button | |
DataTables - Internationalisation | WAI-ARIA label for the next pagination button | |
DataTables - Internationalisation | WAI-ARIA label for the previous pagination button | |
DataTables - Internationalisation | WAI-ARIA labels for pagination buttons | |
DataTables - Internationalisation | Language strings used for WAI-ARIA specific attributes | |
DataTables - Internationalisation | Language strings used for WAI-ARIA specific attributes | |
DataTables - Internationalisation | Language strings used for WAI-ARIA specific attributes | |
DataTables - Internationalisation | Decimal place character | |
DataTables - Internationalisation | Table has no records string | |
DataTables - Internationalisation | Table summary information display string | |
DataTables - Internationalisation | Table summary information string used when the table is empty of records | |
DataTables - Internationalisation | Appended string to the summary information when the table is filtered | |
DataTables - Internationalisation | String to append to all other summary information strings | |
DataTables - Internationalisation | Page length options string | |
DataTables - Internationalisation | Loading information display string - shown when Ajax loading data | |
DataTables - Internationalisation | Pagination 'first' button string | |
DataTables - Internationalisation | Pagination 'last' button string | |
DataTables - Internationalisation | Pagination 'next' button string | |
DataTables - Internationalisation | Pagination 'previous' button string | |
DataTables - Internationalisation | Pagination specific language strings | |
DataTables - Internationalisation | Processing indicator string | |
DataTables - Internationalisation | Search input string | |
DataTables - Internationalisation | Search input element placeholder attribute | |
DataTables - Internationalisation | Thousands separator | |
DataTables - Internationalisation | Load language information from remote file | |
DataTables - Internationalisation | Language configuration options for DataTables | |
DataTables - Internationalisation | Table empty as a result of filtering string | |
DataTables - Static | Set how DataTables will report detected errors | |
AutoFill | Always ask the end user if an action should be taken or not | |
AutoFill | Select the columns that can be auto filled | |
AutoFill | Attach an Editor instance for database updating | |
AutoFill | Initial enablement state of AutoFill | |
AutoFill | Action that will cause the auto fill drag handle to appear in a cell | |
AutoFill | Enable / disable user ability to horizontally drag and fill | |
AutoFill | Control automatic of data when a fill drag is completed | |
AutoFill | Enable / disable user ability to vertically drag and fill | |
AutoFill | Enable and configure the AutoFill extension for DataTables | |
AutoFill | Multi-fill selector button text | |
AutoFill | Multi-fill selector cancel option message | |
AutoFill | Multi-fill selector message for the full fill fill type | |
AutoFill | Multi-fill selector message for the horizontal fill fill type | |
AutoFill | Multi-fill selector message for the vertical fill fill type | |
AutoFill | Multi-fill selector message for the increment fill type | |
AutoFill | Information message shown at the top of the fill type selector | |
AutoFill | Container object for language strings used by AutoFill | |
Buttons | Action to take when the button is activated | |
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 | 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 | Set the tag for the button | |
Buttons | The text to show in the button | |
Buttons | Button | |
Buttons | List of buttons to be created | |
Buttons | DOM configuration for individual button elements | |
Buttons | DOM configuration of a button container element | |
Buttons | DOM configuration of a button liner element | |
Buttons | DOM configuration of the collection display | |
Buttons | DOM configuration of the Buttons container element | |
Buttons | Options to control the DOM structure Buttons creates | |
Buttons | Set a name for the instance for the group selector | |
Buttons | Buttons configuration object | |
ColReorder | Initial enablement state of ColReorder | |
ColReorder | Disallow x columns from reordering (counting from the left) | |
ColReorder | Disallow x columns from reordering (counting from the right) | |
ColReorder | Set a default order for the columns in the table | |
ColReorder | Enable / disable live reordering of columns during a drag | |
ColReorder | Enable and configure the ColReorder extension for DataTables | |
Editor | Define which field a column should trigger editing on | |
FixedColumns | Row height matching algorithm to use | |
FixedColumns | Number of columns to fix to the left of the table | |
FixedColumns | Number of columns to fix to the right of the table | |
FixedColumns | Enable and configure the FixedColumns extension for DataTables | |
FixedHeader | Enable / disable fixed footer | |
FixedHeader | Offset the table's fixed footer | |
FixedHeader | Enable / disable fixed header | |
FixedHeader | Offset the table's fixed header | |
FixedHeader | FixedHeader configuration object | |
KeyTable | Allow KeyTable's focus to be blurred (removed) from a table | |
KeyTable | Set the class name used for the focused cell | |
KeyTable | Enable / disable clipboard interaction with KeyTable | |
KeyTable | Set the orthogonal data to copy to clipboard | |
KeyTable | Select the columns that can gain focus | |
KeyTable | Set if Editor should automatically select the text in the input | |
KeyTable | Control if editing should be activated immediately upon focus | |
KeyTable | Attach an Editor instance for Excel like editing | |
KeyTable | Enable or disable navigation while inline editing | |
KeyTable | Cell to receive initial focus in the table | |
KeyTable | Limit the keys that KeyTable will listen for and take action on | |
KeyTable | Set the table's tab index for when it will receive focus | |
KeyTable | Enable and configure the KeyTable extension for DataTables | |
Responsive | Set column's visibility priority | |
Responsive | Set the breakpoints for a Responsive instance | |
Responsive | Define how the hidden information should be displayed to the end user | |
Responsive | Define the renderer used to display the child rows | |
Responsive | Column / selector for child row display control when using | |
Responsive | Set the child row display control type | |
Responsive | Enable and configure the child rows shown by Responsive for collapsed tables | |
Responsive | Set the orthogonal data request type for the hidden information display | |
Responsive | Enable and configure the Responsive extension for DataTables | |
RowGroup | Set the class name to be used for the grouping rows | |
RowGroup | Set the data point to use as the grouping data source | |
RowGroup | Text to show for rows which have | |
RowGroup | Provides the ability to disable row grouping at initialisation | |
RowGroup | Set the class name to be used for the grouping end rows | |
RowGroup | Provide a function that can be used to control the data shown in the end grouping row. | |
RowGroup | Set the class name to be used for the grouping start rows | |
RowGroup | Provide a function that can be used to control the data shown in the start grouping row. | |
RowGroup | Enable and configure the RowGroup extension for DataTables | |
RowReorder | Configure the data point that will be used for the reordering data | |
RowReorder | Attach an Editor instance for database updating | |
RowReorder | Enable / disable RowReorder's user interaction | |
RowReorder | Set the options for the Editor form when submitting data | |
RowReorder | Define the selector used to pick the elements that will start a drag | |
RowReorder | Horizontal position control of the row being dragged | |
RowReorder | Control automatic of data when a row is dropped | |
RowReorder | Enable and configure the RowReorder extension for DataTables | |
Scroller | Set the point at which new data will be loaded and drawn | |
Scroller | The amount of data that Scroller should pre-buffer to ensure smooth scrolling | |
Scroller | Display a loading message while Scroller is loading additional data | |
Scroller | Set the row height, or how the row height is calculated | |
Scroller | Time delay before new data is requested when server-side processing is enabled | |
Scroller | Enable and configure the Scroller extension for DataTables | |
Select | Table information summary string for the number of cells selected | |
Select | Table information summary string for the number of columns selected | |
Select | Table information summary string for the number of rows selected | |
Select | Container object for language strings used by Select | |
Select | Indicate if the selected items will be removed when clicking outside of the table | |
Select | Set the class name that will be applied to selected items | |
Select | Enable / disable the display for item selection information in the table summary. | |
Select | Set which table items to select (rows, columns or cells) | |
Select | Set the element selector used for mouse event capture to select items | |
Select | Set the selection style for end user interaction with the table | |
Select | Select configuration object |