IRawExecuteProps

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

IRawExecuteProps.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;

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

IRawExecuteProps.executionproperty

Prepared execution which the executor will drive to completion and will obtain data from.

execution: IPreparedExecution;

IRawExecuteProps.exportTitleproperty

Name to use for files exported from this component.

exportTitle?: string;

Remarks

If you do not specify this, then the ‘RawExecute’ 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.

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

IRawExecuteProps.loadOnMountproperty

Indicates whether the executor 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.

IRawExecuteProps.windowproperty

Specifies whether RawExecute 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.