State management in Angular Grid component (2024)

31 Aug 202424 minutes to read

State management in the Angular Grid component allows you to maintain the grid’s state even after a browser refresh or when navigating to a different page within the same browser session. This feature is particularly useful for retaining the grid’s configuration and data even after a page reload.

To enable state persistence in the Grid, you can utilize the enablePersistence property. When this property is set to true, the grid will automatically save its state in the browser’s localStorage, ensuring that the state is preserved across page reloads.

<ejs-grid [dataSource]="data" [enablePersistence]="true"></ejs-grid>

The grid will store the state using the combination of the component name and component ID in the storage. For example, if the component name is grid and the ID is OrderDetails, the state will be stored as gridOrderDetails.

When enabling state persistence, the following grid settings will persist in the local storage.

Grid Settings	Properties persist	Ignored properties
pageSettings	currentPage pageCount pageSize pageSizes totalRecordsCount	template enableQueryString
groupSettings	allowReordering columns disablePageWiseAggregates enableLazyLoading showDropArea showGroupedColumn showToggleButton showUngroupButton	captionTemplate
columns	allowEditing allowFiltering allowGrouping allowReordering allowResizing allowSearching allowSorting autoFit disableHtmlEncode enableGroupByFormat field foreignKeyField index showColumnMenu showInColumnChooser sortDirection type uid visible width	clipMode commands customAttributes dataSource defaultValue displayAsCheckBox edit editTemplate editType filter filterBarTemplate filterTemplate foreignKeyValue format formatter freeze headerTemplate headerText headerTextAlign headerValueAccessor hideAtMedia isFrozen isIdentity isPrimaryKey lockColumn maxWidth minWidth sortComparer template textAlign validationRules valueAccessor
sortSettings	-	-
filterSettings	-	-
searchSettings	-	-
selectedRowIndex	-	-

The grid will persist only the last selected row index.

Restore initial Grid state

In the Syncfusion Angular Grid component, you have the capability to restore the grid to its initial state, reverting all changes and configurations made during the interaction. This feature can be particularly useful when you want to reset the grid to its original settings, eliminating any applied filters, sorting, or column reordering.

Here are the steps to reset the grid to its initial state, even when the enablePersistence property is enabled:

Changing component id

If you want to restore the initial state of the grid, consider changing the component ID. This step ensures that the grid is treated as a new instance, effectively reverting to its default settings.

Here is an example code to change the component id dynamically to restore initial grid state.

app.component.ts
main.ts

