IUseCustomWidgetExecutionDataViewConfig · GoodData.UI API reference

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

IUseCustomWidgetExecutionDataViewConfig interface

Configuration options for the useCustomWidgetExecutionDataView() hook.

Signature:

export interface IUseCustomWidgetExecutionDataViewConfig

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.
execution?	Exclude<IExecutionConfiguration, "filters">	(Optional) Definition of the execution to execute (without filters). The filters will be filled automatically.
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.

execution?

Exclude<IExecutionConfiguration, "filters">

(Optional) Definition of the execution to execute (without filters). The filters will be filled automatically.

widget

ICustomWidget

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