ICustomDashboardEvent

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

ICustomDashboardEvent interface

Base type for all custom events.

Signature:

export interface ICustomDashboardEvent<TPayload = any> 

Properties

Property	Modifiers	Type	Description
ctx	readonly	DashboardContext	Dashboard context in which the event occurred.
meta?	readonly	{ acceptedTimestamp: number; }	(Optional) Metadata about the event useful for logging and handling of the event.
payload?	readonly	TPayload	(Optional) Specify any additional data the custom event needs.
type	readonly	string	Event type. Always starts with "CUSTOM/EVT".