Class: ServerSideStorageService<TUserId, TGridId>
Description
The server-side StorageService used when DataGridVueGrid.serverSideStorageOptions is specified. This storage service will only attempt to deserialize the response body for getGridState if the HTTP status code is 200 OK and the Content-Type response header is application/json.
Type parameters
| Type parameter | Description |
|---|---|
TUserId | The type of the user identifier. |
TGridId | The type of the grid identifier. |
Implements
Properties
| Property | Type |
|---|---|
options | ServerSideStorageServiceOptions<TUserId, TGridId> |
Constructors
new ServerSideStorageService(options)
new ServerSideStorageService<TUserId, TGridId>(options): ServerSideStorageService<TUserId, TGridId>
Parameters
| Parameter | Type |
|---|---|
options | ServerSideStorageServiceOptions<TUserId, TGridId> |
Returns
ServerSideStorageService<TUserId, TGridId>
Methods
getGridStateAsync()
getGridStateAsync(): Promise<undefined | GridState>
Returns
Promise<undefined | GridState>
A Promise that returns the saved grid state or undefined if no grid state is saved.
Implementation of
StorageService.getGridStateAsync
Description
Retrieves the saved grid state. This is called once when the data grid component is mounted.
setGridStateAsync()
setGridStateAsync(gridState): Promise<void>
Parameters
| Parameter | Type | Description |
|---|---|---|
gridState | GridState | The grid state to save |
Returns
Promise<void>
A Promise that returns when the grid state has been saved.
Implementation of
StorageService.setGridStateAsync
Description
Saves a new version of the grid state. This called every time data in the grid state changes.