GoodData.UI API reference
  • GoodData.UI
  • Docs & APIs
  • Developers
  • GoodData.CN
  • GoodData.UI
  • Docs & APIs
  • Get GoodData.CN Community Edition
  • 10.26.0
  • Code samples
  • Gallery
  • GitHub

addEventHandler()

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

IDashboardEventHandling.addEventHandler() method

Adds a handler for particular event type.

Signature:

addEventHandler<TEvents extends DashboardEvents | ICustomDashboardEvent>(eventType: DashboardEventType | string | "*", callback: DashboardEventHandlerFn<TEvents>): IDashboardEventHandling;

Parameters

ParameterTypeDescription
eventTypeDashboardEventType | string | "*"type of the event to handle; this can be either built-event event type (see DashboardEventType), a custom event type or '*' to register handler for all events
callbackDashboardEventHandlerFn<TEvents>function to call when the event occurs

Returns:

IDashboardEventHandling

Remarks

Every time event of that type occurs, the provided callback function will be triggered.

  • IDashboardEventHandling.addEventHandler() method
  • Parameters
  • Remarks
GoodData resources:
  • Documentation
Follow the community:
  • Community
Copyright © 2007–2025 GoodData Corporation. All Rights Reserved. Code licensed under a dual license - CC BY‑NC 4.0 for trial experience and GoodData.UI EULA for commercial use