Persist States

To activate the save table states feature, specify the TableOptions.saveState when instantiating table controller.

controller = PanemuTableController.create<People>(
    this.columns, 
    this.datasource, 
    { saveState: {
      key:'this_key_must_be_unique_app_wide',
      
      //leave states undefined to save all states. To only save, for example,
      // which columns are sorted and column position, use ['sorting', 'columns']
      states: undefined
  }
});

The saveState.key should be unique app-wide to avoid collition. By default it is saved to browser's local storage.

Try to change the following states on below example:

• Resize columns width. Or click the cog button and select Setting to change columns visibility, position and stickiness.
• Click some row headers to sort.
• Specify search criteria and grouping.
• Change the pagination range/page.

Then go to other page and back. The last states should be restored.

If columns structure changes (columns added, removed or there is a change in ColumnType.GROUP children) the saved state is ignored. See TableState.structureKey.

By default the states are stored in browser's local storage. If you want to store it in database server, in your custom table service, override these methods:

1. PanemuTableService.saveTableState().
2. PanemuTableService.getTableState(). Should returns Observable<TableState>.
3. PanemuTableService.deleteTableState(). Should returns Observable. By default, after the delete succeed, the page is reloaded.

Persisting state is best combined with PanemuSettingComponent. It provides a button to clear or reset the state. To delete the states programmatically, call PanemuTableController.deleteState(). The controller also has saveState() method.