queryWidgetAlertCount()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Creates action through which you can query dashboard component for information about the total number of alerts all the users have set on a given KPI widget.
export declare function queryWidgetAlertCount(widgetRef: ObjRef, correlationId?: string): IQueryWidgetAlertCount;
Parameters
Parameter | Type | Description |
|---|---|---|
widgetRef | reference to the KPI widget | |
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