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

# IDashboardParameter

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

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Dashboard-level parameter override entry.

**Signature:**

```typescript
export interface IDashboardParameter 
```

## Remarks

`value`, `label`, and `mode` are smart-persisted: each is omitted when equal to its default (workspace default for `value`, parameter title for `label`, `"active"` for `mode`).

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [label?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardparameter/index.md#idashboardparameterlabel) | `readonly` | string | **_(ALPHA)_** _(Optional)_ Author-renamed label; absent when equal to the parameter's title. |
| [mode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardparameter/index.md#idashboardparametermode) | `readonly` | [DashboardParameterMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.dashboardparametermode/index.md) | **_(ALPHA)_** Visibility/interactivity mode. Absent value defaults to `"active"`. |
| [parameterType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardparameter/index.md#idashboardparameterparametertype) | `readonly` | [ParameterType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.parametertype/index.md) | **_(ALPHA)_** Type tag; matches the workspace parameter definition's `type`. |
| [ref](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardparameter/index.md#idashboardparameterref) | `readonly` | [IdentifierRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifierref/index.md) | **_(ALPHA)_** Reference to the workspace parameter metadata object. |
| [value?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardparameter/index.md#idashboardparametervalue) | `readonly` | [ParameterValue](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.parametervalue/index.md) | **_(ALPHA)_** _(Optional)_ Dashboard's pinned override; absent when equal to the workspace default. |

## Property details

### IDashboardParameter.label

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Author-renamed label; absent when equal to the parameter's title.

**Signature:**

```typescript
readonly label?: string;
```

### IDashboardParameter.mode

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Visibility/interactivity mode. Absent value defaults to `"active"`.

**Signature:**

```typescript
readonly mode: DashboardParameterMode;
```

### IDashboardParameter.parameterType

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Type tag; matches the workspace parameter definition's `type`.

**Signature:**

```typescript
readonly parameterType: ParameterType;
```

### IDashboardParameter.ref

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Reference to the workspace parameter metadata object.

**Signature:**

```typescript
readonly ref: IdentifierRef;
```

### IDashboardParameter.value

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Dashboard's pinned override; absent when equal to the workspace default.

**Signature:**

```typescript
readonly value?: ParameterValue;
```