queryWidgetFilters()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates action thought which you can query dashboard component for filters that should be used by a given widget.
export declare function queryWidgetFilters(widgetRef: ObjRef, insight?: IInsightDefinition | null, correlationId?: string): IQueryWidgetFilters;
Parameters
Parameter | Type | Description |
|---|---|---|
widgetRef | reference to insight widget | |
insight | IInsightDefinition | null | (Optional) specify insight to evaluate the filters for in context of the widget. If null, InsightWidgets will ignore the insight the are referencing. If not specified, InsightWidgets will default to the insights they reference, Custom- and KpiWidgets will ignore it. |
correlationId | string | (Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing |
Returns