IQueryWidgetFilters
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
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.
export interface IQueryWidgetFilters extends IDashboardQuery
Extends: IDashboardQuery
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| { readonly widgetRef: ObjRef; readonly insight?: IInsightDefinition | null; } | (ALPHA) | |
| “GDC.DASH/QUERY.WIDGET.FILTERS” | (ALPHA) |
Property details
IQueryWidgetFilters.payloadpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
readonly payload: {
readonly widgetRef: ObjRef;
readonly insight?: IInsightDefinition | null;
};
IQueryWidgetFilters.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
readonly type: "GDC.DASH/QUERY.WIDGET.FILTERS";