DashboardLoader

Home > @gooddata/sdk-ui-loaders > DashboardLoader

DashboardLoader class

Default implementation of the IDashboardLoader interface.

Signature:

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
forDashboard		(dashboardRef: ObjRef) => this
fromClientWorkspace		(clientWorkspace: IClientWorkspaceIdentifiers) => this
fromWorkspace		(workspace: string) => this
load		(options?: IDashboardLoadOptions) => Promise<DashboardLoadResult>
onBackend		(backend: IAnalyticalBackend) => this
withBaseProps		(props: IDashboardBasePropsForLoader) => this
withEmbeddedPlugins		(...plugins: IEmbeddedPlugin[]) => this
withFilterContext		(filterContextRef: ObjRef) => this

Methods

Method	Modifiers	Description
adaptive(options)	static	Create loader that may dynamically load dashboard engine and plugins in case a Dashboard to load is using them.
staticOnly()	static	Create loader that will never do any dynamic loading and linking.