IUseCustomWidgetInsightDataViewConfig
Configuration options for the useCustomWidgetInsightDataView() hook.
export interface IUseCustomWidgetInsightDataViewConfig
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (Optional) Enable or disable 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. | ||
(Optional) Insight to execute or a reference to it. | |||
Custom widget in the context of which the execution should be run. This affects which filters will be used. |
Property details
IUseCustomWidgetInsightDataViewConfig.enableExecutionCancellingproperty
Enable or disable 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.
enableExecutionCancelling?: boolean;
IUseCustomWidgetInsightDataViewConfig.insightproperty
Insight to execute or a reference to it.
insight?: IInsightDefinition | ObjRef;
Remarks
The filters will be automatically merged with the filters on the dashboard. Note: When the insight is not provided, hook is locked in a “pending” state.
IUseCustomWidgetInsightDataViewConfig.widgetproperty
Custom widget in the context of which the execution should be run. This affects which filters will be used.
widget: ICustomWidget;