Adaptable Ready Event
Summary
- Event published by AdapTable as soon as it has initialised
- Provides access to the Adaptable API object and AG Grid API object
The Adaptable Ready Event fires when AdapTable has finished initialising and is ready to be accessed.
AdaptableReadyInfo
It comprises an AdaptableReadyInfo object containing an agGridApi property (representing AG Grid's Api):
| Property | Type | Description |
|---|---|---|
| agGridApi | GridApi<TData> | Underlying AG Grid API |
| adaptableContext | any | Custom application Context provided in AdaptableOptions.adaptableContext |
BaseContext
The AdapTableReadyInfo object inherits from the BaseContext object.
This contains the Adaptable API object which provides run-time, programmatic access to all AdapTable's objects and functionality, as well as the Adaptable Id, User Name and other properties:
| 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 |
Event Subscription
Subscribing to the Event is done the same way as with all Adaptable Events:
api.eventApi.on('AdaptableReady', (eventInfo: AdaptableReadyInfo) => {
// do something with the info
});Framework Components
The AdaptableReady event is particularly useful when using one of the Framework versions (ie. AdapTable React, AdapTable Angular or AdapTable Vue).
This is because it provides access to 2 very important objects:
- Adaptable API - for programmatic access to AdapTable
- AG Grid's
Grid API- for programmatic access to AG Grid