IDashboardEvent

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

IDashboardEvent interface

Base type for all dashboard events.

Signature:

export interface IDashboardEvent<TPayload = any> 

Properties

Property	Modifiers	Type	Description
correlationId?	readonly	string	(Optional) If this event was triggered as part of a command processing, then the prop will contain command's correlation ID.
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	DashboardEventType	Event type. Always starts with "GDC.DASH/EVT".