IAnalyticalDesignerProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Props of the Analytical Designer component.
export interface IAnalyticalDesignerProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Receives the commands the host sends to Analytical Designer. | |||
(ALPHA) (Optional) Backend to work with. The default comes from the | |||
(ALPHA) (Optional) Resets the caches of the backend when Analytical Designer needs fresh data, for example when the user refreshes the catalog. Pass it when the backend caches; the latest value is used. | |||
(ALPHA) (Optional) Configuration of Analytical Designer. | |||
boolean | (ALPHA) (Optional) Skips loading the theme of the workspace. | ||
(ALPHA) (Optional) Insight to open: an identifier, a reference or the insight. Undefined opens a new insight. | |||
(error: unknown) => void | (ALPHA) (Optional) Called when Analytical Designer cannot start. | ||
(event: AnalyticalDesignerEvent) => void | (ALPHA) (Optional) Called with every event Analytical Designer emits. Check | ||
(ALPHA) (Optional) Permissions of the current user in the workspace. Analytical Designer loads them when they are not provided. | |||
(ALPHA) (Optional) Regions of Analytical Designer that the host replaces or wraps. | |||
(ALPHA) (Optional) Theme to apply. Analytical Designer loads the theme of the workspace when it is not provided. | |||
(ALPHA) (Optional) Changes the theme before Analytical Designer applies it. | |||
string | (ALPHA) (Optional) Workspace to work in. The default comes from the |
Property details
IAnalyticalDesignerProps.apiRefpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Receives the commands the host sends to Analytical Designer.
apiRef?: Ref<IAnalyticalDesignerApi>;
IAnalyticalDesignerProps.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. The default comes from the BackendProvider. It is read at mount: to switch the backend, remount the component with a new key.
backend?: IAnalyticalBackend;
IAnalyticalDesignerProps.cacheResetpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Resets the caches of the backend when Analytical Designer needs fresh data, for example when the user refreshes the catalog. Pass it when the backend caches; the latest value is used.
cacheReset?: IAnalyticalDesignerCacheReset;
IAnalyticalDesignerProps.configpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Configuration of Analytical Designer.
config?: IAnalyticalDesignerConfig;
IAnalyticalDesignerProps.disableThemeLoadingpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Skips loading the theme of the workspace.
disableThemeLoading?: boolean;
IAnalyticalDesignerProps.insightpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Insight to open: an identifier, a reference or the insight. Undefined opens a new insight.
insight?: string | ObjRef | IInsight;
IAnalyticalDesignerProps.onErrorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Called when Analytical Designer cannot start.
onError?: (error: unknown) => void;
IAnalyticalDesignerProps.onEventpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Called with every event Analytical Designer emits. Check event.type to narrow event.data.
onEvent?: (event: AnalyticalDesignerEvent) => void;
IAnalyticalDesignerProps.permissionspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Permissions of the current user in the workspace. Analytical Designer loads them when they are not provided.
permissions?: IWorkspacePermissions;
IAnalyticalDesignerProps.slotspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Regions of Analytical Designer that the host replaces or wraps.
slots?: IAnalyticalDesignerSlots;
IAnalyticalDesignerProps.themepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Theme to apply. Analytical Designer loads the theme of the workspace when it is not provided.
theme?: ITheme;
IAnalyticalDesignerProps.themeModifierpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Changes the theme before Analytical Designer applies it.
themeModifier?: (theme: ITheme) => ITheme;
IAnalyticalDesignerProps.workspacepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Workspace to work in. The default comes from the WorkspaceProvider. It is read at mount: to switch the workspace, remount the component with a new key.
workspace?: string;