IDashboardEventHandling

Home > @gooddata/sdk-ui-dashboard > IDashboardEventHandling

IDashboardEventHandling interface

Defines a facade that you can use to register or unregister dashboard event handlers.

Signature:

export interface IDashboardEventHandling

Methods

MethodDescription
addCustomEventHandler(handler)Adds a custom event handler. This is a lower-level API where the handler can include both the function to evaluate events and the function to trigger when the evaluation succeeds.
addEventHandler(eventType, callback)Adds a handler for particular event type.
removeCustomEventHandler(handler)Removes custom event handler.
removeEventHandler(eventType, callback)Removes a handler for particular event type. This is reverse operation to IDashboardEventHandling.addEventHandler().
subscribeToStateChanges(callback)Subscribe to state changes of the dashboard.
unsubscribeFromStateChanges(callback)Unsubscribe from receiving calls about state changes of the dashboard.
← IDashboardEventIDashboardEventing →