IDashboardLoadOptions

IDashboardLoadOptions.adaptiveLoadOptionsproperty

Specify configuration related adaptive loading.

adaptiveLoadOptions?: AdaptiveLoadOptions;

Remarks

If loadingMode is not set to “staticOnly”, this is mandatory.

IDashboardLoadOptions.adhocItemsproperty

List of ad-hoc items to render in the dashboard. These items are not part of the dashboard definition and are not persisted, it will be rendered into empty layout.

adhocItems?: DashboardItem[];

IDashboardLoadOptions.allowUnfinishedFeaturesproperty

Specify when will be in progress features allowed

allowUnfinishedFeatures?: "staticOnly" | "alwaysAllow" | "alwaysPrevent";

Remarks

staticOnly in progress features allowed only when there is no external plugin loaded alwaysAllow in progress features always allowed alwaysPrevent in progress features always prevented

Default allowUnfinishedFeatures is alwaysPrevent.

IDashboardLoadOptions.clientWorkspaceproperty

Specify client workspace identifiers to use in order to identify exact workspace to load the dashboard from.

clientWorkspace?: IClientWorkspaceIdentifiers;

Remarks

Client workspace identifiers were only supported by the Lifecycle Management feature of the retired legacy platform; current backends do not support them.

If you specify the client workspace then it has preference over all other means that can be used to specify the workspace; more specifically the workspace prop on this object and workspace that may be defined by the context will be ignored.

IDashboardLoadOptions.extraPluginsproperty

Specify extra plugins to use during the bootstrap of the dashboard.

extraPlugins?: IEmbeddedPlugin | IEmbeddedPlugin[];

Remarks

Code for these extra plugins must be available at compile time.

IDashboardLoadOptions.loadingModeproperty

Loading mode to use.

loadingMode?: DashboardLoadingMode;

Remarks

staticOnly mode

The loader expects that it is running inside an application that depends on the @gooddata/sdk-ui-dashboard package. Furthermore the loader will initialize dashboard with only those plugins that are part of the application and passed via extraPlugins property. Plugins that are linked with the dashboard will be ignored.

This mode is suitable during plugin development

adaptive mode

In this mode, loader will first inspect the dashboard and then act based on the dashboard setup:

• If the dashboard stored on the analytical backend is configured to use some plugins, the loader will dynamically load the dashboard engine required by those plugins and then dynamically load the plugins. It will then initialize the dashboard engine with the loaded plugins and any plugins that are passed via the extraPlugins property.

• If the dashboard is not configured to use any plugins, the loader will fall back to staticOnly behavior.

Default loadingMode is adaptive.