API

DataTables has an extensive API which can be used to access the data contained in a table and otherwise manipulate the table after the table initialisation has completed. The DataTables API is designed to reflect the structure of the data in the table and how you will typically interact with the table through the API. It can also be extended by the extensions and plug-ins providing additional features and operations.

A DataTables API instance is returned when you create a new table, or a new API instance can be created for an existing table using DataTable.Api - e.g.:

// Create a new DataTable
let table = new DataTable('#myTable', {
    // options
});

// Or, for an existing DataTable:
let table = new DataTable.Api('#myTable');

For general information on how the DataTables API operates, including its chaining, how to work with multiple tables and definitions of the terminology used in this reference, please prefer to the API manual.

Search:

Provider:

Name	Summary	Library	Group
`$()`	Perform a jQuery selection action on the full table.	DataTables	core
`DataTable.ajax()`	Make an Ajax call to a server	DataTables	static
`DataTable.datetime()`	Register a date / time format for DataTables to use	DataTables	static
`DataTable.feature.register()`	Create a new feature that can be used for layout	DataTables	static
`DataTable.fileSave()`	Save a file that has been created on the client-side	Buttons
`DataTable.isDataTable()`	Check is a table node is a DataTable or not	DataTables	static
`DataTable.key()`	Set a license key	DataTables	static
`DataTable.tables()`	Get all DataTables on the page	DataTables	static
`DataTable.type()`	Get / set details of a data type	DataTables	static
`DataTable.types()`	Get a list of the data types registered	DataTables	static
`DataTable.use()`	Get / set the libraries or global object upon which DataTables uses	DataTables	static
`DataTable.util.debounce()`	Wait for a timeout before calling a function	DataTables	static
`DataTable.util.diacritics()`	Normalise diacritic characters in a string.	DataTables	static
`DataTable.util.escapeHtml()`	Escape HTML entities to make a user input string safe	DataTables	static
`DataTable.util.escapeRegex()`	Escape special characters in a regular expression string	DataTables	static
`DataTable.util.get()`	Create a read function from a descriptor	DataTables	static
`DataTable.util.set()`	Create a write function from a descriptor	DataTables	static
`DataTable.util.stripHtml()`	Remove HTML from a string	DataTables	static
`DataTable.util.throttle()`	Throttle the calls to a method to reduce call frequency	DataTables	static
`DataTable.util.unique()`	Get all unique items from an array	DataTables	static
`DataTable.versionCheck()`	Version number compatibility check function	DataTables	static
`ajax`	Namespace for Ajax methods	DataTables	core
`ajax.json()`	Get the latest JSON data obtained from the last Ajax request DataTables made	DataTables	core
`ajax.params()`	Get the data submitted by DataTables to the server in the last Ajax request	DataTables	core
`ajax.reload()`	Reload the table data from the Ajax data source	DataTables	core
`ajax.url()`	Get / set the URL that DataTables uses to Ajax fetch data	DataTables	core
`ajax.url().load()`	Load data from the newly set data source URL	DataTables	core
`any()`	Determine if there are any entries in the result set	DataTables	utility
`autoFill().disable()`	Disable AutoFill's interactions	AutoFill
`autoFill().enable()`	Enable or disable AutoFill's interactions	AutoFill
`autoFill().enabled()`	Determine if AutoFill is enabled or disabled	AutoFill
`button()`	Select a single button	Buttons
`button().action()`	Get / set the action function for the selected button	Buttons
`button().active()`	Get / set the active state of the selected button	Buttons
`button().add()`	Create a new button and add it to the document	Buttons
`button().collectionRebuild()`	Rebuild a buttons collection	Buttons
`button().disable()`	Disable the selected button	Buttons
`button().enable()`	Enable / disable the selected button	Buttons
`button().index()`	Get the index of a node	Buttons
`button().node()`	Get the button node for the selected button	Buttons
`button().popover()`	Show popover box for a button, allowing extra user input	Buttons
`button().processing()`	Get / set the processing state for a button	Buttons
`button().remove()`	Remove and delete the selected button	Buttons
`button().text()`	Get / set the text for the selected button	Buttons
`button().trigger()`	Trigger the action of the selected button	Buttons
`buttons()`	Select one or more buttons	Buttons
`buttons().action()`	Get / set the action functions for the selected buttons	Buttons
`buttons().active()`	Set the active state for the selected buttons	Buttons
`buttons().collectionRebuild()`	Rebuild a buttons collection	Buttons
`buttons().container()`	Get the container element for a single Buttons instance	Buttons
`buttons().containers()`	Get the container elements for one or more button instances	Buttons
`buttons().destroy()`	Destroy one or more button instances and remove from the document	Buttons
`buttons().disable()`	Disable the selected buttons	Buttons
`buttons().enable()`	Enable / disable the selected buttons	Buttons
`buttons().nodes()`	Get the button nodes for the selected buttons	Buttons
`buttons().processing()`	Set the processing state for multiple buttons	Buttons
`buttons().remove()`	Remove and delete the selected buttons	Buttons
`buttons().text()`	Get / set the text for the selected buttons	Buttons
`buttons().trigger()`	Trigger the action of the selected buttons	Buttons
`buttons.exportData()`	Obtain data from the DataTable that is suitable for exporting	Buttons
`buttons.exportInfo()`	Get export meta information that is common to many different button types	Buttons
`buttons.info()`	Display and hide information for the end user in a modal box	Buttons
`caption()`	Get / set the table's caption	DataTables	tables
`caption.node()`	Get the table's `caption` element	DataTables	tables
`cardView().displayed()`	Determine if the cards or table is shown	CardView
`cardView().mode()`	Get / set the mode CardView is operating in	CardView
`cell()`	Select a single cell from a table.	DataTables	cells
`cell().data()`	Get / set data for the selected cell	DataTables	cells
`cell().deselect()`	Deselect a single cell	Select
`cell().edit()`	Edit a cell with inline or bubble editing	Editor
`cell().focus()`	Focus on a cell	KeyTable
`cell().index()`	Get index information about the selected cell	DataTables	cells
`cell().invalidate()`	Invalidate the data held in DataTables for the selected cells	DataTables	cells
`cell().node()`	Get the DOM element for the selected cell	DataTables	cells
`cell().render()`	Get rendered data for a cell	DataTables	cells
`cell().select()`	Select a single cell	Select
`cell().selected()`	Determine if a cell has been selected	Select
`cell.blur()`	Blur focus from the table	KeyTable
`cells()`	Select multiple cells from a table.	DataTables	cells
`cells().data()`	Get data for the selected cells	DataTables	cells
`cells().deselect()`	Deselect cells	Select
`cells().edit()`	Edit cells with bubble editing	Editor
`cells().every()`	Iterate over each selected cell, with the function context set to be the cell in question.	DataTables	cells
`cells().indexes()`	Get index information about the selected cells	DataTables	cells
`cells().invalidate()`	Invalidate the data held in DataTables for the selected cells	DataTables	cells
`cells().nodes()`	Get the DOM elements for the selected cells	DataTables	cells
`cells().render()`	Get rendered data for a collection of cells	DataTables	cells
`cells().select()`	Select cells	Select
`clear()`	Clear the table of all data.	DataTables	core
`colReorder.disable()`	Disable ColReorder's interactions	ColReorder
`colReorder.enable()`	Enable or disable ColReorder's interactions	ColReorder
`colReorder.move()`	Programmatically move columns	ColReorder
`colReorder.order()`	Get / set column order	ColReorder
`colReorder.reset()`	Restore the loaded column order	ColReorder
`colReorder.transpose()`	Convert one or more column indexes to and from current and original indexes	ColReorder
`column()`	Select a single column from a table.	DataTables	columns
`column().columnControl.searchClear()`	Remove any ColumnControl applied search from the selected column	ColumnControl
`column().columnControl.searchList()`	Load new options for the search list	ColumnControl
`column().data()`	Get the data for the cells in the selected column.	DataTables	columns
`column().dataSrc()`	Get the data source property for the selected column.	DataTables	columns
`column().deselect()`	Deselect a single column	Select
`column().footer()`	Get the footer node for the selected column.	DataTables	columns
`column().header()`	Get the header node for the selected column.	DataTables	columns
`column().index()`	Get the column index of the selected column.	DataTables	columns
`column().init()`	Get the initialisation options for a column.	DataTables	core
`column().name()`	Get the name for the selected column.	DataTables	columns
`column().nodes()`	Get the cell nodes for the selected column.	DataTables	columns
`column().order()`	Order the table by the selected column.	DataTables	columns
`column().orderable()`	Get information about the orderable status of a column.	DataTables	columns
`column().render()`	Get rendered data for a column	DataTables	columns
`column().responsiveHidden()`	Get the responsive visibility state of a column in the table	Responsive
`column().search()`	Search for data in the selected column.	DataTables	columns
`column().search.fixed()`	Get / set a named search to apply to a column.	DataTables	core
`column().select()`	Select a single column	Select
`column().selected()`	Determine if a column has been selected	Select
`column().title()`	Get / set the title for a column.	DataTables	columns
`column().type()`	Get a column's data type.	DataTables	columns
`column().visible()`	Get / set the visibility of a single selected column.	DataTables	columns
`column().width()`	Get the width of a column.	DataTables	columns
`column.index()`	Convert between column index formats	DataTables	columns
`columns()`	Select multiple columns from a table.	DataTables	columns
`columns().columnControl.searchClear()`	Remove any ColumnControl applied search from the selected columns	ColumnControl
`columns().columnControl.searchList()`	Load new options for the search list	ColumnControl
`columns().data()`	Get the data for the cells in the selected columns.	DataTables	columns
`columns().dataSrc()`	Get the data source property for the selected columns.	DataTables	columns
`columns().deselect()`	Deselect columns	Select
`columns().every()`	Iterate over each selected column, with the function context set to be the column in question.	DataTables	columns
`columns().footer()`	Get the footer nodes for the selected columns.	DataTables	columns
`columns().header()`	Get the header node for the selected columns.	DataTables	columns
`columns().indexes()`	Get the column indexes of the selected columns.	DataTables	columns
`columns().init()`	Get the initialisation options for the selected columns.	DataTables	core
`columns().names()`	Get the names for the selected columns.	DataTables	columns
`columns().nodes()`	Get the cell nodes for the selected columns.	DataTables	columns
`columns().order()`	Order the table by the selected columns.	DataTables	columns
`columns().orderable()`	Get information about the orderable status of the selected columns.	DataTables	columns
`columns().render()`	Get rendered data for a collection of columns	DataTables	columns
`columns().responsiveHidden()`	Get the responsive visibility state of columns in the table	Responsive
`columns().search()`	Search for data in the selected columns.	DataTables	columns
`columns().search.fixed()`	Get / set a named search to apply to a column.	DataTables	core
`columns().select()`	Select columns	Select
`columns().titles()`	Get / set the title for multiple columns.	DataTables	columns
`columns().types()`	Get the data types for selected columns.	DataTables	columns
`columns().visible()`	Get / set the visibility of the selected columns.	DataTables	columns
`columns().widths()`	Get the widths of a group of columns.	DataTables	columns
`columns.adjust()`	Recalculate the column widths	DataTables	columns
`count()`	Get the number of elements that are contained in an API instance	DataTables	utility
`data()`	Get the data for the whole table.	DataTables	core
`destroy()`	Destroy the DataTables in the current context.	DataTables	core
`draw()`	Redraw the table.	DataTables	core
`each()`	Iterate over the contents of the API result set.	DataTables	utility
`editor()`	Get the Editor instance associated with this table.	Editor
`eq()`	Reduce an Api instance to a single context and result set.	DataTables	utility
`error()`	Trigger an error message.	DataTables	utility
`file()`	Get information about an uploaded file	Editor	editor
`files()`	Get information about multiple uploaded files	Editor	editor
`filter()`	Create a new API instance with all elements from the result set which pass a given test.	DataTables	utility
`fixedColumns()`	Namespace for FixedColumns methods	FixedColumns
`fixedColumns().end()`	Get / set the number of columns fixed at the end of a table	FixedColumns
`fixedColumns().left()`	Get / set the number of fixed columns on the left side of a table	FixedColumns
`fixedColumns().right()`	Get / set the number of fixed columns on the right side of a table	FixedColumns
`fixedColumns().start()`	Get / set the number of columns fixed at the start of a table	FixedColumns
`fixedHeader.adjust()`	Recalculate the position of the table and redraw the fixed elements	FixedHeader
`fixedHeader.disable()`	Disable the fixed elements	FixedHeader
`fixedHeader.enable()`	Enable / disable the fixed elements	FixedHeader
`fixedHeader.enabled()`	Get the current enabled status	FixedHeader
`fixedHeader.footerOffset()`	Get / set the fixed footer's offset	FixedHeader
`fixedHeader.headerOffset()`	Get / set the fixed header's offset	FixedHeader
`flatten()`	Flatten a 2D array structured API instance to a 1D array structure.	DataTables	utility
`get()`	Get the underlying data from a DataTable instance	DataTables	utility
`i18n()`	Internationalisation token lookup.	DataTables	core
`includes()`	Determine if an API result set contains a given value.	DataTables	utility
`indexOf()`	Find the first instance of a value in the API instance's result set.	DataTables	utility
`init()`	Get the initialisation options used for the table.	DataTables	core
`iterator()`	Iterate over a result set of table, row, column or cell indexes	DataTables	utility
`join()`	Join the elements in the result set into a string.	DataTables	utility
`keys.disable()`	Disable KeyTable's interactions (mouse and keyboard)	KeyTable
`keys.enable()`	Enable or disable KeyTable's interactions (mouse and keyboard)	KeyTable
`keys.enabled()`	Determine the KeyTable enabled state for a table	KeyTable
`keys.move()`	Move the focus to an adjacent cell	KeyTable
`lastIndexOf()`	Find the last instance of a value in the API instance's result set.	DataTables	utility
`length`	Number of elements in an API instance's result set.	DataTables	utility
`map()`	Create a new API instance with the result set defined by the values returned from the callback function.	DataTables	utility
`off()`	Table events removal.	DataTables	core
`on()`	Table events listener.	DataTables	core
`one()`	Listen for a table event once and then remove the listener.	DataTables	core
`order()`	Get / set the ordering applied to the table.	DataTables	core
`order.fixed()`	Get / set the fixed ordering applied to the table.	DataTables	core
`order.listener()`	Add an ordering listener to an element, for a given column.	DataTables	core
`page()`	Get / set the current page of the table.	DataTables	core
`page.info()`	Get paging information about the table	DataTables	core
`page.len()`	Get / set the table's page length.	DataTables	core
`pluck()`	Create a new API instance with the value of a property from the objects in the current result set.	DataTables	utility
`pop()`	Remove the last item from an API instance's result set.	DataTables	utility
`processing()`	Set the processing indicator state for the DataTable.	DataTables	core
`push()`	Add one or more items to the end of an API instance's result set.	DataTables	utility
`ready()`	Determine if a DataTable is ready.	DataTables	utility
`reduce()`	Apply a callback function against and accumulator and each element in the Api's result set (left-to-right).	DataTables	utility
`reduceRight()`	Apply a callback function against and accumulator and each element in the Api's result set (right-to-left).	DataTables	utility
`responsive.hasHidden()`	Determine if Responsive has hidden any columns in the table	Responsive
`responsive.index()`	Obtain the cell index from a `li` details element	Responsive
`responsive.rebuild()`	Recalculate the column breakpoints based on the class information of the column header cells	Responsive
`responsive.recalc()`	Recalculate the widths used by responsive after a change in the display	Responsive
`reverse()`	Reverse the result set of the API instance.	DataTables	utility
`row()`	Select a single row from a table.	DataTables	rows
`row().blur()`	Blur focus from a row	Select
`row().child`	Row child method namespace	DataTables	rows
`row().child()`	Get / set the child rows of the selected main table row	DataTables	rows
`row().child().hide()`	Hide child rows after creating new child rows	DataTables	rows
`row().child().remove()`	Destroy child row(s) for the selected parent row	DataTables	rows
`row().child().show()`	Make newly defined child rows visible	DataTables	rows
`row().child.hide()`	Hide the child row(s) of a parent row	DataTables	rows
`row().child.isShown()`	Check if the child rows of a parent row are visible	DataTables	rows
`row().child.remove()`	Destroy child row(s) for the selected parent row	DataTables	rows
`row().child.show()`	Make the child row(s) of a parent row visible	DataTables	rows
`row().data()`	Get / set the data for the selected row.	DataTables	rows
`row().delete()`	Delete an existing row	Editor
`row().deselect()`	Deselect a single row	Select
`row().edit()`	Edit an existing row	Editor
`row().focus()`	Move keyboard focus to a specific row	Select
`row().id()`	Get the id of the selected row.	DataTables	rows
`row().index()`	Get the row index of the selected row.	DataTables	rows
`row().invalidate()`	Invalidate the data held in DataTables for the selected row	DataTables	rows
`row().node()`	Get the row `TR` node for the selected row.	DataTables	rows
`row().remove()`	Delete the selected row from the DataTable.	DataTables	rows
`row().scrollTo()`	Scroll to a specific row	Scroller
`row().select()`	Select a single row	Select
`row().selected()`	Determine if a row has been selected	Select
`row.add()`	Add a new row to the table.	DataTables	rows
`row.create()`	Create a new row	Editor
`rowGroup().dataSrc()`	Get / set the data source for the row grouping	RowGroup
`rowGroup().disable()`	Disable RowGroup's interaction with the table	RowGroup
`rowGroup().enable()`	Enable or disable RowGroup's interaction with the table	RowGroup
`rowGroup().enabled()`	Determine if RowGroup is enabled on a table	RowGroup
`rowReorder.disable()`	Disable the user's ability to reorder rows.	RowReorder
`rowReorder.enable()`	Enable / disable the user's ability to reorder rows.	RowReorder
`rows()`	Select multiple rows from a table.	DataTables	rows
`rows().data()`	Get the data for the selected rows.	DataTables	rows
`rows().delete()`	Delete multiple existing rows	Editor
`rows().deselect()`	Deselect rows	Select
`rows().edit()`	Edit multiple existing rows	Editor
`rows().every()`	Iterate over each selected row, with the function context set to be the row in question.	DataTables	rows
`rows().ids()`	Get the ids of the selected rows.	DataTables	rows
`rows().indexes()`	Get the row indexes of the selected rows.	DataTables	rows
`rows().invalidate()`	Invalidate the data held in DataTables for the selected rows	DataTables	rows
`rows().nodes()`	Get the row `TR` nodes for the selected rows.	DataTables	rows
`rows().remove()`	Delete the selected rows from the DataTable.	DataTables	rows
`rows().select()`	Select rows	Select
`rows.add()`	Add multiple new rows to the table.	DataTables	rows
`scroller.measure()`	Recalculate the cached measurements that Scroller uses	Scroller
`scroller.page()`	Get information about the rows that are currently being displayed	Scroller
`scroller.toPosition()`	Scroll to a specific row display index	Scroller
`search()`	Search for data in the table.	DataTables	core
`search.fixed()`	Get / set a named search to apply to a table.	DataTables	core
`searchBuilder.container()`	Returns the node of the SearchBuilder container.	SearchBuilder
`searchBuilder.getDetails()`	Get the details of the current search setup	SearchBuilder
`searchBuilder.rebuild()`	Rebuild the search to a given state	SearchBuilder
`select()`	Initialise Select from outside of the constructor	Select
`select.blurable()`	Get / set the blurable state of the table's item selection options	Select
`select.info()`	Get / set the information summary display state	Select
`select.items()`	Get / set the items that Select will select based on user interaction (rows, columns or cells)	Select
`select.keys()`	Get / set Select's keyboard navigation state	Select
`select.selectable()`	Get / set the function used to determine if a row should be selectable	Select
`select.selector()`	Get / set the item selector for mouse event capture	Select
`select.style()`	Get / set the style by which the end user can select items in the table	Select
`select.toggleable()`	Get / set the behaviour if items can be deselected when a selected item is clicked on	Select
`settings()`	Obtain the table's settings object	DataTables	core
`shift()`	Remove the first item from an API instance's result set.	DataTables	utility
`slice()`	Create an independent copy of the API instance.	DataTables	utility
`sort()`	Sort the elements of the API instance's result set.	DataTables	utility
`splice()`	Modify the contents of an Api instance's result set, adding or removing items from it as required.	DataTables	utility
`state()`	Get / set the state of the table	DataTables	core
`state.clear()`	Clear the saved state of the table.	DataTables	core
`state.loaded()`	Get the table state that was loaded during initialisation.	DataTables	core
`state.save()`	Trigger a state save.	DataTables	core
`stateRestore.activeStates()`	Get the details of all of the currently active states	StateRestore
`stateRestore.state()`	Get a state from StateRestore	StateRestore
`stateRestore.state().load()`	Load a state from StateRestore into the table	StateRestore
`stateRestore.state().remove()`	Remove a state from StateRestore	StateRestore
`stateRestore.state().rename()`	Rename a state from StateRestore	StateRestore
`stateRestore.state().save()`	Save a state from StateRestore	StateRestore
`stateRestore.state.add()`	Create a new state	StateRestore
`stateRestore.states()`	Get states from StateRestore	StateRestore
`stateRestore.states().remove()`	Remove states from StateRestore	StateRestore
`table()`	Select a table based on a selector from the API's context	DataTables	tables
`table().body()`	Get the `tbody` node for the table in the API's context	DataTables	tables
`table().container()`	Get the `div` container node for the table in the API's context	DataTables	tables
`table().footer()`	Get the `tfoot` node for the table in the API's context	DataTables	tables
`table().footer.structure()`	Get a JavaScript representation of the table footer structure	DataTables	tables
`table().header()`	Get the `thead` node for the table in the API's context	DataTables	tables
`table().header.structure()`	Get a JavaScript representation of the table header structure	DataTables	tables
`table().node()`	Get the `table` node for the table in the API's context	DataTables	tables
`tables()`	Select tables based on a selector from the API's context	DataTables	tables
`tables().body()`	Get the `tbody` nodes for the tables in the API's context	DataTables	tables
`tables().containers()`	Get the `div` container nodes for the tables in the API's context	DataTables	tables
`tables().footer()`	Get the `tfoot` nodes for the tables in the API's context	DataTables	tables
`tables().header()`	Get the `thead` nodes for the tables in the API's context	DataTables	tables
`tables().nodes()`	Get the `table` nodes for the tables in the API's context	DataTables	tables
`to$()`	Convert the API instance to a jQuery object, with the objects from the instance's result set in the jQuery result set.	DataTables	utility
`toArray()`	Create a native JavaScript array object from an API instance.	DataTables	utility
`toJQuery()`	Convert the API instance to a jQuery object, with the objects from the instance's result set in the jQuery result set.	DataTables	utility
`trigger()`	Trigger an event.	DataTables	core
`unique()`	Create a new API instance containing only the unique items from the elements in an instance's result set.	DataTables	utility
`unshift()`	Add one or more items to the start of an API instance's result set.	DataTables	utility