IDashboardCommand

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

IDashboardCommand interface

Base type for all commands.

Signature:

export interface IDashboardCommand

Remarks

Commands are dispatched using dispatcher obtained by useDashboardDispatcher(). All the dispatchers are 'contextual' - they target backend, workspace and dashboard in depending on the Dashboard component tree from which the dispatch is done.

Properties

PropertyTypeDescription
correlationId?string(Optional) Correlation ID can be provided when creating a command.
meta?CommandProcessingMeta(Optional) Metadata related to processing of the command by the dashboard component.
typeDashboardCommandTypeCommand type. Always starts with "GDC.DASH/CMD"
← IDashboardBasePropsIDashboardCustomComponentProps →