IAnalyticalDesignerEventDataMap
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Payload of each event Analytical Designer emits, by the type of the event.
export interface IAnalyticalDesignerEventDataMap
Remarks
The types are the names of the @gooddata/sdk-embedding contract of the embedded Analytical Designer, for example GdcAdEventType.InsightSaved is visualizationSaved.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
Record<string, never> | (ALPHA) The API token of Analytical Designer expires soon. | ||
ICommandFailedBody | (ALPHA) A command the host sent failed. | ||
IAdAvailableCommands | (ALPHA) The user created, changed or deleted an attribute hierarchy. | ||
GdcAdCommandType[] | (ALPHA) The commands Analytical Designer accepts changed. | ||
AdCatalogLoadedBody | (ALPHA) The catalog loaded. | ||
IAdAvailableCommands | (ALPHA) A | ||
IAdAvailableCommands | (ALPHA) A | ||
(ALPHA) The user drilled in the insight. | |||
AdExportFinishedBody | (ALPHA) An | ||
AdFilterContextChangedBody | (ALPHA) The user changed a filter of the insight. | ||
AdInsightChangedBody | (ALPHA) The insight definition changed and its execution started. | ||
null | (ALPHA) The user cancelled the editing. | ||
(ALPHA) Analytical Designer opened an insight. | |||
AdInsightRenderedBody | (ALPHA) The insight rendered. | ||
Record<string, never> | (ALPHA) Analytical Designer accepts the | ||
Record<string, never> | (ALPHA) The user saved or deleted a metric. A host that shares a caching backend with Analytical Designer resets its caches here. | ||
IAdAvailableCommands | (ALPHA) A | ||
IAdAvailableCommands | (ALPHA) A | ||
IAdAvailableCommands | (ALPHA) A | ||
IAdAvailableCommands | (ALPHA) An | ||
AdInsightSavedBody | (ALPHA) The user or a |
Property details
IAnalyticalDesignerEventDataMap.apiTokenIsAboutToExpirepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The API token of Analytical Designer expires soon.
apiTokenIsAboutToExpire: Record<string, never>;
IAnalyticalDesignerEventDataMap.appCommandFailedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
A command the host sent failed.
appCommandFailed: ICommandFailedBody;
IAnalyticalDesignerEventDataMap.attributeHierarchyModifiedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The user created, changed or deleted an attribute hierarchy.
attributeHierarchyModified: IAdAvailableCommands;
IAnalyticalDesignerEventDataMap.availableCommandspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The commands Analytical Designer accepts changed.
availableCommands: GdcAdCommandType[];
IAnalyticalDesignerEventDataMap.catalogLoadedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The catalog loaded.
catalogLoaded: AdCatalogLoadedBody;
IAnalyticalDesignerEventDataMap.clearFinishedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
A clear command finished.
clearFinished: IAdAvailableCommands;
IAnalyticalDesignerEventDataMap.clearInsightFinishedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
A clearInsight command finished.
clearInsightFinished: IAdAvailableCommands;
IAnalyticalDesignerEventDataMap.drillpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The user drilled in the insight.
drill: IDrillEvent;
IAnalyticalDesignerEventDataMap.exportInsightFinishedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
An exportInsight command finished, with the link to the exported file.
exportInsightFinished: AdExportFinishedBody;
IAnalyticalDesignerEventDataMap.filterContextChangedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The user changed a filter of the insight.
filterContextChanged: AdFilterContextChangedBody;
IAnalyticalDesignerEventDataMap.insightChangedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The insight definition changed and its execution started.
insightChanged: AdInsightChangedBody;
IAnalyticalDesignerEventDataMap.insightEditingCancelledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The user cancelled the editing.
insightEditingCancelled: null;
IAnalyticalDesignerEventDataMap.insightOpenedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Analytical Designer opened an insight.
insightOpened: IAnalyticalDesignerInsightOpenedData;
IAnalyticalDesignerEventDataMap.insightRenderedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The insight rendered.
insightRendered: AdInsightRenderedBody;
IAnalyticalDesignerEventDataMap.listeningForDrillableItemspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Analytical Designer accepts the drillableItems command.
listeningForDrillableItems: Record<string, never>;
IAnalyticalDesignerEventDataMap.metricsChangedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The user saved or deleted a metric. A host that shares a caching backend with Analytical Designer resets its caches here.
metricsChanged: Record<string, never>;
IAnalyticalDesignerEventDataMap.redoFinishedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
A redo command finished.
redoFinished: IAdAvailableCommands;
IAnalyticalDesignerEventDataMap.removeFilterContextFinishedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
A removeFilterContext command finished.
removeFilterContextFinished: IAdAvailableCommands;
IAnalyticalDesignerEventDataMap.setFilterContextFinishedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
A setFilterContext command finished.
setFilterContextFinished: IAdAvailableCommands;
IAnalyticalDesignerEventDataMap.undoFinishedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
An undo command finished.
undoFinished: IAdAvailableCommands;
IAnalyticalDesignerEventDataMap.visualizationSavedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The user or a save command saved the insight.
visualizationSaved: AdInsightSavedBody;