IDashboardRichTextProps
Rich text widget props.
export interface IDashboardRichTextProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Backend to work with. | |||
number | (ALPHA) (Optional) Height of the rich text widget container. | ||
number | (ALPHA) (Optional) Width of the rich text widget container. | ||
(ALPHA) (Optional) Data for export in export mode. | |||
(ALPHA) (Optional) | |||
(Optional) Callback to receive notifications about loading state of the widget. | |||
(ALPHA) (Optional) Data for export in export mode. | |||
Definition of insight widget to render. | |||
string | (ALPHA) (Optional) Workspace where the Insight widget exists. |
Property details
IDashboardRichTextProps.backendpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Backend to work with.
backend?: IAnalyticalBackend;
Remarks
Note: the backend must come either from this property or from BackendContext. If you do not specify backend here, then the component MUST be rendered within an existing BackendContext.
IDashboardRichTextProps.clientHeightpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Height of the rich text widget container.
clientHeight?: number;
IDashboardRichTextProps.clientWidthpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Width of the rich text widget container.
clientWidth?: number;
IDashboardRichTextProps.exportDatapropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Data for export in export mode.
exportData?: WidgetExportDataAttributes;
IDashboardRichTextProps.onErrorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
onError?: OnError;
IDashboardRichTextProps.onLoadingChangedproperty
Callback to receive notifications about loading state of the widget.
onLoadingChanged?: OnLoadingChanged;
IDashboardRichTextProps.richTextExportDatapropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Data for export in export mode.
richTextExportData?: RichTextExportData;
IDashboardRichTextProps.widgetproperty
Definition of insight widget to render.
widget: IRichTextWidget;
IDashboardRichTextProps.workspacepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Workspace where the Insight widget exists.
workspace?: string;
Remarks
Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify workspace here, then the component MUST be rendered within an existing WorkspaceContext.