IExecuteInsightProps
Home > @gooddata/sdk-ui > IExecuteInsightProps
IExecuteInsightProps interface
Props of the ExecuteInsight component.
Signature:
export interface IExecuteInsightProps extends IWithLoadingEvents<IExecuteInsightProps>
Extends: IWithLoadingEvents<IExecuteInsightProps>
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. | |
| dateFormat? | string | ((def: IExecutionDefinition, props: IExecuteInsightProps) => string) | (Optional) Modify date formatting on prepared insight execution, before it's executed. | |
| dimensions? | IDimension[] | ((def: IExecutionDefinition, props: IExecuteInsightProps) => IDimension[]) | (Optional) Modify dimensions on prepared insight execution, before it's executed. | |
| ErrorComponent? | IExecuteErrorComponent | (Optional) Provide component for rendering of the error state. | |
| executeByReference? | 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? | string | (Optional) Name to use for files exported from this component. | |
| filters? | INullableFilter[] | (Optional) Filters to apply on server side. | |
| insight | ObjRef | Reference to the insight for which you want to get the data view. | |
| 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. | |
| sorts? | ISortItem[] | ((def: IExecutionDefinition, props: IExecuteInsightProps) => ISortItem[]) | (Optional) Modify sorts on prepared insight execution, before it's executed. | |
| 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. |