Buttons

The Buttons extension for DataTables provides an extensible framework that can be used to add button groups around a table that will control the table, or otherwise process the data in it. Buttons has a range of built in Button types, and other extensions such as Editor provide additional button definitions.

The full set of button types that are defined by the DataTables suite are documented below. For further information about Buttons, including creating your own custom buttons, please refer to the Buttons document.

Search:

Provider:

Name	Summary	Library
`autoView`		CardView
`cardView`	Change the display to display the cards	CardView
`cardViewToggle`	Toggle between the card and table view	CardView
`ccSearchClear`	A button to clear ColumnControl searches when triggered	ColumnControl
`colOrder`	A button collection that provides column ordering control	Buttons
`collection`	A button which triggers a drop down with another set of buttons	Buttons
`columnOrder`	A button that will control the ordering on a single column	Buttons
`columnToggle`	A single button that will toggle the visibility of one or more columns	Buttons
`columnVisibility`	A single button that controls the visibility of one or more columns	Buttons
`columnsToggle`	A set of Buttons to toggle the visibility of individual columns	Buttons
`columnsVisibility`	A set of Buttons to set the visibility of individual columns	Buttons
`colvis`	A button collection that provides column visibility control	Buttons
`colvisGroup`	Show and hide multiple columns	Buttons
`colvisRestore`	Restore the visibility of column to their original state	Buttons
`copy`	Copy table data to clipboard button	Buttons
`copyHtml5`	Copy table data to clipboard button (HTML)	Buttons
`create`	A button that will create a new row using Editor	Editor
`createInline`	A button that will insert a new row for inline row creation	Editor
`createState`	Creates a new state, based off of the current state of the table.	StateRestore
`csv`	Create and save a CSV file that contains the data from the table	Buttons
`csvHtml5`	Create and save a CSV file that contains the data from the table (HTML5)	Buttons
`edit`	A button that will edit one or more existing rows using Editor	Editor
`editSingle`	A button that will edit an existing row using Editor	Editor
`excel`	Create and save an Excel CSV file that contains the data from the table	Buttons
`excelHtml5`	Create and save an Excel XLSX file that contains the data from the table (HTML5)	Buttons
`fixedColumns`	A single button that initialises and allows FixedColumns to be toggled.	FixedColumns
`pageLength`	Button collection that will control the DataTables' page length	Buttons
`pdf`	Create and save a PDF file that contains the data from the table	Buttons
`pdfHtml5`	Create and save a PDF file that contains the data from the table (HTML5)	Buttons
`print`	Button show a printable view of the table's data	Buttons
`remove`	A button that will delete one or more rows using Editor	Editor
`removeAllStates`	Removes all stored states.	StateRestore
`removeSingle`	A button that will delete a single row using Editor	Editor
`removeState`	Removes a state from storage.	StateRestore
`renameState`	Renames a state.	StateRestore
`savedStates`	Collection used to provide interaction with the saved states	StateRestore
`savedStatesCreate`	Extends `savedStates`, adding creating functionality to the collection normally displayed	StateRestore
`searchBuilder`	A single button that displays the SearchBuilder container in a popover.	SearchBuilder
`selectAll`	Select all items in the table based on the current item select mode	Select
`selectCells`	Change the item selection mode to `cell`.	Select
`selectColumns`	Change the item selection mode to `column`.	Select
`selectNone`	Deselect all selected items in the table.	Select
`selectRows`	Change the item selection mode to `row`.	Select
`selected`	Button that is enabled when one or more items are selected in the table	Select
`selectedSingle`	Button that is enabled when a single item is selected in the table	Select
`showSelected`	Toggle a filter that will reduce the rows displayed to just those which are selected.	Select
`spacer`	A special "button" which provides visual grouping between buttons.	Buttons
`stateRestore`	A split button that represents and provides functionality for a saved state.	StateRestore
`tableView`		CardView
`updateState`	Updates a selected state with the current table state.	StateRestore