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

# IChangeInsightWidgetInsightPayload

- 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/insight.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 [IChangeInsightWidgetInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangeinsightwidgetinsight/index.md) command.

**Signature:**

```typescript
export interface IChangeInsightWidgetInsightPayload 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [insightRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangeinsightwidgetinsightpayload/index.md#ichangeinsightwidgetinsightpayloadinsightref) | `readonly` | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(BETA)_** Reference to the new insight to use inside the widget. |
| [ref](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangeinsightwidgetinsightpayload/index.md#ichangeinsightwidgetinsightpayloadref) | `readonly` | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(BETA)_** Reference to Insight Widget whose insight to change. |
| [visualizationProperties?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ichangeinsightwidgetinsightpayload/index.md#ichangeinsightwidgetinsightpayloadvisualizationproperties) | `readonly` | [VisualizationProperties](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.visualizationproperties/index.md) | **_(BETA)_** _(Optional)_ Specify new visualization properties to use for the insight. If none specified, the properties already included in the widget will be used. |

## Property details

### IChangeInsightWidgetInsightPayload.insightRef

> **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 insight to use inside the widget.

**Signature:**

```typescript
readonly insightRef: ObjRef;
```

### IChangeInsightWidgetInsightPayload.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 Insight Widget whose insight to change.

**Signature:**

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

### IChangeInsightWidgetInsightPayload.visualizationProperties

> **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 new visualization properties to use for the insight. If none specified, the properties already included in the widget will be used.

**Signature:**

```typescript
readonly visualizationProperties?: VisualizationProperties;
```

#### Remarks

Note: if you don't want to use any custom visualization properties for the new insight, then pass empty object.
