DashboardCommands

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

DashboardCommands type

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

Signature:

export type DashboardCommands = InitializeDashboard | SaveDashboardAs | RequestAsyncRender | ResolveAsyncRender | ChangeFilterContextSelection | ChangeDateFilterSelection | ChangeAttributeFilterSelection | IChangeRenderMode | ISaveDashboard | IRenameDashboard | IResetDashboard | IExportDashboardToPdf | IExportDashboardToExcel | IExportDashboardToPdfPresentation | IExportDashboardToPptPresentation | IDeleteDashboard | ITriggerEvent | IUpsertExecutionResult | IAddAttributeFilter | IRemoveAttributeFilters | IMoveAttributeFilter | ISetAttributeFilterParents | ISetAttributeFilterDependentDateFilters | IAddLayoutSection | IMoveLayoutSection | IRemoveLayoutSection | ChangeLayoutSectionHeader | IResizeHeight | IResizeWidth | IAddSectionItems | IReplaceSectionItem | IMoveSectionItem | IMoveSectionItemToNewSection | IRemoveSectionItem | IRemoveSectionItemByWidgetRef | IUndoLayoutChanges | IChangeKpiWidgetHeader | IChangeKpiWidgetDescription | IChangeKpiWidgetConfiguration | IChangeKpiWidgetMeasure | IChangeKpiWidgetFilterSettings | IChangeKpiWidgetComparison | IRefreshKpiWidget | ISetDrillForKpiWidget | IRemoveDrillForKpiWidget | IChangeInsightWidgetHeader | IChangeInsightWidgetDescription | IChangeInsightWidgetIgnoreCrossFiltering | IChangeInsightWidgetFilterSettings | IChangeInsightWidgetVisProperties | ChangeInsightWidgetVisConfiguration | IChangeInsightWidgetInsight | IModifyDrillsForInsightWidget | IRemoveDrillsForInsightWidget | IRefreshInsightWidget | IExportInsightWidget | ICreateAlert | ISaveAlert | ICreateScheduledEmail | ISaveScheduledEmail | IChangeSharing | ISetAttributeFilterDisplayForm | ISetAttributeFilterTitle | ISetAttributeFilterSelectionMode | IChangeRichTextWidgetContent | IChangeRichTextWidgetFilterSettings | IAddVisualizationToVisualizationSwitcherWidgetContent | IUpdateVisualizationsFromVisualizationSwitcherWidgetContent | IDrill | IDrillDown | IDrillToAttributeUrl | IDrillToCustomUrl | IDrillToDashboard | IDrillToInsight | IDrillToLegacyDashboard | IChangeDrillableItems | IAddDrillTargets | ISetDashboardDateFilterConfigMode | ISetDashboardAttributeFilterConfigMode | ISetDashboardAttributeFilterConfigDisplayAsLabel | IRemoveDrillDownForInsightWidget | IRemoveDrillToUrlForInsightWidget | IAddDrillDownForInsightWidget | IModifyDrillDownForInsightWidget | ICrossFiltering | IKeyDriverAnalysis | IAttributeHierarchyModified | IAddDateFilter | IRemoveDateFilters | IMoveDateFilter | ISetDashboardDateFilterWithDimensionConfigMode | ISetDateFilterConfigTitle | IInitializeAutomations | IRefreshAutomations | ISetAttributeFilterLimitingItems | ISaveFilterView | IDeleteFilterView | IApplyFilterView | ISetFilterViewAsDefault | IReloadFilterViews | IToggleLayoutSectionHeaders | IToggleLayoutDirection | IApplyFilterContextWorkingSelection | IResetFilterContextWorkingSelection | IChangeIgnoreExecutionTimestamp | ISwitchDashboardTab | IConvertDashboardTabFromDefault | ICreateDashboardTab | IRepositionDashboardTab | IDeleteDashboardTab | IStartRenamingDashboardTab | ICancelRenamingDashboardTab | IRenameDashboardTab | ISetScreenSize | ILoadAllWorkspaceUsers | IExportRawInsightWidget | IExportSlidesInsightWidget | IExportImageInsightWidget | ISetShowWidgetAsTable;

