QueryWidgetFilters

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

QueryWidgetFilters interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Given a reference to a widget, this query will obtain the filters that should be used when executing it. These will respect the ignored filters on widget level as well as the filters specified in the insight itself. Filters returned by this query should be used with insightSetFilters() to obtain insight that is ready for execution or used to execute a KPI.

Signature:

export interface QueryWidgetFilters extends IDashboardQuery 

Extends: IDashboardQuery

Properties

Property	Modifiers	Type	Description
payload	readonly	{ readonly widgetRef: ObjRef; readonly insight?: IInsightDefinition | null; }	(ALPHA)
type	readonly	"GDC.DASH/QUERY.WIDGET.FILTERS"	(ALPHA)