stateRestore.state().remove()

Remove a state from StateRestore.
Please note - this property requires the StateRestore extension for DataTables.

Description

This method provides the ability to remove a state that is managed by the StateRestore extension.

stateRestore.state().remove() takes one argument, skipModal that allows the confirmation modal to be bypassed. The default for skipModal is false, meaning that the modal will be shown. It removes the state retrieved by the previous call to stateRestore.state().

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

Examples

var table = new DataTable('#myTable', {
	layout: {
		topStart: {
			buttons: ['createState', 'savedStates']
		}
	}
});

table.stateRestore.state('New State').remove();

var table = new DataTable('#myTable', {
	layout: {
		topStart: {
			buttons: ['createState', 'savedStates']
		}
	}
});

table.stateRestore.state('New State').remove(true);

Related

The following options are directly related and may also be useful in your application development.