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

# IPublisherVariableDefinitionV1

- 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/publisher/v1/variables.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).
> 

A custom variable declared by document content and given a value by a document.

**Signature:**

```typescript
export interface IPublisherVariableDefinitionV1 
```

## Remarks

Referenced from text as `{name}`. Values come from [IPublisherDocumentBaseV1.variableValues](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipublisherdocumentbasev1/index.md#ipublisherdocumentbasev1variablevalues), falling back to [IPublisherVariableDefinitionV1.defaultValue](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipublishervariabledefinitionv1/index.md#ipublishervariabledefinitionv1defaultvalue).

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [defaultValue?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipublishervariabledefinitionv1/index.md#ipublishervariabledefinitionv1defaultvalue) |  | string | **_(ALPHA)_** _(Optional)_ Value used when the document does not provide one. May not contain further placeholders — there is no recursive expansion. |
| [description?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipublishervariabledefinitionv1/index.md#ipublishervariabledefinitionv1description) |  | string | **_(ALPHA)_** _(Optional)_ |
| [name](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipublishervariabledefinitionv1/index.md#ipublishervariabledefinitionv1name) |  | string | **_(ALPHA)_** Variable name as used inside the `{...}` marker. Must match /^[a-zA-Z][a-zA-Z0-9\_]\*$/. Built-in names ([PublisherBuiltInVariableV1](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.publisherbuiltinvariablev1/index.md)) are reserved. |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipublishervariabledefinitionv1/index.md#ipublishervariabledefinitionv1title) |  | string | **_(ALPHA)_** _(Optional)_ Human readable label shown in the editor. |

## Property details

### IPublisherVariableDefinitionV1.defaultValue

> **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).
> 

Value used when the document does not provide one. May not contain further placeholders — there is no recursive expansion.

**Signature:**

```typescript
defaultValue?: string;
```

### IPublisherVariableDefinitionV1.description

> **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).
> 

**Signature:**

```typescript
description?: string;
```

### IPublisherVariableDefinitionV1.name

> **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).
> 

Variable name as used inside the `{...}` marker. Must match /^[a-zA-Z][a-zA-Z0-9\_]\*$/. Built-in names ([PublisherBuiltInVariableV1](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.publisherbuiltinvariablev1/index.md)) are reserved.

**Signature:**

```typescript
name: string;
```

### IPublisherVariableDefinitionV1.title

> **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).
> 

Human readable label shown in the editor.

**Signature:**

```typescript
title?: string;
```