DashboardEvents

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

DashboardEvents type

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

Signature:

export type DashboardEvents = DashboardInitialized | DashboardDeinitialized | DateFilterValidationFailed | DashboardSaved | DashboardCopySaved | DashboardRenderRequested | DashboardAsyncRenderRequested | DashboardAsyncRenderResolved | DashboardRenderResolved | DashboardSharingChanged | IDashboardRenderModeChanged | IDashboardCommandStarted<any> | IDashboardCommandFailed<any> | IDashboardCommandRejected | IDashboardQueryFailed | IDashboardQueryRejected | IDashboardQueryStarted | IDashboardQueryCompleted<any, any> | IDashboardRenamed | IDashboardWasReset | IDashboardExportToPdfRequested | IDashboardExportToPdfResolved | IDashboardExportToExcelRequested | IDashboardExportToExcelResolved | IDashboardExportToPdfPresentationRequested | IDashboardExportToPdfPresentationResolved | IDashboardExportToPptPresentationResolved | IDashboardExportToPptPresentationRequested | IDashboardExportToImageRequested | IDashboardExportToImageResolved | IDashboardUserInteractionTriggered | DashboardDateFilterSelectionChanged | IDashboardAttributeFilterAdded | IDashboardAttributeFilterRemoved | IDashboardAttributeFilterMoved | DashboardAttributeFilterSelectionChanged | IDashboardAttributeTitleChanged | IDashboardAttributeSelectionModeChanged | IDashboardAttributeFilterParentChanged | DashboardFilterContextChanged | IDashboardLayoutSectionAdded | IDashboardLayoutSectionMoved | IDashboardLayoutSectionRemoved | IDashboardLayoutSectionHeaderChanged | IDashboardLayoutSectionItemsAdded | IDashboardLayoutSectionItemReplaced | IDashboardLayoutSectionItemMoved | IDashboardLayoutSectionItemRemoved | IDashboardLayoutSectionItemMovedToNewSection | IDashboardLayoutChanged | IDashboardKpiWidgetHeaderChanged | IDashboardKpiWidgetDescriptionChanged | IDashboardKpiWidgetConfigurationChanged | IDashboardKpiWidgetMeasureChanged | IDashboardKpiWidgetFilterSettingsChanged | IDashboardKpiWidgetComparisonChanged | IDashboardKpiWidgetDrillRemoved | IDashboardKpiWidgetDrillSet | IDashboardKpiWidgetChanged | IDashboardInsightWidgetHeaderChanged | IDashboardInsightWidgetDescriptionChanged | IDashboardInsightWidgetFilterSettingsChanged | IDashboardInsightWidgetVisPropertiesChanged | IDashboardInsightWidgetVisConfigurationChanged | IDashboardInsightWidgetInsightSwitched | IDashboardInsightWidgetDrillsModified | IDashboardInsightWidgetDrillsRemoved | IDashboardInsightWidgetChanged | IDashboardInsightWidgetExportRequested | IDashboardInsightWidgetExportResolved | IDashboardInsightWidgetRefreshed | IDashboardRichTextWidgetContentChanged | IDashboardRichTextWidgetFilterSettingsChanged | IDashboardVisualizationSwitcherWidgetVisualizationAdded | IDashboardVisualizationSwitcherWidgetVisualizationsUpdated | IDashboardWidgetExecutionStarted | IDashboardWidgetExecutionSucceeded | IDashboardWidgetExecutionFailed | IDashboardAlertCreated | IDashboardAlertSaved | IDashboardScheduledEmailCreated | IDashboardScheduledEmailSaved | IDashboardAutomationsRefreshed | IShowWidgetAsTableSet | IDashboardDrillDownResolved | IDashboardDrillToAttributeUrlResolved | IDashboardDrillToCustomUrlResolved | IDashboardDrillToDashboardResolved | IDashboardDrillToInsightResolved | IDashboardDrillToLegacyDashboardResolved | IDashboardKeyDriverAnalysisResolved | IDashboardKeyDriverAnalysisRequested | IDashboardDrillResolved | IDashboardDrillDownRequested | IDashboardDrillToAttributeUrlRequested | IDashboardDrillToCustomUrlRequested | IDashboardDrillToDashboardRequested | IDashboardDrillToInsightRequested | IDashboardDrillToLegacyDashboardRequested | IDashboardDrillRequested | IDashboardDrillableItemsChanged | IDashboardIgnoreExecutionTimestampChanged | IDashboardTabSwitched | IDashboardTabConvertedFromDefault | IDashboardTabCreated | IDashboardTabDeleted | IDashboardTabRenamingStarted | IDashboardTabRenamingCanceled | IDashboardTabRenamed | ICreateInsightRequested | ICreateAttributeHierarchyRequested | IDeleteAttributeHierarchyRequested;

