IUseExecutionDataViewConfig
Configuration for useExecutionDataView() hook. See also UseExecutionDataViewCallbacks.
export interface IUseExecutionDataViewConfig
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(Optional) Backend to work with. | |||
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 | ||
(Optional) Prepared execution, or execution configuration for which you want to get the data view. | |||
(Optional) You can define only a specific “window” of data to load. | |||
string | (Optional) Workspace where execution should be executed. |
Property details
IUseExecutionDataViewConfig.backendproperty
Backend to work with.
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.
IUseExecutionDataViewConfig.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;
IUseExecutionDataViewConfig.executionproperty
Prepared execution, or execution configuration for which you want to get the data view.
execution?: IPreparedExecution | IExecutionConfiguration;
IUseExecutionDataViewConfig.windowproperty
You can define only a specific “window” of data to load.
window?: DataViewWindow;
Remarks
This is useful if you want to page data.
IUseExecutionDataViewConfig.workspaceproperty
Workspace where execution should be executed.
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.