State Persistence

12 Jun 20231 minute to read

The state persistence is to maintain the Grid state in browser’s local storage even if browser refresh or move to next page. State persistence stores Grid’s model object in local storage while defining enable-persistence as true.


localStorage is not supported below IE9 then grid state persistence technique is fallback to cookie.

List of properties are not Persisted by default

The following properties are not included while maintaining grid state in local storage to keep localStorage compact.

  • Query
  • isEdit
  • toolbarClick
  • queryCellInfo
  • mergeCellInfo
  • currentViewData
  • enableAltRow
  • enableRTL
  • contextClick
  • contextOpen
  • rowDataBound
  • rowTemplate
  • detailsDataBound
  • detailsTemplate
  • childGrid
  • summaryRows
  • toolbarSettings
  • editSettings
  • allowMultiSorting
  • enableAutoSaveOnSelectionChange
  • locale
  • allowScrolling
  • allowCellMerging
  • allowTextWrap
  • cssClass
  • dataSource
  • groupSettings.enableDropAreaAnimation
  • enableRowHover
  • showSummary
  • allowGrouping
  • enableHeaderHover
  • allowKeyboardNavigation
  • scrollSettings.frozenRows
  • scrollSettings.frozenColumns
  • enableTouch
  • editSettings.rowPosition
  • editSettings.showAddNewRow
  • contextMenuSettings.enableContextMenu


The given excluded properties can be included in persist state using the _ignoreOnPersist property in grid prototype.

Accessing currently stored state

The persisted state can be accessed through local storage using corresponding key name. Key name is the combination of plugin name and control id.

  • JS
  • var gridStateString = window.localStorage.ejGridGrid; // grid state as string
    var gridStateObject = JSON.parse(window.localStorage.ejGridGrid);//grid state as object


    In the above example, the “ejGrid” is plugin name and “Grid” is control id.