useDashboardEventDispatch() · GoodData.UI API reference

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

useDashboardEventDispatch() function

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Convenience hook for dispatching Dashboard events.

Signature:

useDashboardEventDispatch: () => ((eventBody: DashboardEventBody<DashboardEvents | ICustomDashboardEvent>) => void)

Returns:

((eventBody: DashboardEventBody<DashboardEvents | ICustomDashboardEvent>) => void)

function that you can use to dispatch Dashboard events