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().
As with stateRestore.state().remove(), please note that predefined states (stateRestore.preDefined) cannot be removed, nor can states which have been shared by other users.
Type
stateRestore.states().remove()
Removes stored states from the StateRestore extension.
Parameters:
| Name | Type | Optional | |
|---|---|---|---|
| 1 | skipModal | Yes - default:false | |
Boolean value indicating if the confirmation modal should be skipped or not. The default value is | |||
Returns:
DataTable.Api: Returns a DataTables API for chaining.
Example
Remove states two specific states:
table.stateRestore.states(['{id1}', '{id2}']).remove();Related
The following options are directly related and may also be useful in your application development.