stateRestore.state().edit()

Since: StateRestore 2.0.0

Update the properties of a state.
Please note - this property requires the StateRestore extension for DataTables.

Description

This method provides the option of updating the properties of an existing state. A modal is shown with the properties of the state, including its name and if available sharing and default options. Furthermore, if the end user has the option of selecting which table properties are saved in the state (via the stateRestore.include property), they will have the option of removing them (but not adding new properties!).

If you wish to offer the user the ability to update the state itself, use stateRestore.state().save().

Type

stateRestore.state().edit()

Shows an editing modal to let the user update the properties of a state.

Returns:

DataTable.Api: Returns a DataTables API instance for chaining.

Example

Trigger the edit modal for a state:

table.stateRestore.state('{id}').edit();

Related

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