IAlertingDialogComparisonPeriodProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Props of the default alerting dialog’s comparison-period field (the “Compared to” row).
export interface IAlertingDialogComparisonPeriodProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
IAutomationMetadataObjectDefinition | undefined | (BETA) The alert draft; the select renders nothing unless its condition is a change or difference. | ||
boolean | (BETA) (Optional) Closes the dropdown when an ancestor scrolls; the default dialog sets it. | ||
string | (BETA) Id of the dropdown button; the form row’s label points at it. | ||
AlertMetric | undefined | (BETA) The measure the condition targets, whose comparators are the options; with a single comparator the select renders it as static text. | ||
(comparison: AlertMetricComparatorType, granularity?: DateAttributeGranularity) => void | (BETA) Called with the picked comparison and its granularity. | ||
OverlayPositionType | (BETA) (Optional) Positioning of the dropdown overlay; the default dialog uses | ||
(BETA) (Optional) The selected period comparison. | |||
(BETA) (Optional) The selected granularity of the period shift. |
Property details
IAlertingDialogComparisonPeriodProps.alertpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The alert draft; the select renders nothing unless its condition is a change or difference.
alert: IAutomationMetadataObjectDefinition | undefined;
IAlertingDialogComparisonPeriodProps.closeOnParentScrollpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Closes the dropdown when an ancestor scrolls; the default dialog sets it.
closeOnParentScroll?: boolean;
IAlertingDialogComparisonPeriodProps.idpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Id of the dropdown button; the form row’s label points at it.
id: string;
IAlertingDialogComparisonPeriodProps.measurepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The measure the condition targets, whose comparators are the options; with a single comparator the select renders it as static text.
measure: AlertMetric | undefined;
IAlertingDialogComparisonPeriodProps.onComparisonChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Called with the picked comparison and its granularity.
onComparisonChange: (comparison: AlertMetricComparatorType, granularity?: DateAttributeGranularity) => void;
IAlertingDialogComparisonPeriodProps.overlayPositionTypepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Positioning of the dropdown overlay; the default dialog uses "sameAsTarget".
overlayPositionType?: OverlayPositionType;
IAlertingDialogComparisonPeriodProps.selectedComparisonpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The selected period comparison.
selectedComparison?: AlertMetricComparatorType;
IAlertingDialogComparisonPeriodProps.selectedGranularitypropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The selected granularity of the period shift.
selectedGranularity?: DateAttributeGranularity;