Setting AdapTable ID
Summary
- The AdapTableId property in Adaptable Options is used to uniquely idenitfy the current AdapTable instance
The adaptableId property sets how each instance of AdapTable is identified and named.
The property is set in the root of Adaptable Options.
adaptableId
Default: adaptable_idStringThe adaptableId property is used in a number of places in AdapTable including:
-
the key in Adaptable State if using local storage (and no
adaptableStateKeyproperty has been provided) -
the default value for the
DashboardTitleproperty in Dashboard Initial State (i.e. what is displayed in the Dashboard Header) -
in Team Sharing to identify the current instance
Hint
Ensure to provide your own value for adaptableId so that you can easily identify different AdapTable instances
It is particularly useful when you have multiple AdapTable Grids displaying simultaneously.
Caution
- Although AdapTable provides a default if this property is not supplied, we strongly recommend that you do so
- This will avoid future conflicts between multiple AdapTable instances
Base Context
The value of the adaptableId property is suppled in the very commonly used Base Context; this is the base of the xxxContext properties supplied to most functions in Adaptable Options, and also the base of the xxxEventInfo object included in all Adaptable Events
AdapTable Resources
- See the Integration Guides for the various AdapTable framework versions: