DashboardCommands

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

DashboardCommands type

Union type that contains all available built-in dashboard commands.

Signature:

export declare type DashboardCommands = InitializeDashboard | SaveDashboardAs | RequestAsyncRender | ResolveAsyncRender | ChangeFilterContextSelection | ChangeDateFilterSelection | ChangeAttributeFilterSelection | ChangeRenderMode | SaveDashboard | RenameDashboard | ResetDashboard | ExportDashboardToPdf | DeleteDashboard | TriggerEvent | UpsertExecutionResult | AddAttributeFilter | RemoveAttributeFilters | MoveAttributeFilter | SetAttributeFilterParents | AddLayoutSection | MoveLayoutSection | RemoveLayoutSection | ChangeLayoutSectionHeader | ResizeHeight | ResizeWidth | AddSectionItems | ReplaceSectionItem | MoveSectionItem | MoveSectionItemToNewSection | RemoveSectionItem | RemoveSectionItemByWidgetRef | UndoLayoutChanges | ChangeKpiWidgetHeader | ChangeKpiWidgetDescription | ChangeKpiWidgetConfiguration | ChangeKpiWidgetMeasure | ChangeKpiWidgetFilterSettings | ChangeKpiWidgetComparison | RefreshKpiWidget | SetDrillForKpiWidget | RemoveDrillForKpiWidget | ChangeInsightWidgetHeader | ChangeInsightWidgetDescription | ChangeInsightWidgetFilterSettings | ChangeInsightWidgetVisProperties | ChangeInsightWidgetVisConfiguration | ChangeInsightWidgetInsight | ModifyDrillsForInsightWidget | RemoveDrillsForInsightWidget | RefreshInsightWidget | ExportInsightWidget | CreateAlert | UpdateAlert | RemoveAlerts | CreateScheduledEmail | SaveScheduledEmail | ChangeSharing | SetAttributeFilterDisplayForm | Drill | DrillDown | DrillToAttributeUrl | DrillToCustomUrl | DrillToDashboard | DrillToInsight | DrillToLegacyDashboard | ChangeDrillableItems | AddDrillTargets;

References: InitializeDashboard, SaveDashboardAs, RequestAsyncRender, ResolveAsyncRender, ChangeFilterContextSelection, ChangeDateFilterSelection, ChangeAttributeFilterSelection, ChangeRenderMode, SaveDashboard, RenameDashboard, ResetDashboard, ExportDashboardToPdf, DeleteDashboard, TriggerEvent, UpsertExecutionResult, AddAttributeFilter, RemoveAttributeFilters, MoveAttributeFilter, SetAttributeFilterParents, AddLayoutSection, MoveLayoutSection, RemoveLayoutSection, ChangeLayoutSectionHeader, ResizeHeight, ResizeWidth, AddSectionItems, ReplaceSectionItem, MoveSectionItem, MoveSectionItemToNewSection, RemoveSectionItem, RemoveSectionItemByWidgetRef, UndoLayoutChanges, ChangeKpiWidgetHeader, ChangeKpiWidgetDescription, ChangeKpiWidgetConfiguration, ChangeKpiWidgetMeasure, ChangeKpiWidgetFilterSettings, ChangeKpiWidgetComparison, RefreshKpiWidget, SetDrillForKpiWidget, RemoveDrillForKpiWidget, ChangeInsightWidgetHeader, ChangeInsightWidgetDescription, ChangeInsightWidgetFilterSettings, ChangeInsightWidgetVisProperties, ChangeInsightWidgetVisConfiguration, ChangeInsightWidgetInsight, ModifyDrillsForInsightWidget, RemoveDrillsForInsightWidget, RefreshInsightWidget, ExportInsightWidget, CreateAlert, UpdateAlert, RemoveAlerts, CreateScheduledEmail, SaveScheduledEmail, ChangeSharing, SetAttributeFilterDisplayForm

Remarks

Note: while this type is marked as public most of the commands are currently an alpha-level API that we reserve to change in the following releases. If you use those commands now, upgrading to the next version of @gooddata/sdk-ui-dashboard will likely result in breakage.

← DashboardCommandRejectedDashboardCommandStarted →