IAlertingDialogComparisonOperatorProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Props of the default alerting dialog’s comparison-operator field (the “Condition” row).
export interface IAlertingDialogComparisonOperatorProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (BETA) (Optional) Closes the dropdown when an ancestor scrolls; the default dialog sets it. | ||
boolean | (BETA) Offers the anomaly-detection operators. The default dialog passes the conjunction of the | ||
string | (BETA) Id of the dropdown button; the form row’s label points at it. | ||
AlertMetric | undefined | (BETA) The measure the condition targets; the select renders nothing without one. | ||
(measure: AlertMetric) => void | (BETA) Called when the anomaly-detection operator is picked. | ||
(measure: AlertMetric, comparisonOperator: IAlertComparisonOperator) => void | (BETA) Called when a fixed-threshold operator is picked. | ||
(measure: AlertMetric, relativeOperator: IAlertRelativeOperator, arithmeticOperator: IAlertRelativeArithmeticOperator) => void | (BETA) Called when a relative (change / difference) operator is picked. | ||
OverlayPositionType | (BETA) (Optional) Positioning of the dropdown overlay; the default dialog uses | ||
AlertAiOperator | undefined | (BETA) The operator id of an anomaly-detection condition, when that is the condition type. | ||
IAlertComparisonOperator | undefined | (BETA) The operator of a fixed-threshold condition, when that is the condition type. | ||
[IAlertRelativeOperator, IAlertRelativeArithmeticOperator] | undefined | (BETA) The relative and arithmetic operators of a relative condition, when that is the condition type. |
Property details
IAlertingDialogComparisonOperatorProps.closeOnParentScrollpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Closes the dropdown when an ancestor scrolls; the default dialog sets it.
closeOnParentScroll?: boolean;
IAlertingDialogComparisonOperatorProps.enableAnomalyDetectionAlertpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Offers the anomaly-detection operators. The default dialog passes the conjunction of the enableAnomalyDetectionAlert and canUseAiAssistant features; pass false to hide those options.
enableAnomalyDetectionAlert: boolean;
IAlertingDialogComparisonOperatorProps.idpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Id of the dropdown button; the form row’s label points at it.
id: string;
IAlertingDialogComparisonOperatorProps.measurepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The measure the condition targets; the select renders nothing without one.
measure: AlertMetric | undefined;
IAlertingDialogComparisonOperatorProps.onAnomalyDetectionChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called when the anomaly-detection operator is picked.
onAnomalyDetectionChange: (measure: AlertMetric) => void;
IAlertingDialogComparisonOperatorProps.onComparisonOperatorChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called when a fixed-threshold operator is picked.
onComparisonOperatorChange: (measure: AlertMetric, comparisonOperator: IAlertComparisonOperator) => void;
IAlertingDialogComparisonOperatorProps.onRelativeOperatorChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called when a relative (change / difference) operator is picked.
onRelativeOperatorChange: (measure: AlertMetric, relativeOperator: IAlertRelativeOperator, arithmeticOperator: IAlertRelativeArithmeticOperator) => void;
IAlertingDialogComparisonOperatorProps.overlayPositionTypepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Positioning of the dropdown overlay; the default dialog uses "sameAsTarget".
overlayPositionType?: OverlayPositionType;
IAlertingDialogComparisonOperatorProps.selectedAiOperatorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The operator id of an anomaly-detection condition, when that is the condition type.
selectedAiOperator: AlertAiOperator | undefined;
IAlertingDialogComparisonOperatorProps.selectedComparisonOperatorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The operator of a fixed-threshold condition, when that is the condition type.
selectedComparisonOperator: IAlertComparisonOperator | undefined;
IAlertingDialogComparisonOperatorProps.selectedRelativeOperatorpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The relative and arithmetic operators of a relative condition, when that is the condition type.
selectedRelativeOperator: [IAlertRelativeOperator, IAlertRelativeArithmeticOperator] | undefined;