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

# DashboardPluginV1

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: class
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/plugins/plugin.ts
- Guides: [Dashboard plugins](https://www.gooddata.ai/docs/gooddata-ui/latest/dashboard-plugins/dashboard-plugins/index.md), [Upgrade dashboard plugins](https://www.gooddata.ai/docs/gooddata-ui/latest/dashboard-plugins/dashboard-plugins-upgrade/index.md), [Develop your first dashboard plugin](https://www.gooddata.ai/docs/gooddata-ui/latest/dashboard-plugins/develop-your-first-plugin/index.md)

Abstract base class for the Dashboard Plugin.

**Signature:**

```typescript
export declare abstract class DashboardPluginV1 implements IDashboardPluginContract_V1 
```
**Implements:** [IDashboardPluginContract\_V1](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardplugincontract_v1/index.md)

## Remarks

Each plugin should extend this class and implement at least the [DashboardPluginV1.register()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardpluginv1/index.md#dashboardpluginv1register) method.

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [\_pluginVersion](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardpluginv1/index.md#dashboardpluginv1_pluginversion) | `readonly` | (not declared) |  |
| [author](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardpluginv1/index.md#dashboardpluginv1author) | `abstract` `readonly` | string |  |
| [compatibility](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardpluginv1/index.md#dashboardpluginv1compatibility) | `readonly` | string \| undefined |  |
| [displayName](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardpluginv1/index.md#dashboardpluginv1displayname) | `abstract` `readonly` | string |  |
| [maxEngineVersion?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardpluginv1/index.md#dashboardpluginv1maxengineversion) | `readonly` | string | _(Optional)_ |
| [minEngineVersion](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardpluginv1/index.md#dashboardpluginv1minengineversion) | `readonly` | string |  |
| [version](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardpluginv1/index.md#dashboardpluginv1version) | `abstract` `readonly` | string |  |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [register(ctx, customize, handlers)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardpluginv1/index.md#dashboardpluginv1register) | `abstract` |  |

## Property details

### DashboardPluginV1._pluginVersion

**Signature:**

```typescript
readonly _pluginVersion = "1.0";
```

### DashboardPluginV1.author

**Signature:**

```typescript
abstract readonly author: string;
```

### DashboardPluginV1.compatibility

**Signature:**

```typescript
readonly compatibility: string | undefined;
```

### DashboardPluginV1.displayName

**Signature:**

```typescript
abstract readonly displayName: string;
```

### DashboardPluginV1.maxEngineVersion

**Signature:**

```typescript
readonly maxEngineVersion?: string;
```

### DashboardPluginV1.minEngineVersion

**Signature:**

```typescript
readonly minEngineVersion: string;
```

### DashboardPluginV1.version

**Signature:**

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

## Method details

### DashboardPluginV1.register()

**Signature:**

```typescript
abstract register(ctx: DashboardContext, customize: IDashboardCustomizer, handlers: IDashboardEventHandling): void;
```

#### 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) |  |
| customize | [IDashboardCustomizer](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardcustomizer/index.md) |  |
| handlers | [IDashboardEventHandling](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardeventhandling/index.md) |  |

**Returns:**

void