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

# IInsightViewProps

- Package: [@gooddata/sdk-ui-ext](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-ext/src/internal/interfaces/InsightView.ts
- Guides: [InsightView](https://www.gooddata.ai/docs/gooddata-ui/latest/visualisations/insightview/index.md)

**Signature:**

```typescript
export interface IInsightViewProps extends Partial<IVisualizationCallbacks> 
```
**Extends:** Partial&lt;[IVisualizationCallbacks](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ivisualizationcallbacks/index.md)&gt;

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [backend?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropsbackend) |  | [IAnalyticalBackend](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalbackend/index.md) | _(Optional)_ Backend to work with. Note: the backend must come either from this property or from BackendContext. If you do not specify backend here, then the executor MUST be rendered within an existing BackendContext. |
| [colorPalette?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropscolorpalette) |  | [IColorPalette](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icolorpalette/index.md) | _(Optional)_ Configure color palette to use for the chart. If you do not specify this, then the palette will be obtained from style settings stored on the backend. |
| [config?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropsconfig) |  | [IChartConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-charts/sdk-ui-charts.ichartconfig/index.md) \| [IGeoConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-geo/sdk-ui-geo.igeoconfig/index.md) \| [IPivotTableConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-pivot/sdk-ui-pivot.ipivottableconfig/index.md) \| [PivotTableNextConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-pivot/sdk-ui-pivot.pivottablenextconfig/index.md) \| any | _(Optional)_ When embedding insight rendered by a chart, you can specify extra options to merge with existing options saved for the insight. |
| [drillableItems?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropsdrillableitems) |  | [ExplicitDrill](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.explicitdrill/index.md)[] | _(Optional)_ Configure chart drillability; e.g. which parts of the charts can be clicked. |
| [ErrorComponent?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropserrorcomponent) |  | ComponentType&lt;[IErrorProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ierrorprops/index.md)&gt; | _(Optional)_ Component to render if embedding fails. |
| [execConfig?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropsexecconfig) |  | [IExecutionConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexecutionconfig/index.md) | _(Optional)_ execConfig will provide the execution with necessary settings before initiating execution. |
| [executeByReference?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropsexecutebyreference) |  | boolean | _(Optional)_ Indicates that the execution to obtain the data for the insight should be an 'execution by reference'. Execution by reference means that the InsightView will ask analytical backend to compute results for an insight which is stored on the backend by specifying link to the insight, additional filters and description how to organize the data. Otherwise, a freeform execution is done, in which the InsightView will send to backend the full execution definition of what to compute. This distinction is in place because some backends MAY want to prohibit users from doing freeform executions and only allow computing data for set of insights created by admins. Note: the need for execute by reference is rare. You will typically be notified by the solution admin to use this mode. |
| [filters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropsfilters) |  | [IFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifilter/index.md)[] | _(Optional)_ Additional filters to apply on top of the insight. |
| [insight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropsinsight) |  | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) \| string | Reference to the insight to render. This can be specified by either object reference using URI or using identifier. For convenience it is also possible to specify just the identifier of the insight. |
| [LoadingComponent?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropsloadingcomponent) |  | ComponentType&lt;[ILoadingProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iloadingprops/index.md)&gt; | _(Optional)_ Component to render while the insight is loading. |
| [locale?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropslocale) |  | [ILocale](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ilocale/index.md) | _(Optional)_ Locale to use for localization of texts appearing in the chart. Note: text values coming from the data itself are not localized. |
| [onInsightLoaded?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropsoninsightloaded) |  | (insight: [IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md)) =&gt; void | _(Optional)_ Called when the insight is loaded. This is to allow the embedding code to read the insight data. |
| [showTitle?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropsshowtitle) |  | boolean \| string \| ((insight: [IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md)) =&gt; string \| undefined) | _(Optional)_ In case this property is boolean it indicates that the title component will be rendered if specified in components properties. In case the property is string, this string must not be empty and will be shown as insight title. In case the property is a function, it should be implemented to take the loaded insight object and return modified title in string representation. |
| [TitleComponent?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropstitlecomponent) |  | ComponentType&lt;[IInsightTitleProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsighttitleprops/index.md)&gt; | _(Optional)_ Component to render insight title. |
| [workspace?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-ext/sdk-ui-ext.iinsightviewprops/index.md#iinsightviewpropsworkspace) |  | string | _(Optional)_ Workspace where the insight exists. Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify workspace here, then the executor MUST be rendered within an existing WorkspaceContext. |

## Property details

### IInsightViewProps.backend

Backend to work with.

Note: the backend must come either from this property or from BackendContext. If you do not specify backend here, then the executor MUST be rendered within an existing BackendContext.

**Signature:**

```typescript
backend?: IAnalyticalBackend;
```

### IInsightViewProps.colorPalette

Configure color palette to use for the chart. If you do not specify this, then the palette will be obtained from style settings stored on the backend.

**Signature:**

```typescript
colorPalette?: IColorPalette;
```

### IInsightViewProps.config

When embedding insight rendered by a chart, you can specify extra options to merge with existing options saved for the insight.

**Signature:**

```typescript
config?: IChartConfig | IGeoConfig | IPivotTableConfig | PivotTableNextConfig | any;
```

### IInsightViewProps.drillableItems

Configure chart drillability; e.g. which parts of the charts can be clicked.

**Signature:**

```typescript
drillableItems?: ExplicitDrill[];
```

### IInsightViewProps.ErrorComponent

Component to render if embedding fails.

**Signature:**

```typescript
ErrorComponent?: ComponentType<IErrorProps>;
```

### IInsightViewProps.execConfig

execConfig will provide the execution with necessary settings before initiating execution.

**Signature:**

```typescript
execConfig?: IExecutionConfig;
```

### IInsightViewProps.executeByReference

Indicates that the execution to obtain the data for the insight should be an 'execution by reference'.

Execution by reference means that the InsightView will ask analytical backend to compute results for an insight which is stored on the backend by specifying link to the insight, additional filters and description how to organize the data.

Otherwise, a freeform execution is done, in which the InsightView will send to backend the full execution definition of what to compute.

This distinction is in place because some backends MAY want to prohibit users from doing freeform executions and only allow computing data for set of insights created by admins.

Note: the need for execute by reference is rare. You will typically be notified by the solution admin to use this mode.

**Signature:**

```typescript
executeByReference?: boolean;
```

### IInsightViewProps.filters

Additional filters to apply on top of the insight.

**Signature:**

```typescript
filters?: IFilter[];
```

### IInsightViewProps.insight

Reference to the insight to render. This can be specified by either object reference using URI or using identifier.

For convenience it is also possible to specify just the identifier of the insight.

**Signature:**

```typescript
insight: ObjRef | string;
```

### IInsightViewProps.LoadingComponent

Component to render while the insight is loading.

**Signature:**

```typescript
LoadingComponent?: ComponentType<ILoadingProps>;
```

### IInsightViewProps.locale

Locale to use for localization of texts appearing in the chart.

Note: text values coming from the data itself are not localized.

**Signature:**

```typescript
locale?: ILocale;
```

### IInsightViewProps.onInsightLoaded

Called when the insight is loaded. This is to allow the embedding code to read the insight data.

**Signature:**

```typescript
onInsightLoaded?: (insight: IInsight) => void;
```

### IInsightViewProps.showTitle

In case this property is boolean it indicates that the title component will be rendered if specified in components properties. In case the property is string, this string must not be empty and will be shown as insight title. In case the property is a function, it should be implemented to take the loaded insight object and return modified title in string representation.

**Signature:**

```typescript
showTitle?: boolean | string | ((insight: IInsight) => string | undefined);
```

### IInsightViewProps.TitleComponent

Component to render insight title.

**Signature:**

```typescript
TitleComponent?: ComponentType<IInsightTitleProps>;
```

### IInsightViewProps.workspace

Workspace where the insight exists.

Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify workspace here, then the executor MUST be rendered within an existing WorkspaceContext.

**Signature:**

```typescript
workspace?: string;
```