IUseInsightDataViewConfig

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

IUseInsightDataViewConfig.dateFormatproperty

Modify date formatting on prepared insight execution, before it’s executed.

dateFormat?: string | ((def: IExecutionDefinition) => string);

IUseInsightDataViewConfig.dimensionsproperty

Modify dimensions on prepared insight execution, before it’s executed.

dimensions?: IDimension[] | ((def: IExecutionDefinition) => IDimension[]);

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

IUseInsightDataViewConfig.executeByReferenceproperty

Indicates that the execution to obtain the data for the insight should be an ’execution by reference'.

Execution by reference means that the useInsightDataView 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.

executeByReference?: boolean;

IUseInsightDataViewConfig.filtersproperty

Specify filters to merge with filters already defined in the insight.

filters?: INullableFilter[];

IUseInsightDataViewConfig.insightproperty

Reference to the insight for which you want to get the data view.

insight?: ObjRef;

Remarks

Note: When the reference or identifier is not provided, hook is locked in a “pending” state.

IUseInsightDataViewConfig.sortsproperty

Modify sorts on prepared insight execution, before it’s executed.

sorts?: ISortItem[] | ((def: IExecutionDefinition) => ISortItem[]);

IUseInsightDataViewConfig.windowproperty

You can define only a specific “window” of data to load.

window?: DataViewWindow;

Remarks

This is useful if you want to page data.

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