jQuery/JS Common Types - grids - StateStoring

Configures state storing.

import { StateStoring } from "devextreme/common/grids"

customLoad

Specifies a function that is executed on state loading. Applies only if the type is 'custom'.

Type:

Function

Return Value:

Promise<Object> (jQuery or native)

The UI component state. As a rule, it is a state that you save within the customSave function.

customSave

Specifies a function that is executed on state change. Applies only if the type is "custom".

Type:

Function

Function parameters:
gridState:

Object

The current UI component state.

enabled

Enables state storing.

Type:

Boolean

Default Value: false

savingTimeout

Specifies the delay in milliseconds between when a user makes a change and when this change is saved.

Type:

Number

Default Value: 2000

storageKey

Specifies the key for storing the UI component state.

Type:

String

Default Value: null

type

Specifies the type of storage where the state is saved.

Default Value: 'localStorage'