> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IDashboardLoadOptions

- Package: [@gooddata/sdk-ui-loaders](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-loaders/src/dashboard/types.ts
- Guides: [Embed a dashboard with plugins](https://www.gooddata.ai/docs/gooddata-ui/latest/dashboard-plugins/embed-dashboard-with-plugins/index.md)

Dashboard loading options.

**Signature:**

```typescript
export interface IDashboardLoadOptions extends IDashboardBasePropsForLoader 
```
**Extends:** [IDashboardBasePropsForLoader](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.idashboardbasepropsforloader/index.md)

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [adaptiveLoadOptions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.idashboardloadoptions/index.md#idashboardloadoptionsadaptiveloadoptions) |  | [AdaptiveLoadOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.adaptiveloadoptions/index.md) | _(Optional)_ Specify configuration related adaptive loading. |
| [adhocItems?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.idashboardloadoptions/index.md#idashboardloadoptionsadhocitems) |  | [DashboardItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboarditem/index.md)[] | _(Optional)_ 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. |
| [allowUnfinishedFeatures?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.idashboardloadoptions/index.md#idashboardloadoptionsallowunfinishedfeatures) |  | "staticOnly" \| "alwaysAllow" \| "alwaysPrevent" | _(Optional)_ Specify when will be in progress features allowed |
| [clientWorkspace?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.idashboardloadoptions/index.md#idashboardloadoptionsclientworkspace) |  | [IClientWorkspaceIdentifiers](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iclientworkspaceidentifiers/index.md) | _(Optional)_ Specify client workspace identifiers to use in order to identify exact workspace to load the dashboard from. |
| [extraPlugins?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.idashboardloadoptions/index.md#idashboardloadoptionsextraplugins) |  | [IEmbeddedPlugin](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.iembeddedplugin/index.md) \| [IEmbeddedPlugin](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.iembeddedplugin/index.md)[] | _(Optional)_ Specify extra plugins to use during the bootstrap of the dashboard. |
| [loadingMode?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.idashboardloadoptions/index.md#idashboardloadoptionsloadingmode) |  | [DashboardLoadingMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.dashboardloadingmode/index.md) | _(Optional)_ Loading mode to use. |

## Property details

### IDashboardLoadOptions.adaptiveLoadOptions

Specify configuration related adaptive loading.

**Signature:**

```typescript
adaptiveLoadOptions?: AdaptiveLoadOptions;
```

#### Remarks

If loadingMode is not set to "staticOnly", this is mandatory.

### IDashboardLoadOptions.adhocItems

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.

**Signature:**

```typescript
adhocItems?: DashboardItem[];
```

### IDashboardLoadOptions.allowUnfinishedFeatures

Specify when will be in progress features allowed

**Signature:**

```typescript
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.clientWorkspace

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

**Signature:**

```typescript
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.extraPlugins

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

**Signature:**

```typescript
extraPlugins?: IEmbeddedPlugin | IEmbeddedPlugin[];
```

#### Remarks

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

### IDashboardLoadOptions.loadingMode

Loading mode to use.

**Signature:**

```typescript
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`.