Getting Started Technical Reference

Adaptable Ready Event

The Adaptable Ready Event provides an AdaptableReadyInfo object with 2 key properties:

• adaptableApi — the Adaptable API (from Base Context)
• agGridApi — AG Grid's Grid API, returned on this object and also available as adaptableApi.agGridApi

Subscribing to the Event

Vanilla Adaptable.init already returns adaptableApi. Subscribe with eventApi.on for setup that must wait until the Grid is ready.

const adaptableApi = await Adaptable.init(adaptableOptions, agGridConfig);

adaptableApi.eventApi.on(
  'AdaptableReady',
  ({adaptableApi, agGridApi}: AdaptableReadyInfo) => {
    adaptableApi.quickSearchApi.runQuickSearch('react');
    agGridApi.autoSizeAllColumns();
  }
);

Once you have adaptableApi, later Adaptable Events are subscribed in the usual way: adaptableApi.eventApi.on(...).

AG Grid API

agGridApi is AG Grid's Grid API (of type AgGridApi).

AdapTable does not declare methods of its own on this type.

The Adaptable Ready Event returns it on the AdaptableReadyInfo object, next to adaptableApi.

The subscription examples above read it from that payload:

({agGridApi}: AdaptableReadyInfo) => {
  agGridApi.autoSizeAllColumns();
};

The same Grid API object is a property on the base of the Adaptable API.

Any code that already holds adaptableApi reaches it there:

adaptableApi.agGridApi.autoSizeAllColumns();