{hero}

removeAllStates

Since: StateRestore 1.0.0

Removes all stored states.
Please note - this property requires the StateRestore extension for DataTables.

Description

This button can be displayed at the top level alongside the savedStates and createState buttons. This button removes all saved states. This completely removes the states from storage, as well as removing the buttons that represent them.

No confirmation modal is shown as default when using this button.

This button is used within the StateRestore extension. It won't do anything if removing states is disabled using the remove option of the stateRestoreConfig configuration object of the parent button.

This button does not have any additional configuration options available to it, beyond the standard set offered for all Buttons (e.g. text). The text in the button can be set by using the language.buttons.removeAllStates option.

Example

removeAllStates button modify text:

DataTable.ext.buttons.removeAllStates.text = function (e, dt, node, config) {
	return 'Remove Everything';
};