IAlertDataContextValue
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The data the alerting dialog loads asynchronously: the supported measures and attributes with their formats, the execution-result readers, and the current user’s default recipients.
Changes when an async load resolves, not per keystroke.
export interface IAlertDataContextValue
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) The recipient a new alert is seeded with; an external-recipient override replaces the user. | |||
(BETA) The logged-in user as a recipient. | |||
(attribute: IAttribute) => AttributeValue[] | (BETA) Distinct values of an insight attribute in the widget’s execution result, by its display form. | ||
(measure?: IMeasure, attribute?: IAttribute, value?: string | null) => number | undefined | (BETA) The measure’s current value, optionally sliced by an attribute value; undefined while loading. | ||
boolean | (BETA) Whether the widget’s execution result is still loading. | ||
(BETA) Number formats of the insight’s measures, by local identifier. | |||
(BETA) Attributes of the insight an alert can be sliced by. | |||
(BETA) Measures of the insight an alert can be built on, with their comparisons. |
Property details
IAlertDataContextValue.defaultRecipientpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The recipient a new alert is seeded with; an external-recipient override replaces the user.
defaultRecipient: IAutomationRecipient;
IAlertDataContextValue.defaultUserpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The logged-in user as a recipient.
defaultUser: IAutomationRecipient;
IAlertDataContextValue.getAttributeValuespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Distinct values of an insight attribute in the widget’s execution result, by its display form.
getAttributeValues: (attribute: IAttribute) => AttributeValue[];
IAlertDataContextValue.getMetricValuepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The measure’s current value, optionally sliced by an attribute value; undefined while loading.
getMetricValue: (measure?: IMeasure, attribute?: IAttribute, value?: string | null) => number | undefined;
IAlertDataContextValue.isResultLoadingpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Whether the widget’s execution result is still loading.
isResultLoading: boolean;
IAlertDataContextValue.measureFormatMappropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Number formats of the insight’s measures, by local identifier.
measureFormatMap: IMeasureFormatMap;
IAlertDataContextValue.supportedAttributespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Attributes of the insight an alert can be sliced by.
supportedAttributes: AlertAttribute[];
IAlertDataContextValue.supportedMeasurespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Measures of the insight an alert can be built on, with their comparisons.
supportedMeasures: AlertMetric[];