IAnalyticalDesignerEmbedProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Props of the control that embeds the visualization.
export interface IAnalyticalDesignerEmbedProps extends IAnalyticalDesignerHeaderContext
Extends: IAnalyticalDesignerHeaderContext
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) Label of the choice that opens the documentation about embedding Analytical Designer. | ||
string | (ALPHA) Address of the documentation about embedding Analytical Designer. | ||
string | (ALPHA) (Optional) Why the visualization cannot be embedded. | ||
string | (ALPHA) Label of the choice that shows the code embedding the visualization. | ||
boolean | (ALPHA) Whether the visualization cannot be embedded, because it is empty. | ||
string | (ALPHA) Accessible name of the control. | ||
() => void | (ALPHA) Opens the dialog with the code embedding the visualization. Ignored when it cannot be embedded. |
Property details
IAnalyticalDesignerEmbedProps.documentationLabelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Label of the choice that opens the documentation about embedding Analytical Designer.
documentationLabel: string;
IAnalyticalDesignerEmbedProps.documentationUrlpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Address of the documentation about embedding Analytical Designer.
documentationUrl: string;
IAnalyticalDesignerEmbedProps.embedInsightDisabledReasonpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Why the visualization cannot be embedded.
embedInsightDisabledReason?: string;
IAnalyticalDesignerEmbedProps.embedInsightLabelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Label of the choice that shows the code embedding the visualization.
embedInsightLabel: string;
IAnalyticalDesignerEmbedProps.isEmbedInsightDisabledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the visualization cannot be embedded, because it is empty.
isEmbedInsightDisabled: boolean;
IAnalyticalDesignerEmbedProps.labelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Accessible name of the control.
label: string;
IAnalyticalDesignerEmbedProps.onEmbedInsightpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Opens the dialog with the code embedding the visualization. Ignored when it cannot be embedded.
onEmbedInsight: () => void;