References: InitializeDashboard, SaveDashboardAs, RequestAsyncRender, ResolveAsyncRender, ChangeFilterContextSelection, ChangeDateFilterSelection, ChangeAttributeFilterSelection, IChangeRenderMode, ISaveDashboard, IRenameDashboard, IResetDashboard, IExportDashboardToPdf, IExportDashboardToExcel, IExportDashboardToPdfPresentation, IExportDashboardToPptPresentation, IDeleteDashboard, ITriggerEvent, IUpsertExecutionResult, IAddAttributeFilter, IRemoveAttributeFilters, IMoveAttributeFilter, ISetAttributeFilterParents, ISetAttributeFilterDependentDateFilters, IAddLayoutSection, IMoveLayoutSection, IRemoveLayoutSection, ChangeLayoutSectionHeader, IResizeHeight, IResizeWidth, IAddSectionItems, IReplaceSectionItem, IMoveSectionItem, IMoveSectionItemToNewSection, IRemoveSectionItem, IRemoveSectionItemByWidgetRef, IUndoLayoutChanges, IChangeKpiWidgetHeader, IChangeKpiWidgetDescription, IChangeKpiWidgetConfiguration, IChangeKpiWidgetMeasure, IChangeKpiWidgetFilterSettings, IChangeKpiWidgetComparison, IRefreshKpiWidget, ISetDrillForKpiWidget, IRemoveDrillForKpiWidget, IChangeInsightWidgetHeader, IChangeInsightWidgetDescription, IChangeInsightWidgetIgnoreCrossFiltering, IChangeInsightWidgetFilterSettings, IChangeInsightWidgetVisProperties, ChangeInsightWidgetVisConfiguration, IChangeInsightWidgetInsight, IModifyDrillsForInsightWidget, IRemoveDrillsForInsightWidget, IRefreshInsightWidget, IExportInsightWidget, ICreateAlert, ISaveAlert, ICreateScheduledEmail, ISaveScheduledEmail, IChangeSharing, ISetAttributeFilterDisplayForm, ISetAttributeFilterTitle, ISetAttributeFilterSelectionMode, IChangeRichTextWidgetContent, IChangeRichTextWidgetFilterSettings, IAddVisualizationToVisualizationSwitcherWidgetContent, IUpdateVisualizationsFromVisualizationSwitcherWidgetContent, IDrill, IDrillDown, IDrillToAttributeUrl, IDrillToCustomUrl, IDrillToDashboard, IDrillToInsight, IDrillToLegacyDashboard, IChangeDrillableItems, IAddDrillTargets, ISetDashboardDateFilterConfigMode, ISetDashboardAttributeFilterConfigMode, ISetDashboardAttributeFilterConfigDisplayAsLabel, IRemoveDrillDownForInsightWidget, IRemoveDrillToUrlForInsightWidget, IAddDrillDownForInsightWidget, IModifyDrillDownForInsightWidget, ICrossFiltering, IKeyDriverAnalysis, IAttributeHierarchyModified, IAddDateFilter, IRemoveDateFilters, IMoveDateFilter, ISetDashboardDateFilterWithDimensionConfigMode, ISetDateFilterConfigTitle, IInitializeAutomations, IRefreshAutomations, ISetAttributeFilterLimitingItems, ISaveFilterView, IDeleteFilterView, IApplyFilterView, ISetFilterViewAsDefault, IReloadFilterViews, IApplyFilterContextWorkingSelection, IResetFilterContextWorkingSelection, IChangeIgnoreExecutionTimestamp, ISwitchDashboardTab, IConvertDashboardTabFromDefault, ICreateDashboardTab, IRepositionDashboardTab, IDeleteDashboardTab, IStartRenamingDashboardTab, ICancelRenamingDashboardTab, IRenameDashboardTab, IExportRawInsightWidget, IExportSlidesInsightWidget, IExportImageInsightWidget, ISetShowWidgetAsTable

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.