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

# IExecuteInsightProps

- Package: [@gooddata/sdk-ui](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui/src/execution/ExecuteInsight.tsx
- Guides: [ExecuteInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/data-layer/execute-insight/index.md)

Props of the [ExecuteInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.executeinsight/index.md) component.

**Signature:**

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

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [backend?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropsbackend) |  | [IAnalyticalBackend](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalbackend/index.md) | _(Optional)_ Backend to execute against. |
| [children](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropschildren) |  | (executionResult: [WithLoadingResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.withloadingresult/index.md)) =&gt; ReactElement \| null | Child component to which rendering is delegated. |
| [componentName?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropscomponentname) |  | string | _(Optional)_ Informative name of the component. |
| [dateFormat?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropsdateformat) |  | string \| ((def: [IExecutionDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexecutiondefinition/index.md), props: [IExecuteInsightProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md)) =&gt; string) | _(Optional)_ Modify date formatting on prepared insight execution, before it's executed. |
| [dimensions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropsdimensions) |  | [IDimension](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idimension/index.md)[] \| ((def: [IExecutionDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexecutiondefinition/index.md), props: [IExecuteInsightProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md)) =&gt; [IDimension](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idimension/index.md)[]) | _(Optional)_ Modify dimensions on prepared insight execution, before it's executed. |
| [enableExecutionCancelling?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropsenableexecutioncancelling) |  | boolean | _(Optional)_ Optionally enable real execution cancellation. This means that if the execution request is not yet finished and the execution changes, the request will be cancelled and the new execution will be started. Default: false |
| [ErrorComponent?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropserrorcomponent) |  | [IExecuteErrorComponent](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteerrorcomponent/index.md) | _(Optional)_ Provide component for rendering of the error state. |
| [executeByReference?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropsexecutebyreference) |  | 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 ExecuteInsight 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. |
| [exportTitle?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropsexporttitle) |  | string | _(Optional)_ Name to use for files exported from this component. |
| [filters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropsfilters) |  | [INullableFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inullablefilter/index.md)[] | _(Optional)_ Filters to apply on server side. |
| [insight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropsinsight) |  | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | Reference to the insight for which you want to get the data view. |
| [LoadingComponent?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropsloadingcomponent) |  | [IExecuteLoadingComponent](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteloadingcomponent/index.md) | _(Optional)_ Provide component for rendering of the loading state. |
| [loadOnMount?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropsloadonmount) |  | boolean | _(Optional)_ Specifies whether `Execute` should trigger execution and loading right after it is mounted. |
| [sorts?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropssorts) |  | [ISortItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.isortitem/index.md)[] \| ((def: [IExecutionDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexecutiondefinition/index.md), props: [IExecuteInsightProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md)) =&gt; [ISortItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.isortitem/index.md)[]) | _(Optional)_ Modify sorts on prepared insight execution, before it's executed. |
| [window?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropswindow) |  | [DataViewWindow](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.dataviewwindow/index.md) | _(Optional)_ Specifies whether `Execute` should load all data from backend or just a particular window - specified by offset and size of the window. |
| [workspace?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteinsightprops/index.md#iexecuteinsightpropsworkspace) |  | string | _(Optional)_ Workspace in whose context to perform the execution. |

## Property details

### IExecuteInsightProps.backend

Backend to execute against.

**Signature:**

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

#### Remarks

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.

### IExecuteInsightProps.children

Child component to which rendering is delegated.

**Signature:**

```typescript
children: (executionResult: WithLoadingResult) => ReactElement | null;
```

#### Remarks

This is a function that will be called every time state of execution and data loading changes.

### IExecuteInsightProps.componentName

Informative name of the component.

**Signature:**

```typescript
componentName?: string;
```

#### Remarks

This value is sent as telemetry information together with the actual execution request. We recommend to set this because it can be useful for diagnostic purposes.

Defaults 'Execute'.

### IExecuteInsightProps.dateFormat

Modify date formatting on prepared insight execution, before it's executed.

**Signature:**

```typescript
dateFormat?: string | ((def: IExecutionDefinition, props: IExecuteInsightProps) => string);
```

### IExecuteInsightProps.dimensions

Modify dimensions on prepared insight execution, before it's executed.

**Signature:**

```typescript
dimensions?: IDimension[] | ((def: IExecutionDefinition, props: IExecuteInsightProps) => IDimension[]);
```

### IExecuteInsightProps.enableExecutionCancelling

Optionally enable real execution cancellation.

This means that if the execution request is not yet finished and the execution changes, the request will be cancelled and the new execution will be started.

Default: false

**Signature:**

```typescript
enableExecutionCancelling?: boolean;
```

### IExecuteInsightProps.ErrorComponent

Provide component for rendering of the error state.

**Signature:**

```typescript
ErrorComponent?: IExecuteErrorComponent;
```

#### Remarks

Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result will be called only with a successful result.

### IExecuteInsightProps.executeByReference

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

Execution by reference means that the ExecuteInsight 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;
```

### IExecuteInsightProps.exportTitle

Name to use for files exported from this component.

**Signature:**

```typescript
exportTitle?: string;
```

#### Remarks

If you do not specify this, then the componentName will be used instead.

Note: it is also possible to pass custom name to the export function that will be sent via the onExportReady callback. That approach is preferred if you need to assign the names in an ad-hoc fashion.

### IExecuteInsightProps.filters

Filters to apply on server side.

**Signature:**

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

### IExecuteInsightProps.insight

Reference to the insight for which you want to get the data view.

**Signature:**

```typescript
insight: ObjRef;
```

### IExecuteInsightProps.LoadingComponent

Provide component for rendering of the loading state.

**Signature:**

```typescript
LoadingComponent?: IExecuteLoadingComponent;
```

#### Remarks

Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result will be called only with a successful result.

### IExecuteInsightProps.loadOnMount

Specifies whether `Execute` should trigger execution and loading right after it is mounted.

**Signature:**

```typescript
loadOnMount?: boolean;
```

#### Remarks

If not specified defaults to `true`.

If set to `false`, then the  function needs to be called to trigger the execution and loading.

### IExecuteInsightProps.sorts

Modify sorts on prepared insight execution, before it's executed.

**Signature:**

```typescript
sorts?: ISortItem[] | ((def: IExecutionDefinition, props: IExecuteInsightProps) => ISortItem[]);
```

### IExecuteInsightProps.window

Specifies whether `Execute` should load all data from backend or just a particular window - specified by offset and size of the window.

**Signature:**

```typescript
window?: DataViewWindow;
```

#### Remarks

If not specified, all data will be loaded.

### IExecuteInsightProps.workspace

Workspace in whose context to perform the execution.

**Signature:**

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

#### Remarks

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.