Base Context
Summary
- Base class used for all Context objects provided in functions in Adaptable Options
- Also the base class for all EventInfo objects used by AdapTable Events
The Base Context object provides a set of useful properties, including the Adaptable API.
It acts as the Base Class for 2 large sets of commonly-used classes in AdapTable:
- All
xxxContextobjects provided to properties in Adaptable Options that take the form of functions - All
xxxEventInfoobjects published by Adaptable Events
Base Context Object
The BaseContext object is defined as follows:
| Property | Type | Description |
|---|---|---|
| adaptableApi | AdaptableApi | Adaptable Api object |
| adaptableContext | any | Custom application Context provided in AdaptableOptions.adaptableContext |
| adaptableId | string | Id of current AdapTable instance |
| adaptableStateKey | string | Current Adaptable State Key |
| clientTimestamp | Date | Time on user's computer |
| userName | string | Name of Current User |