import { NgModule } from '@angular/core'import { BrowserModule } from '@angular/platform-browser'import { GridModule, GroupService } from '@syncfusion/ej2-angular-grids'import { ButtonModule } from '@syncfusion/ej2-angular-buttons'import { Component, OnInit, ViewChild } from '@angular/core';import { data } from './datasource';import { FilterService, PageService, GridComponent } from '@syncfusion/ej2-angular-grids';@Component({imports: [ GridModule, ButtonModule ],standalone: true, selector: 'app-root', template: `<button ejs-button id='restore' (click)='clickHandler()'>Restore to initial state</button> <ejs-grid #grid [id]='gridId' [dataSource]='data' [enablePersistence]='true' [allowPaging]='true' [allowFiltering]='true' height='210px'> <e-columns> <e-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-column> <e-column field='CustomerID' headerText='Customer ID' width=150></e-column> <e-column field='ShipCity' headerText='Ship City' width=150></e-column> <e-column field='ShipName' headerText='Ship Name' width=150></e-column> </e-columns> </ejs-grid>`, providers: [GroupService, FilterService, PageService]})export class AppComponent implements OnInit { public data?: object[]; @ViewChild('grid') public grid?: GridComponent; public gridId?: string = 'OrderDetails'; // id for the Grid component ngOnInit(): void { this.data = data; } clickHandler() { this.gridId = `OrderDetails` + Math.floor(Math.random() * 10); location.reload(); }}

import { bootstrapApplication } from '@angular/platform-browser';import { AppComponent } from './app.component';import 'zone.js';bootstrapApplication(AppComponent).catch((err) => console.error(err));

Clearing local storage

Another method to reset the grid is by clearing the local storage associated with the grid component. This action removes any stored state information, allowing the grid to return to its original configuration.

Here is an example code on how to clear local storage to retain its default state.

app.component.ts
main.ts

import { NgModule } from '@angular/core'import { BrowserModule } from '@angular/platform-browser'import { GridModule, GroupService } from '@syncfusion/ej2-angular-grids'import { ButtonModule } from '@syncfusion/ej2-angular-buttons'import { Component, OnInit, ViewChild } from '@angular/core';import { data } from './datasource';import { FilterService, PageService, GridComponent } from '@syncfusion/ej2-angular-grids';@Component({imports: [ GridModule, ButtonModule ],standalone: true, selector: 'app-root', template: `<button ejs-button id='restore' (click)='clickHandler()' cssClass='e-primary'>Restore to initial state</button> <ejs-grid #grid id="OrderDetails" [dataSource]='data' [enablePersistence]='true' [allowPaging]='true' [allowFiltering]='true' height='210px'> <e-columns> <e-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-column> <e-column field='CustomerID' headerText='Customer ID' width=150></e-column> <e-column field='ShipCity' headerText='Ship City' width=150></e-column> <e-column field='ShipName' headerText='Ship Name' width=150></e-column> </e-columns> </ejs-grid>`, providers: [GroupService, FilterService, PageService]})export class AppComponent implements OnInit { public data?: object[]; @ViewChild('grid') public grid?: GridComponent; ngOnInit(): void { this.data = data; } clickHandler() { const grid = this.grid as GridComponent; grid.enablePersistence = false; window.localStorage.setItem("gridOrderDetails", ""); // Here grid is component name and OrderDetails is component ID grid.destroy(); location.reload(); }}

import { bootstrapApplication } from '@angular/platform-browser';import { AppComponent } from './app.component';import 'zone.js';bootstrapApplication(AppComponent).catch((err) => console.error(err));

Restore to specific state version

Syncfusion Angular Grid supports version-based persistence for easy restoration to a specific state. To enable version based persistence, import enableVersionBasedPersistence from @syncfusion/ej2-base and set it globally to true. Define the grid in the template with properties, bind data, and configure persistence using enablePersistence and ej2state-persistenceVersion.

In the below example, the clickHandler method is responsible for handling button clicks corresponding to different versions. Inside this method, the targeted version is assigned to the grid’s ej2state-persistenceVersion dynamically. The code checks if there is already a persisted state for the selected version in the local storage. If found, the grid is updated with the settings retrieved from the local storage, including columns, filter settings, group settings, sort settings, page settings, and selected row index. If no persisted state is found, the current grid state is persisted to the local storage using the getPersistData method.

Here is an example of how to integrate version-based persistence into your Angular component and restore to specific state version:

app.component.ts
main.ts

import { NgModule } from '@angular/core'import { BrowserModule } from '@angular/platform-browser'import { GridModule, GroupService } from '@syncfusion/ej2-angular-grids'import { ButtonModule } from '@syncfusion/ej2-angular-buttons'import { Component, OnInit, ViewChild } from '@angular/core';import { data } from './datasource';import { FilterService, PageService, GridComponent, GroupService, SortService, ReorderService } from '@syncfusion/ej2-angular-grids';import { enableVersionBasedPersistence } from '@syncfusion/ej2-base';enableVersionBasedPersistence(true);@Component({imports: [ GridModule, ButtonModule ],standalone: true, selector: 'app-root', template: `<h4 id='message'>{{message}}</h4> <button ejs-button *ngFor="let v of versions" [id]="'restore' + v" (click)="clickHandler('v.' + v)">Version {{ v }}</button> <ejs-grid #grid id="OrderDetails" [dataSource]='data' [enablePersistence]='true' [ej2StatePersistenceVersion]='gridversion'  [allowPaging]='true' [allowFiltering]='true' [allowReordering]='true' [allowSorting]='true' [allowGrouping]='true' height='210px'> <e-columns> <e-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-column> <e-column field='CustomerID' headerText='Customer ID' width=150></e-column> <e-column field='ShipCity' headerText='Ship City' width=150></e-column> <e-column field='ShipName' headerText='Ship Name' width=150></e-column> </e-columns> </ejs-grid>`, providers: [FilterService, PageService, GroupService, SortService, ReorderService]})export class AppComponent implements OnInit { public data?: object[]; @ViewChild('grid') public grid?: GridComponent; public message?: string; public gridversion?: string = 'v.0'; public versions: number[] = [1, 2, 3]; ngOnInit(): void { this.data = data; } clickHandler(version: string) { const grid = this.grid as GridComponent; grid.ej2StatePersistenceVersion = version; var persistedGridSettings: string = (window.localStorage.getItem(`gridOrderDetails` + grid.ej2StatePersistenceVersion)) as string; if (persistedGridSettings) { grid.setProperties(JSON.parse(persistedGridSettings)); this.message = `Grid state restored to ` + version; } else { var gridData = grid.getPersistData(); window.localStorage.setItem((`gridOrderDetails` + grid.ej2StatePersistenceVersion), gridData); } }}

import { bootstrapApplication } from '@angular/platform-browser';import { AppComponent } from './app.component';import 'zone.js';bootstrapApplication(AppComponent).catch((err) => console.error(err));

Restore to previous state

The Syncfusion Angular Grid component allows you to save and restore its state using local storage. This feature is helpful when you want to preserve the current state of the Grid, such as column order, sorting, and filtering, so that you can return to your previous work or configurations.

To implement this functionality, use the getItem and setItem methods for local storage, along with the Grid component’s setProperties and getPersistData methods.

The provided code demonstrates how to save and restore the previous state of a Syncfusion Angular Grid component using local storage.

app.component.ts
app.component.html
main.ts

import { NgModule } from '@angular/core'import { BrowserModule } from '@angular/platform-browser'import { GridModule, GroupService, FilterService, ToolbarService, SortService, EditService, } from '@syncfusion/ej2-angular-grids'import { ButtonAllModule } from '@syncfusion/ej2-angular-buttons'import { Component, OnInit, ViewChild } from "@angular/core";import { data } from "./datasource";import { GroupService, SortService, GridComponent, EditService, ToolbarService,} from "@syncfusion/ej2-angular-grids";@Component({imports: [ GridModule, ButtonAllModule ],standalone: true, selector: "app-root", templateUrl: "app.component.html", providers: [GroupService, ToolbarService, SortService, EditService, FilterService],})export class AppComponent { public data?: Object[]; public groupOptions?: Object; public pageSettings?: Object; public editSettings?: Object; public filterOptions?: Object; public toolbar?: string[]; public orderidrules?: Object; public customeridrules?: Object; public freightrules?: Object; public editparams?: Object; public formatoptions?: Object; @ViewChild("Orders") public grid?: GridComponent; public state?: GridComponent; public message?: string; ngOnInit(): void { this.data = data; this.groupOptions = { showGroupedColumn: false, columns: ["ShipCountry"] }; this.filterOptions = { type: "Menu" }; this.pageSettings = { pageCount: 5 }; this.editSettings = { allowEditing: true }; this.toolbar = ["Edit", "Update", "Cancel"]; this.orderidrules = { required: true, number: true }; this.customeridrules = { required: true }; this.freightrules = { required: true }; this.editparams = { params: { popupHeight: "300px" } }; this.formatoptions = { type: "dateTime", format: "M/d/y hh:mm a" }; } actionBegin() { this.message = ""; } // Save grid state to local storage save() { var persistData = (this.grid as GridComponent).getPersistData(); // Grid persistData window.localStorage.setItem("gridOrders", persistData); this.message = "Grid state saved."; } // Restore grid state from local storage restore() { let value: string = window.localStorage.getItem("gridOrders") as string; //"gridOrders" is component name + component id. this.state = JSON.parse(value); if (this.state) { (this.grid as GridComponent).setProperties(this.state); this.message = "Previous grid state restored."; } else { this.message = "No saved state found."; } }}

Maintaining custom query in a persistent state

When enablePersistence is enabled, the Grid does not automatically maintain custom query parameters after a page load. This is because the Grid refreshes its query params for every page load. You can maintain the custom query params by resetting the addParams method in the actionBegin event.

app.component.ts
main.ts

import { NgModule } from '@angular/core'import { BrowserModule } from '@angular/platform-browser'import { FilterService, GridModule, GroupService } from '@syncfusion/ej2-angular-grids'import { Component, OnInit, ViewChild } from '@angular/core';import { data } from './datasource';import { FilterService, PageService, GridComponent } from '@syncfusion/ej2-angular-grids';@Component({imports: [ GridModule ],standalone: true, selector: 'app-root', template: `<ejs-grid #Orders [dataSource]='data' [enablePersistence]='true' [allowPaging]='true' [allowFiltering]='true' height='210px' (actionBegin)='actionBegin()'> <e-columns> <e-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-column> <e-column field='CustomerID' headerText='Customer ID' width=150></e-column> <e-column field='EmployeeID' headerText='Employee ID' width=150></e-column> <e-column field='ShipCity' headerText='Ship City' width=150></e-column> <e-column field='ShipName' headerText='Ship Name' width=150></e-column> </e-columns> </ejs-grid>`, providers: [GroupService, FilterService, PageService]})export class AppComponent implements OnInit { public data?: object[]; @ViewChild('Orders') public grid?: GridComponent; ngOnInit(): void { this.data = data; } actionBegin() { (this.grid as GridComponent).query.addParams('dataSource', 'data'); }}

import { bootstrapApplication } from '@angular/platform-browser';import { AppComponent } from './app.component';import 'zone.js';bootstrapApplication(AppComponent).catch((err) => console.error(err));

Get or set local storage value

If the enablePersistence property is set to true, the Grid property value is saved in the window.localStorage for reference. You can get or set the localStorage value by using the getItem and setItem methods in window.localStorage.

To retrieve the Grid model from Local Storage, follow these steps:

//get the Grid model.let value: string = window.localStorage.getItem('gridOrders'); //"gridOrders" is component name + component id.let model: Object = JSON.parse(value);

//set the Grid model.window.localStorage.setItem('gridOrders', JSON.stringify(value)); //"gridOrders" is component name + component id.

Prevent columns from persisting

In the Syncfusion Angular Grid component, you may sometimes want to prevent certain settings from being persisted when using the enablePersistence feature. When the enablePersistence property is set to true, the Grid properties such as Grouping, Paging, Filtering, Sorting, and Columns will persist. You can use the addOnPersist method to prevent these Grid properties from persisting.

The following example demonstrates how to prevent Grid columns from persisting. In the dataBound event of the Grid, you can override the addOnPersist method and remove the columns from the key list given for persistence.

app.component.ts
main.ts

import { NgModule } from '@angular/core'import { BrowserModule } from '@angular/platform-browser'import { GridModule, GroupService } from '@syncfusion/ej2-angular-grids'import { ButtonAllModule } from '@syncfusion/ej2-angular-buttons'import { Component, OnInit, ViewChild } from '@angular/core';import { data } from './datasource';import { FilterService, PageService, GridComponent, Column } from '@syncfusion/ej2-angular-grids';@Component({imports: [ GridModule, ButtonAllModule ],standalone: true, selector: 'app-root', template: `<button ejs-button id='add' (click)='addColumn()'>Add Columns</button> <button ejs-button id='remove' (click)='removeColumn()'>Remove Columns</button> <ejs-grid #grid id="Orders" [dataSource]='data' [enablePersistence]='true' [allowPaging]='true' height='210px' (dataBound)='dataBound()'> <e-columns> <e-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-column> <e-column field='CustomerID' headerText='Customer ID' width=150></e-column> <e-column field='ShipCity' headerText='Ship City' width=150></e-column> <e-column field='ShipName' headerText='Ship Name' width=150></e-column> </e-columns> </ejs-grid>`, providers: [GroupService, FilterService, PageService]})export class AppComponent implements OnInit { public data?: object[]; @ViewChild('grid') public grid?: GridComponent; ngOnInit(): void { this.data = data; } dataBound() { let cloned = (this.grid as any).addOnPersist; (this.grid as any).addOnPersist = function (key: any) { key = key.filter((item: string) => item !== "columns"); return cloned.call(this, key); }; } addColumn() { let obj = { field: "Freight", headerText: 'Freight', width: 120 }; ((this.grid as GridComponent).columns as Column[]).push(obj as Column); //you can add the columns by using the Grid columns method (this.grid as GridComponent).refreshColumns(); } removeColumn() { (this.grid as GridComponent).columns.pop(); (this.grid as GridComponent).refreshColumns(); }}

import { bootstrapApplication } from '@angular/platform-browser';import { AppComponent } from './app.component';import 'zone.js';bootstrapApplication(AppComponent).catch((err) => console.error(err));

Add to persist

Persistence can be added to a Syncfusion Angular Grid component to enhance the user experience. Persistence allows saving and restoring the state of the grid, including column layouts, sorting, filtering, and other user-specific settings. In this documentation, you will explore how to persist column templates, header templates, and header text settings in the Angular Grid.

Add a new column in persisted columns list

When the enablePersistence property is set to true in the Syncfusion Grid component, column configurations are persisted. If you need to add new columns to the existing persisted state, you can achieve this by using the Grid’s built-in methods like column.push, and then call the refreshColumns method to update the UI with the new columns.

Here’s an example of how to add a new column to a list of persisted columns:

app.component.ts
main.ts

import { NgModule } from '@angular/core'import { BrowserModule } from '@angular/platform-browser'import { GridModule, GroupService } from '@syncfusion/ej2-angular-grids'import { Component, OnInit, ViewChild } from '@angular/core';import { data } from './datasource';import { FilterService, PageService, GridComponent, Column } from '@syncfusion/ej2-angular-grids';@Component({imports: [ GridModule ],standalone: true, selector: 'app-root', template: `<button ejs-button id='add' (click)='addColumn()'>Add Columns</button> <ejs-grid #grid id="Orders" [dataSource]='data' [enablePersistence]='true' [allowPaging]='true' height='210px'> <e-columns> <e-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-column> <e-column field='CustomerID' headerText='Customer ID' width=150></e-column> <e-column field='ShipCity' headerText='Ship City' width=150></e-column> <e-column field='ShipName' headerText='Ship Name' width=150></e-column> </e-columns> </ejs-grid>`, providers: [GroupService, FilterService, PageService]})export class AppComponent implements OnInit { public data?: object[]; @ViewChild('grid') public grid?: GridComponent; ngOnInit(): void { this.data = data; } addColumn() { let obj = { field: "Freight", headerText: 'Freight', width: 120 }; ((this.grid as GridComponent).columns as Column[]).push(obj as Column); //you can add the columns by using the Grid columns method (this.grid as GridComponent).refreshColumns(); }}

import { bootstrapApplication } from '@angular/platform-browser';import { AppComponent } from './app.component';import 'zone.js';bootstrapApplication(AppComponent).catch((err) => console.error(err));

Adding new columns using ColumnDirectives directly in the grid initialization is not recommended if you intend to persist the new columns with the existing columns list

Persist the column template, header template and header text

By default, when the enablePersistence property is set to true in the Syncfusion Grid component, certain column properties such as column template, header text, header template, column formatter, and value accessor are not persisted. This is because these properties can be customized at the application level.

To restore these column properties and achieve persistence, you can follow the approach of cloning the grid’s columns property using JavaScript Object’s assign method and manually storing it along with the persist data. When restoring the settings, this cloned column object must be assigned to the grid’s columns property to restore the column settings. The following sample demonstrates this process:

app.component.ts
main.ts

import { NgModule } from '@angular/core'import { BrowserModule } from '@angular/platform-browser'import { GridModule, GroupService } from '@syncfusion/ej2-angular-grids'import { ButtonAllModule } from '@syncfusion/ej2-angular-buttons'import { Component, OnInit, ViewChild } from '@angular/core';import { data } from './datasource';import { FilterService, PageService, GridComponent, Column } from '@syncfusion/ej2-angular-grids';@Component({imports: [ GridModule, ButtonAllModule ],standalone: true, selector: 'app-root', template: `<div id='message'>{{message}}</div><button ejs-button id='save' (click)='save()'>Save column settings</button><button ejs-button id='restore' (click)='restore()'>Restore column settings</button> <ejs-grid #Grid id="Orders" [dataSource]='data' [enablePersistence]='true' [allowPaging]='true' [allowFiltering]='true' height='210px'> <e-columns> <e-column field='OrderID' headerText='Order ID' textAlign='Right' width=120> </e-column> <e-column field='CustomerID' headerText='Customer ID' width=150 headerTemplate='<button ejs-button>HeaderTemplate</button>'> </e-column> <e-column field='ShipCity' headerText='Ship City' width=150></e-column> <e-column field='ShipName' headerText='Ship Name' width=150 template='#template'> </e-column> </e-columns> </ejs-grid>`, providers: [GroupService, FilterService, PageService]})export class AppComponent implements OnInit { public data?: object[]; @ViewChild('Grid') public grid?: GridComponent; public message: string = ''; public persistedGridSettings?: object; ngOnInit(): void { this.data = data; } save() { this.persistedGridSettings = JSON.parse(((this.grid as GridComponent)).getPersistData()); var gridColumns = Object.assign([], ((this.grid as GridComponent)).getColumns()); (this.persistedGridSettings as any).columns.forEach((persistedColumn: Column) => { const column = gridColumns.find((col: Column) => col.field === persistedColumn.field); if (column) { persistedColumn.headerText = 'Text Changed'; persistedColumn.template = (column as Column).template; persistedColumn.headerTemplate = (column as Column).headerTemplate; } }); window.localStorage.setItem('gridOrders1', JSON.stringify(this.persistedGridSettings)); this.grid?.setProperties(this.persistedGridSettings as object); this.message = 'Saved the headerText, template column, and headerTemplate properties in the persisted settings'; } restore() { const savedSettings = window.localStorage.getItem("gridOrders1"); if (savedSettings) { this.grid?.setProperties(JSON.parse(savedSettings)); this.message = 'Restored the headerText, template column, and headerTemplate'; } else { this.message = 'No saved settings found.'; } }}

import { bootstrapApplication } from '@angular/platform-browser';import { AppComponent } from './app.component';import 'zone.js';bootstrapApplication(AppComponent).catch((err) => console.error(err));