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

# IDashboardKpiWidgetMeasureChangedPayload

- 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/events/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 [IDashboardKpiWidgetMeasureChanged](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardkpiwidgetmeasurechanged/index.md) event.

**Signature:**

```typescript
export interface IDashboardKpiWidgetMeasureChangedPayload 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [header?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardkpiwidgetmeasurechangedpayload/index.md#idashboardkpiwidgetmeasurechangedpayloadheader) | `readonly` | [IWidgetHeader](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iwidgetheader/index.md) | **_(BETA)_** _(Optional)_ If a new header was also set while changing the measure, then the new header value is included here. |
| [kpiWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardkpiwidgetmeasurechangedpayload/index.md#idashboardkpiwidgetmeasurechangedpayloadkpiwidget) | `readonly` | [IKpiWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ikpiwidget/index.md) | **_(BETA)_** New setup of KPI. Includes the measure used to calculate KPI and the comparison settings that are in effect. Note: the comparison may be 'none' - meaning |
| [measure](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardkpiwidgetmeasurechangedpayload/index.md#idashboardkpiwidgetmeasurechangedpayloadmeasure) | `readonly` | [IMeasureMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.imeasuremetadataobject/index.md) | **_(BETA)_** Metadata object describing the measure that is now used on the KPI. |
| [ref](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardkpiwidgetmeasurechangedpayload/index.md#idashboardkpiwidgetmeasurechangedpayloadref) | `readonly` | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(BETA)_** Reference to changed KPI Widget. |

## Property details

### IDashboardKpiWidgetMeasureChangedPayload.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).
> 

If a new header was also set while changing the measure, then the new header value is included here.

**Signature:**

```typescript
readonly header?: IWidgetHeader;
```

### IDashboardKpiWidgetMeasureChangedPayload.kpiWidget

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

New setup of KPI. Includes the measure used to calculate KPI and the comparison settings that are in effect.

Note: the comparison may be 'none' - meaning

**Signature:**

```typescript
readonly kpiWidget: IKpiWidget;
```

### IDashboardKpiWidgetMeasureChangedPayload.measure

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

Metadata object describing the measure that is now used on the KPI.

**Signature:**

```typescript
readonly measure: IMeasureMetadataObject;
```

### IDashboardKpiWidgetMeasureChangedPayload.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).
> 

Reference to changed KPI Widget.

**Signature:**

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