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

# IExecuteProps

- 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/Execute.tsx
- Guides: [Execute](https://www.gooddata.ai/docs/gooddata-ui/latest/data-layer/execute/index.md)

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

**Signature:**

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

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [backend?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteprops/index.md#iexecutepropsbackend) |  | [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.iexecuteprops/index.md#iexecutepropschildren) |  | (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.iexecuteprops/index.md#iexecutepropscomponentname) |  | string | _(Optional)_ Informative name of the component. |
| [enableExecutionCancelling?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteprops/index.md#iexecutepropsenableexecutioncancelling) |  | 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.iexecuteprops/index.md#iexecutepropserrorcomponent) |  | [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. |
| [exportTitle?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteprops/index.md#iexecutepropsexporttitle) |  | 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.iexecuteprops/index.md#iexecutepropsfilters) |  | [NullableFiltersOrPlaceholders](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.nullablefiltersorplaceholders/index.md) | _(Optional)_ Filters to apply on server side. |
| [LoadingComponent?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteprops/index.md#iexecutepropsloadingcomponent) |  | [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.iexecuteprops/index.md#iexecutepropsloadonmount) |  | boolean | _(Optional)_ Specifies whether [Execute()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.execute/index.md) should trigger execution and loading right after it is mounted. |
| [placeholdersResolutionContext?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteprops/index.md#iexecutepropsplaceholdersresolutioncontext) |  | any | _(Optional)_ Resolution context for composed placeholders. |
| [seriesBy?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteprops/index.md#iexecutepropsseriesby) |  | [AttributesMeasuresOrPlaceholders](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.attributesmeasuresorplaceholders/index.md) | _(Optional)_ Data series will be built using the provided measures that are further scoped for elements of the specified attributes. |
| [slicesBy?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteprops/index.md#iexecutepropsslicesby) |  | [AttributesOrPlaceholders](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.attributesorplaceholders/index.md) | _(Optional)_ Slice all data series by elements of these attributes. |
| [sortBy?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteprops/index.md#iexecutepropssortby) |  | [SortsOrPlaceholders](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.sortsorplaceholders/index.md) | _(Optional)_ Sorting to apply on server side. |
| [totals?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteprops/index.md#iexecutepropstotals) |  | [TotalsOrPlaceholders](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.totalsorplaceholders/index.md) | _(Optional)_ Include these totals among the data slices. |
| [window?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iexecuteprops/index.md#iexecutepropswindow) |  | [DataViewWindow](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.dataviewwindow/index.md) | _(Optional)_ Specifies whether [Execute()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.execute/index.md) 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.iexecuteprops/index.md#iexecutepropsworkspace) |  | string | _(Optional)_ Workspace in whose context to perform the execution. |

## Property details

### IExecuteProps.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.

### IExecuteProps.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.

### IExecuteProps.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'.

### IExecuteProps.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;
```

### IExecuteProps.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.

### IExecuteProps.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.

### IExecuteProps.filters

Filters to apply on server side.

**Signature:**

```typescript
filters?: NullableFiltersOrPlaceholders;
```

### IExecuteProps.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.

### IExecuteProps.loadOnMount

Specifies whether [Execute()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.execute/index.md) 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.

### IExecuteProps.placeholdersResolutionContext

Resolution context for composed placeholders.

**Signature:**

```typescript
placeholdersResolutionContext?: any;
```

### IExecuteProps.seriesBy

Data series will be built using the provided measures that are further scoped for elements of the specified attributes.

**Signature:**

```typescript
seriesBy?: AttributesMeasuresOrPlaceholders;
```

### IExecuteProps.slicesBy

Slice all data series by elements of these attributes.

**Signature:**

```typescript
slicesBy?: AttributesOrPlaceholders;
```

### IExecuteProps.sortBy

Sorting to apply on server side.

**Signature:**

```typescript
sortBy?: SortsOrPlaceholders;
```

### IExecuteProps.totals

Include these totals among the data slices.

**Signature:**

```typescript
totals?: TotalsOrPlaceholders;
```

### IExecuteProps.window

Specifies whether [Execute()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.execute/index.md) 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.

### IExecuteProps.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.
