{hero}

stateRestore.save

Since: StateRestore 1.0.0

Enable/Disable the saving of states.
Please note - this property requires the StateRestore extension for DataTables.

Description

This option allows for the saving of states to be enabled or disabled.

As default the value is true, meaning that states can be saved. If this option is set to false, then saving will be disabled as well as creation of new states at that is also a save operation.

It is important to note that this does not only affect updating states, but also creating and renaming of states. These can be controlled independently using stateRestore.create and stateRestore.rename, but if this option is set to false it will override both of them. This is because creating and renaming are both, in their own way, a form of saving.

Take a look at this example to see this in action.

Type

boolean

Description:

true if saving states is to be enabled, false if not.

Default

  • Value: true

The default value for the stateRestore.save option is true meaning that as standard saving states will be enabled.

Example

Disable saving of new states:

$('#example').DataTable({
    dom: 'Blfrtip',
    buttons:[
        {
            extend: 'savedStates',
            config: {
                save: false
            }
        }
    ]
});