DashboardCommandFailed

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

DashboardCommandFailed interface

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

This event is emitted if a particular command processing fails. The failure may be for two general reasons:

  • A user error was made; dispatched command is found to have bad payload or the dispatched command is not applicable in the current state of the dashboard

  • An internal error has occurred in the dashboard component - highly likely due to a bug.

Signature:

export interface DashboardCommandFailed<TCommand extends IDashboardCommand = IDashboardCommand> extends IDashboardEvent

Extends: IDashboardEvent

Properties

Property

Modifiers

Type

Description

payload

readonly

DashboardCommandFailedPayload<TCommand>

(BETA)

type

readonly

"GDC.DASH/EVT.COMMAND.FAILED"

(BETA)

← DashboardAutomationsRefreshedDashboardCommandFailedPayload →