IDashboardLoader

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

IDashboardLoader interface

Dashboard loader is responsible for loading dashboard and all the assets that the dashboard needs. As a result, it returns a React component and an instance of props to use in order to mount the dashboard.

Signature:

export interface IDashboardLoader 

Methods

Method	Description
forDashboard(dashboardRef)	Specify dashboard to load.
fromClientWorkspace(clientWorkspace)	Alternatively specify workspace indirectly, using data product, segment and client identifier.
fromWorkspace(workspace)	Specify identifier of workspace where the dashboard is stored.
load(options)	Load the dashboard, dashboard engine and plugins that should be on the dashboard.
onBackend(backend)	Specify an instance of Analytical Backend that hosts the dashboards.
withBaseProps(props)	Specify an instance of IDashboardBaseProps to use for the dashboard component.
withEmbeddedPlugins(plugins)	Specify embedded plugins to use on top of any plugins that the dashboard is already configured to use.
withFilterContext(filterContextRef)	Override filter context to use for the loaded dashboard.