removeEventHandler()
Home > @gooddata/sdk-ui-dashboard > IDashboardEventHandling > removeEventHandler
IDashboardEventHandling.removeEventHandler() method
Removes a handler for particular event type. This is reverse operation to IDashboardEventHandling.addEventHandler().
Signature:
removeEventHandler<TEvents extends DashboardEvents | ICustomDashboardEvent>(eventType: DashboardEventType | string | "*", callback: DashboardEventHandlerFn<TEvents>): IDashboardEventHandling;
Parameters
| Parameter | Type | Description |
|---|---|---|
| eventType | DashboardEventType | string | "*" | type of the event to stop handling; this can be either built-event event type (see DashboardEventType), a custom event type or '*' to register handler for all events |
| callback | DashboardEventHandlerFn<TEvents> | originally registered callback function |
Returns:
self, for call chaining sakes
Remarks
In order for this method to remove a handler, the arguments must be the same when you added the handler.
E.g. it is not possible to add a handler for all events using '*' and then subtract just one particular event from handling.