IExecuteProps
Home > @gooddata/sdk-ui > IExecuteProps
IExecuteProps interface
Props of the Execute component.
Signature:
export interface IExecuteProps extends IWithLoadingEvents<IExecuteProps>
Extends: IWithLoadingEvents<IExecuteProps>
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| backend? | IAnalyticalBackend | (Optional) Backend to execute against. | |
| children | (executionResult: WithLoadingResult) => React.ReactElement | null | Child component to which rendering is delegated. | |
| componentName? | string | (Optional) Informative name of the component. | |
| enableExecutionCancelling? | 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? | IExecuteErrorComponent | (Optional) Provide component for rendering of the error state. | |
| exportTitle? | string | (Optional) Name to use for files exported from this component. | |
| filters? | NullableFiltersOrPlaceholders | (Optional) Filters to apply on server side. | |
| LoadingComponent? | IExecuteLoadingComponent | (Optional) Provide component for rendering of the loading state. | |
| loadOnMount? | boolean | (Optional) Specifies whether Execute should trigger execution and loading right after it is mounted. | |
| placeholdersResolutionContext? | any | (Optional) Resolution context for composed placeholders. | |
| seriesBy? | AttributesMeasuresOrPlaceholders | (Optional) Data series will be built using the provided measures that are further scoped for elements of the specified attributes. | |
| slicesBy? | AttributesOrPlaceholders | (Optional) Slice all data series by elements of these attributes. | |
| sortBy? | SortsOrPlaceholders | (Optional) Sorting to apply on server side. | |
| totals? | TotalsOrPlaceholders | (Optional) Include these totals among the data slices. | |
| window? | DataViewWindow | (Optional) Specifies whether Execute should load all data from backend or just a particular window - specified by offset and size of the window. | |
| workspace? | string | (Optional) Workspace in whose context to perform the execution. |