Adaptable Events Reference

Understanding Adaptable Events

AdapTable fires many Events throughout the application's lifecyle to which developers can subscribe.

Most AdapTable Events react to one of 2 types of action:

• An AdapTable Module or functionality doing something

  Examples include LayoutChanged, SystemStatusMessageDisplayed, AlertFired, DashboardChanged etc.

• Something happening in AG Grid

  Examples include CellChanged, CellSelectionChanged, RowChanged etc.

Subscribing to Events

Subscription to Adaptable Events is done via the on method in the Event section of the Adaptable API.

This takes 2 parameters:

• eventName - name of the Adaptable Event being subscribed to

• callback - object containing relevant information to the Adaptable Event and why it fired

  Note

  The callback object is always of type [EventName]Info - e.g. LayoutChangedInfo

Base Context

Every EventInfo object inherits from the BaseContext object which has these properties:

For example the definition of the LayoutChangedEvent is:

on(
    eventName: 'LayoutChanged',
    callback: (eventInfo: LayoutChangedInfo) => void
): () => void;

So to subscribe to the event you can do something like:

adaptableApi.eventApi.on('LayoutChanged', (eventInfo: LayoutChangedInfo) => {
    // do something with the info
});

Unsubscribing from Events

For every Adaptable Event there is a parallel unsubsciption off method.

This takes the same form as the on method, so unsubscribing from the LayoutChangedEvent is simply:

off(
    eventName: 'LayoutChanged',
    callback: (eventInfo: LayoutChangedInfo) => void
): () => void;

List of Adaptable Events

Event API

The EventAPI section of Adaptable API is used to publish Adaptable Events