stateRestore.states().remove()
Remove states from StateRestore.
Please note - this property requires the StateRestore extension for DataTables.
Description
This method provides the ability to remove multiple states that are managed by the StateRestore extension.
stateRestore.states().remove() takes one argument, skipModal that allows the confirmation modal to be bypassed for each state. The default value for skipModal is false meaning that the modal will be shown. It removes the states retrieved by the previous call to stateRestore.states().
A DataTables API instance is returned so that further chaining can occur.
If the remove option of the stateRestoreConfig configuration object is set to false then this API method will not do anything.
Type
function stateRestore.states().remove()
- Description:
Removes stored states from the StateRestore extension.
- Parameters:
Name Type Optional 1 skipModalYes - default:false Boolean value indicating if the confirmation modal should be skipped or not. The default value is
falsemeaning that the modal will be shown.- Returns:
Returns a DataTables API for chaining.
Example
Remove states called 'New State' and 'Old State':
var table = new DataTable('#myTable', {
layout: {
topStart: {
buttons: ['createState', 'savedStates']
}
}
});
table.stateRestore.states(['New State', 'Old State']).remove();Related
The following options are directly related and may also be useful in your application development.