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

# IChangeKpiWidgetMeasurePayload

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

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Payload of the [IChangeKpiWidgetMeasure](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangekpiwidgetmeasure/index.md) command.

**Signature:**

```typescript
export interface IChangeKpiWidgetMeasurePayload 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [header?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangekpiwidgetmeasurepayload/index.md#ichangekpiwidgetmeasurepayloadheader) | `readonly` | [IWidgetHeader](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iwidgetheader/index.md) \| "from-measure" | **_(BETA)_** _(Optional)_ Specify the new header that should be used for the KPI widget with the changed measure. |
| [measureRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangekpiwidgetmeasurepayload/index.md#ichangekpiwidgetmeasurepayloadmeasureref) | `readonly` | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(BETA)_** Reference to the new measure to use instead of the old measure. |
| [ref](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangekpiwidgetmeasurepayload/index.md#ichangekpiwidgetmeasurepayloadref) | `readonly` | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(BETA)_** KPI Widget reference whose measure to change. |

## Property details

### IChangeKpiWidgetMeasurePayload.header

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Specify the new header that should be used for the KPI widget with the changed measure.

**Signature:**

```typescript
readonly header?: IWidgetHeader | "from-measure";
```

#### Remarks

You may specify the widget header as 'from-measure'. In that case the title will be automatically set to the title of measure specified in the `measureRef` property.

### IChangeKpiWidgetMeasurePayload.measureRef

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Reference to the new measure to use instead of the old measure.

**Signature:**

```typescript
readonly measureRef: ObjRef;
```

### IChangeKpiWidgetMeasurePayload.ref

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

KPI Widget reference whose measure to change.

**Signature:**

```typescript
readonly ref: ObjRef;
```