IUseCustomWidgetInsightDataViewConfig · GoodData.UI API reference

Home > @gooddata/sdk-ui-dashboard > IUseCustomWidgetInsightDataViewConfig

IUseCustomWidgetInsightDataViewConfig interface

Configuration options for the useCustomWidgetInsightDataView() hook.

Signature:

export interface IUseCustomWidgetInsightDataViewConfig

Properties

Property	Type	Description
enableExecutionCancelling?	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.
insight?	IInsightDefinition \| ObjRef	(Optional) Insight to execute or a reference to it.
widget	ICustomWidget	Custom widget in the context of which the execution should be run. This affects which filters will be used.

Property

Modifiers

Type

Description

enableExecutionCancelling?

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.

insight?

IInsightDefinition | ObjRef

(Optional) Insight to execute or a reference to it.

widget

ICustomWidget

Custom widget in the context of which the execution should be run. This affects which filters will be used.