IAnalyticalDesignerApi
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Commands a host sends to Analytical Designer.
export interface IAnalyticalDesignerApi
Methods
Method | Description |
|---|---|
(ALPHA) Clears the insight. | |
(ALPHA) Asks Analytical Designer to cancel the editing. Analytical Designer confirms unsaved changes first. | |
(ALPHA) Sends any command of the | |
(ALPHA) Merges a dashboard filter context into the filters of the open insight. |
Method details
IAnalyticalDesignerApi.clear()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Clears the insight.
clear(): void;
Returns
void
IAnalyticalDesignerApi.requestCancellation()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Asks Analytical Designer to cancel the editing. Analytical Designer confirms unsaved changes first.
requestCancellation(): void;
Returns
void
IAnalyticalDesignerApi.sendCommand()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Sends any command of the @gooddata/sdk-embedding contract.
sendCommand(command: AdCommandData): void;
Parameters
Parameter | Type | Description |
|---|---|---|
command | AdCommandData |
Returns
void
IAnalyticalDesignerApi.setFilterContext()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Merges a dashboard filter context into the filters of the open insight.
setFilterContext(data: IFilterContextContent, contextId?: string): void;
Parameters
Parameter | Type | Description |
|---|---|---|
data | IFilterContextContent | |
contextId | string | (Optional) |
Returns
void