DashboardLoader
Default implementation of the IDashboardLoader interface.
export declare class DashboardLoader implements IDashboardLoader
Implements: IDashboardLoader
Remarks
This class implements all the necessary functionality related to either static or dynamic dashboard loading.
Note: you typically do not have to use this class directly and instead use the useDashboardLoader hook or the DashboardStub component.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(dashboardRef: ObjRef) => this | |||
(clientWorkspace: IClientWorkspaceIdentifiers) => this | |||
(workspace: string) => this | |||
(options?: IDashboardLoadOptions) => Promise<DashboardLoadResult> | |||
(backend: IAnalyticalBackend) => this | |||
(props: IDashboardBasePropsForLoader) => this | |||
(…plugins: IEmbeddedPlugin[]) => this | |||
(filterContextRef: ObjRef) => this |
Methods
Method | Modifiers | Description |
|---|---|---|
| Create loader that may dynamically load dashboard engine and plugins in case a Dashboard to load is using them. | |
| Create loader that will never do any dynamic loading and linking. |
Property details
DashboardLoader.forDashboardproperty
forDashboard: (dashboardRef: ObjRef) => this;
DashboardLoader.fromClientWorkspaceproperty
fromClientWorkspace: (clientWorkspace: IClientWorkspaceIdentifiers) => this;
DashboardLoader.fromWorkspaceproperty
fromWorkspace: (workspace: string) => this;
DashboardLoader.loadproperty
load: (options?: IDashboardLoadOptions) => Promise<DashboardLoadResult>;
DashboardLoader.onBackendproperty
onBackend: (backend: IAnalyticalBackend) => this;
DashboardLoader.withBasePropsproperty
withBaseProps: (props: IDashboardBasePropsForLoader) => this;
DashboardLoader.withEmbeddedPluginsproperty
withEmbeddedPlugins: (...plugins: IEmbeddedPlugin[]) => this;
DashboardLoader.withFilterContextproperty
withFilterContext: (filterContextRef: ObjRef) => this;
Method details
DashboardLoader.adaptive()method
Create loader that may dynamically load dashboard engine and plugins in case a Dashboard to load is using them.
static adaptive(options: AdaptiveLoadOptions): DashboardLoader;
Parameters
Parameter | Type | Description |
|---|---|---|
options | options for the adaptive load |
Returns
Remarks
Otherwise it will fall back to the dashboard engine statically linked to the context and will only use locally embedded plugins.
DashboardLoader.staticOnly()method
Create loader that will never do any dynamic loading and linking.
static staticOnly(): DashboardLoader;
Returns
Remarks
The loader will expect that the dashboard engine is statically linked in the context. Any plugins that require dynamic loading from remote locations will be ignored. Only locally embedded plugins will be used.