INestedLayoutProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
export interface INestedLayoutProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Backend to work with. | |||
number | (ALPHA) (Optional) Height of the visualization switcher widget container. | ||
number | (ALPHA) (Optional) Width of the visualization switcher widget container. | ||
string | (ALPHA) (Optional) CSS classes to apply to the nested layout dashboard item. | ||
(ALPHA) (Optional) Corresponding layout. If not provided, root layout from appState will be used. | |||
(ALPHA) (Optional) Item size. If not provided, the layout size will be considered to be default (12 columns) | |||
(ALPHA) (Optional) Item path. If not provided, the layout is expected to be root | |||
(ALPHA) (Optional) Nested layout widget to render. | |||
string | (ALPHA) (Optional) Workspace where the Insight widget exists. |
Property details
INestedLayoutProps.backendpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
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.
INestedLayoutProps.clientHeightpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Height of the visualization switcher widget container.
clientHeight?: number;
INestedLayoutProps.clientWidthpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Width of the visualization switcher widget container.
clientWidth?: number;
INestedLayoutProps.dashboardItemClassespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
CSS classes to apply to the nested layout dashboard item.
dashboardItemClasses?: string;
INestedLayoutProps.layoutpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Corresponding layout. If not provided, root layout from appState will be used.
layout?: IDashboardLayout<ExtendedDashboardWidget>;
INestedLayoutProps.parentLayoutItemSizepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Item size. If not provided, the layout size will be considered to be default (12 columns)
parentLayoutItemSize?: IDashboardLayoutSizeByScreenSize;
INestedLayoutProps.parentLayoutPathpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Item path. If not provided, the layout is expected to be root
parentLayoutPath?: ILayoutItemPath;
INestedLayoutProps.widgetpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Nested layout widget to render.
widget?: ExtendedDashboardLayoutWidget;
INestedLayoutProps.workspacepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
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.