References: DashboardInitialized, DashboardDeinitialized, DateFilterValidationFailed, DashboardSaved, DashboardCopySaved, DashboardRenderRequested, DashboardAsyncRenderRequested, DashboardAsyncRenderResolved, DashboardRenderResolved, DashboardSharingChanged, IDashboardRenderModeChanged, IDashboardCommandStarted, IDashboardCommandFailed, IDashboardCommandRejected, IDashboardQueryFailed, IDashboardQueryRejected, IDashboardQueryStarted, IDashboardQueryCompleted, IDashboardRenamed, IDashboardWasReset, IDashboardExportToPdfRequested, IDashboardExportToPdfResolved, IDashboardExportToExcelRequested, IDashboardExportToExcelResolved, IDashboardExportToPdfPresentationRequested, IDashboardExportToPdfPresentationResolved, IDashboardExportToPptPresentationResolved, IDashboardExportToPptPresentationRequested, IDashboardExportToImageRequested, IDashboardExportToImageResolved, IDashboardUserInteractionTriggered, DashboardDateFilterSelectionChanged, IDashboardAttributeFilterAdded, IDashboardAttributeFilterRemoved, IDashboardAttributeFilterMoved, DashboardAttributeFilterSelectionChanged, IDashboardAttributeTitleChanged, IDashboardAttributeSelectionModeChanged, IDashboardAttributeFilterParentChanged, DashboardFilterContextChanged, IDashboardLayoutSectionAdded, IDashboardLayoutSectionMoved, IDashboardLayoutSectionRemoved, IDashboardLayoutSectionHeaderChanged, IDashboardLayoutSectionItemsAdded, IDashboardLayoutSectionItemReplaced, IDashboardLayoutSectionItemMoved, IDashboardLayoutSectionItemRemoved, IDashboardLayoutSectionItemMovedToNewSection, IDashboardLayoutChanged, IDashboardKpiWidgetHeaderChanged, IDashboardKpiWidgetDescriptionChanged, IDashboardKpiWidgetConfigurationChanged, IDashboardKpiWidgetMeasureChanged, IDashboardKpiWidgetFilterSettingsChanged, IDashboardKpiWidgetComparisonChanged, IDashboardKpiWidgetDrillRemoved, IDashboardKpiWidgetDrillSet, IDashboardKpiWidgetChanged, IDashboardInsightWidgetHeaderChanged, IDashboardInsightWidgetDescriptionChanged, IDashboardInsightWidgetFilterSettingsChanged, IDashboardInsightWidgetVisPropertiesChanged, IDashboardInsightWidgetVisConfigurationChanged, IDashboardInsightWidgetInsightSwitched, IDashboardInsightWidgetDrillsModified, IDashboardInsightWidgetDrillsRemoved, IDashboardInsightWidgetChanged, IDashboardInsightWidgetExportRequested, IDashboardInsightWidgetExportResolved, IDashboardInsightWidgetRefreshed, IDashboardRichTextWidgetContentChanged, IDashboardRichTextWidgetFilterSettingsChanged, IDashboardVisualizationSwitcherWidgetVisualizationAdded, IDashboardVisualizationSwitcherWidgetVisualizationsUpdated, IDashboardWidgetExecutionStarted, IDashboardWidgetExecutionSucceeded, IDashboardWidgetExecutionFailed, IDashboardAlertCreated, IDashboardAlertSaved, IDashboardScheduledEmailCreated, IDashboardScheduledEmailSaved, IDashboardAutomationsRefreshed, IShowWidgetAsTableSet, IDashboardDrillDownResolved, IDashboardDrillToAttributeUrlResolved, IDashboardDrillToCustomUrlResolved, IDashboardDrillToDashboardResolved, IDashboardDrillToInsightResolved, IDashboardDrillToLegacyDashboardResolved, IDashboardKeyDriverAnalysisResolved, IDashboardKeyDriverAnalysisRequested, IDashboardDrillResolved, IDashboardDrillDownRequested, IDashboardDrillToAttributeUrlRequested, IDashboardDrillToCustomUrlRequested, IDashboardDrillToDashboardRequested, IDashboardDrillToInsightRequested, IDashboardDrillToLegacyDashboardRequested, IDashboardDrillRequested, IDashboardDrillableItemsChanged, IDashboardIgnoreExecutionTimestampChanged, IDashboardTabSwitched, IDashboardTabConvertedFromDefault, IDashboardTabCreated, IDashboardTabDeleted, IDashboardTabRenamingStarted, IDashboardTabRenamingCanceled, IDashboardTabRenamed

Remarks

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