AdapTable State

State Management Module

Summary

  • The State Management Module allows users to manage AdapTable State at run-time

AdapTable State usually just 'happens' without the User being aware of the persistence mechanism or needing to do anything in particular.

However AdapTable provides the State Management Module to assist managing Adaptable State in the UI.

It primarily allows users to import and export AdapTable State.

It's functionality can be accessed in 3 UI components:

  • The Manage State section in the Settings Panel
  • The Manage State Toolbar in the Dashboard
  • The Manage State Tool Panel in the AdapTable Tool Panel Component

Hint

  • It is unlikely that you will want all your users to have access to this feature at run-time
  • If so, set the Entitlement to Hidden for those users who do not need this feature

State Functionality

All 3 Manange State components contain 4 State-related options:

  • Clearing User State

    Caution

    This will re-load the initial Initial Adaptable State that was provided

    Note

    • If using Local Storage, AdapTable will automatically clear what is in the User's State
    • If using Remote Storage, AdapTable will invoke the clearState function that was provided at design-time

  • Loading Initial Adaptable State (from a JSON file)

  • Exporting the AdapTable State - to Clipboard, Console or JSON

  • Exporting Initial Adaptable State - to Clipboard, Console or JSON

State Management Module
Fork
PreviousPersisting AdapTable StateNextCustomising AdapTable State