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

# IDashboardEngine

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

Dashboard Engine encapsulates a particular build of the [Dashboard()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboard/index.md) component and provides factory methods to create the Dashboard component's customization-related props using one or more plugins.

**Signature:**

```typescript
export interface IDashboardEngine 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [version](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardengine/index.md#idashboardengineversion) | `readonly` | string | Version of the dashboard engine. |

## Methods

| Method | Description |
| --- | --- |
| [getDashboardComponent()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardengine/index.md#idashboardenginegetdashboardcomponent) | Returns Dashboard component provided by this dashboard engine. |
| [initializePlugins(ctx, plugins)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardengine/index.md#idashboardengineinitializeplugins) | Drives initialization of loaded dashboard plugins and their registration logic. |

## Property details

### IDashboardEngine.version

Version of the dashboard engine.

**Signature:**

```typescript
readonly version: string;
```

## Method details

### IDashboardEngine.getDashboardComponent()

Returns Dashboard component provided by this dashboard engine.

**Signature:**

```typescript
getDashboardComponent(): ComponentType<IDashboardProps>;
```
**Returns:**

ComponentType&lt;[IDashboardProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardprops/index.md)&gt;

### IDashboardEngine.initializePlugins()

Drives initialization of loaded dashboard plugins and their registration logic.

**Signature:**

```typescript
initializePlugins(ctx: DashboardContext, plugins: IDashboardPluginContract_V1[]): IDashboardExtensionProps;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ctx | [DashboardContext](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardcontext/index.md) | dashboard context in which the plugins operate |
| plugins | [IDashboardPluginContract\_V1](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardplugincontract_v1/index.md)[] | plugins to initialize |

**Returns:**

[IDashboardExtensionProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardextensionprops/index.md)

#### Remarks

During registration, the plugins register their customizations, contributions and event handlers.

The plugin' contributions will be used to construct the dashboard extension props which can then be used as input to the dashboard component itself and thus achieve the integration of the plugins into the dashboard.