renameState

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

Description

This is used as one of the secondary buttons within the stateRestore split button that represents and provides functionality for a saved state. This button renames the relevant state. This changes the text value that is displayed within the button for this state, and also the value that would be used to refer to it when using API methods.

There are 2 other secondary buttons also within the split button - removeState and updateState. Their documentation provides further details relevant to their functionality.

This button is used within the StateRestore extension. It won't do anything if renaming is disabled using the renameSate option of the stateRestoreConfig configuration object of the parent button.

This button does not have any additional configuration options available to it, beyond the standard set offered for all Buttons (e.g. text). The text in the button can be set by using the language.buttons.renameState option.

Example

DataTable.ext.buttons.renameState.text = function (e, dt, node, config) {
	return 'Rename State';
};