IExecuteProps

IExecuteProps.backendproperty

Backend to execute against.

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.childrenproperty

Child component to which rendering is delegated.

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

Remarks

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

IExecuteProps.componentNameproperty

Informative name of the component.

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.enableExecutionCancellingproperty

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

enableExecutionCancelling?: boolean;

IExecuteProps.ErrorComponentproperty

Provide component for rendering of the error state.

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.exportTitleproperty

Name to use for files exported from this component.

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.filtersproperty

Filters to apply on server side.

filters?: NullableFiltersOrPlaceholders;

IExecuteProps.LoadingComponentproperty

Provide component for rendering of the loading state.

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.loadOnMountproperty

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

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.placeholdersResolutionContextproperty

Resolution context for composed placeholders.

placeholdersResolutionContext?: any;

IExecuteProps.seriesByproperty

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

seriesBy?: AttributesMeasuresOrPlaceholders;

IExecuteProps.slicesByproperty

Slice all data series by elements of these attributes.

slicesBy?: AttributesOrPlaceholders;

IExecuteProps.sortByproperty

Sorting to apply on server side.

sortBy?: SortsOrPlaceholders;

IExecuteProps.totalsproperty

Include these totals among the data slices.

totals?: TotalsOrPlaceholders;

IExecuteProps.windowproperty

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

window?: DataViewWindow;

Remarks

If not specified, all data will be loaded.

IExecuteProps.workspaceproperty

Workspace in whose context to perform the execution.

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.