@gooddata/sdk-ui-dashboard 11.55.0-alpha.1 → 11.55.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/NOTICE +26793 -68204
- package/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/index.d.ts +23 -3
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +20 -0
- package/esm/model/commandHandlers/dashboard/initializeDashboardHandler/index.js +1 -1
- package/esm/model/store/config/configSelectors.js +1 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialog.d.ts +10 -3
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialog.d.ts.map +1 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialog.js +24 -59
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogAttribute.d.ts +13 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogAttribute.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/{components/AlertAttributeSelect.js → DefaultAlertingDialogAttribute.js} +12 -3
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogComparisonOperator.d.ts +13 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogComparisonOperator.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/{components/AlertComparisonOperatorSelect.js → DefaultAlertingDialogComparisonOperator.js} +13 -4
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogComparisonPeriod.d.ts +14 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogComparisonPeriod.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/{components/AlertComparisonPeriodSelect.js → DefaultAlertingDialogComparisonPeriod.js} +16 -6
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogDestination.d.ts.map +1 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogDestination.js +2 -2
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogGranularity.d.ts +12 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogGranularity.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/{components/AlertGranularitySelect.js → DefaultAlertingDialogGranularity.js} +10 -2
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogMeasure.d.ts +12 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogMeasure.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/{components/AlertMeasureSelect.js → DefaultAlertingDialogMeasure.js} +11 -3
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogRecipients.d.ts.map +1 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogRecipients.js +2 -2
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogSensitivity.d.ts +12 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogSensitivity.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/{components/AlertSensitivitySelect.js → DefaultAlertingDialogSensitivity.js} +10 -2
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogThreshold.d.ts +12 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogThreshold.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/{components/AlertThresholdInput.js → DefaultAlertingDialogThreshold.js} +9 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogTriggerInterval.d.ts +13 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogTriggerInterval.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/{components/AlertTriggerIntervalSelect.js → DefaultAlertingDialogTriggerInterval.js} +11 -2
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogTriggerMode.d.ts +12 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/DefaultAlertingDialogTriggerMode.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/{components/AlertTriggerModeSelect.js → DefaultAlertingDialogTriggerMode.js} +10 -2
- package/esm/presentation/automations/alerting/blocks/AlertingDialogAttribute.d.ts +16 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogAttribute.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogAttribute.js +28 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogComparisonOperator.d.ts +22 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogComparisonOperator.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogComparisonOperator.js +31 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogComparisonPeriod.d.ts +18 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogComparisonPeriod.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogComparisonPeriod.js +31 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogFieldLabelWithTooltip.d.ts +11 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogFieldLabelWithTooltip.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogFieldLabelWithTooltip.js +15 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogGranularity.d.ts +15 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogGranularity.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogGranularity.js +33 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogMeasure.d.ts +30 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogMeasure.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogMeasure.js +39 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogSensitivity.d.ts +15 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogSensitivity.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogSensitivity.js +30 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogThreshold.d.ts +21 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogThreshold.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogThreshold.js +36 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogTriggerInterval.d.ts +15 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogTriggerInterval.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogTriggerInterval.js +32 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogTriggerMode.d.ts +15 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogTriggerMode.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/blocks/AlertingDialogTriggerMode.js +24 -0
- package/esm/presentation/automations/alerting/{DefaultAlertingDialog/hooks → hooks}/useAlertThreshold.d.ts +1 -1
- package/esm/presentation/automations/alerting/hooks/useAlertThreshold.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/{DefaultAlertingDialog/hooks → hooks}/useAlertThreshold.js +1 -1
- package/esm/presentation/automations/alerting/{DefaultAlertingDialog/hooks → hooks}/useThresholdValue.d.ts +1 -1
- package/esm/presentation/automations/alerting/hooks/useThresholdValue.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/{DefaultAlertingDialog/hooks → hooks}/useThresholdValue.js +2 -2
- package/esm/presentation/automations/alerting/state/types.d.ts +2 -2
- package/esm/presentation/automations/alerting/state/types.d.ts.map +1 -1
- package/esm/presentation/automations/alerting/state/useAlertingDialogFieldProps.d.ts +87 -0
- package/esm/presentation/automations/alerting/state/useAlertingDialogFieldProps.d.ts.map +1 -0
- package/esm/presentation/automations/alerting/state/useAlertingDialogFieldProps.js +234 -0
- package/esm/presentation/automations/alerting/types.d.ts +342 -3
- package/esm/presentation/automations/alerting/types.d.ts.map +1 -1
- package/esm/presentation/automations/alerting/utils/getters.d.ts +1 -8
- package/esm/presentation/automations/alerting/utils/getters.d.ts.map +1 -1
- package/esm/presentation/automations/shared/automationFilters/components/AutomationAttributeFilter.js +1 -1
- package/esm/presentation/automations/shared/automationFilters/components/AutomationDateFilter.js +1 -1
- package/esm/presentation/automations/shared/automationFilters/components/AutomationMeasureValueFilter.js +1 -1
- package/esm/presentation/automations/shared/slots/AutomationDialogFormField.d.ts +13 -0
- package/esm/presentation/automations/shared/slots/AutomationDialogFormField.d.ts.map +1 -0
- package/esm/presentation/automations/{alerting/DefaultAlertingDialog/FormField.js → shared/slots/AutomationDialogFormField.js} +10 -1
- package/esm/presentation/automations/shared/slots/types.d.ts +23 -0
- package/esm/presentation/automations/shared/slots/types.d.ts.map +1 -1
- package/esm/sdk-ui-dashboard.d.ts +727 -6
- package/package.json +21 -23
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/FormField.d.ts +0 -8
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/FormField.d.ts.map +0 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertAttributeSelect.d.ts +0 -19
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertAttributeSelect.d.ts.map +0 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertComparisonOperatorSelect.d.ts +0 -19
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertComparisonOperatorSelect.d.ts.map +0 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertComparisonPeriodSelect.d.ts +0 -15
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertComparisonPeriodSelect.d.ts.map +0 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertGranularitySelect.d.ts +0 -12
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertGranularitySelect.d.ts.map +0 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertMeasureSelect.d.ts +0 -13
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertMeasureSelect.d.ts.map +0 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertSensitivitySelect.d.ts +0 -11
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertSensitivitySelect.d.ts.map +0 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertThresholdInput.d.ts +0 -12
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertThresholdInput.d.ts.map +0 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertTriggerIntervalSelect.d.ts +0 -11
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertTriggerIntervalSelect.d.ts.map +0 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertTriggerModeSelect.d.ts +0 -12
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/components/AlertTriggerModeSelect.d.ts.map +0 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/hooks/useAlertThreshold.d.ts.map +0 -1
- package/esm/presentation/automations/alerting/DefaultAlertingDialog/hooks/useThresholdValue.d.ts.map +0 -1
|
@@ -13,8 +13,8 @@ import { Action } from '@reduxjs/toolkit';
|
|
|
13
13
|
import { ActionCreatorWithOptionalPayload } from '@reduxjs/toolkit';
|
|
14
14
|
import { ActionCreatorWithoutPayload } from '@reduxjs/toolkit';
|
|
15
15
|
import { ActionCreatorWithPayload } from '@reduxjs/toolkit';
|
|
16
|
-
import { AI_OPERATOR } from '@gooddata/sdk-ui-ext';
|
|
17
|
-
import { AI_OPERATORS } from '@gooddata/sdk-ui-ext';
|
|
16
|
+
import type { AI_OPERATOR } from '@gooddata/sdk-ui-ext';
|
|
17
|
+
import type { AI_OPERATORS } from '@gooddata/sdk-ui-ext';
|
|
18
18
|
import { AnyAction } from '@reduxjs/toolkit';
|
|
19
19
|
import { CaseReducer } from '@reduxjs/toolkit';
|
|
20
20
|
import { CaseReducerActions } from '@reduxjs/toolkit';
|
|
@@ -46,6 +46,7 @@ import { EntityState } from '@reduxjs/toolkit';
|
|
|
46
46
|
import { ExecutionResultLimitType } from '@gooddata/sdk-model';
|
|
47
47
|
import { ExplicitDrill } from '@gooddata/sdk-ui';
|
|
48
48
|
import { FilterContextItem } from '@gooddata/sdk-model';
|
|
49
|
+
import { FocusEvent as FocusEvent_2 } from 'react';
|
|
49
50
|
import { ForwardRefExoticComponent } from 'react';
|
|
50
51
|
import { GoodDataSdkError } from '@gooddata/sdk-ui';
|
|
51
52
|
import { IAbsoluteDateFilter } from '@gooddata/sdk-model';
|
|
@@ -529,7 +530,7 @@ export declare function addTextAttributeFilter(filter: DashboardTextAttributeFil
|
|
|
529
530
|
export declare function addVisualizationToSwitcherWidgetContent(ref: ObjRef, visualization: IInsightWidget, insight: IInsight, sizeInfo: IVisualizationSizeInfo, correlationId?: string): IAddVisualizationToVisualizationSwitcherWidgetContent;
|
|
530
531
|
|
|
531
532
|
/**
|
|
532
|
-
* The operator id of an anomaly-detection
|
|
533
|
+
* The operator id of an anomaly-detection condition (`"AI.ANOMALY_DETECTION"`).
|
|
533
534
|
*
|
|
534
535
|
* @alpha
|
|
535
536
|
*/
|
|
@@ -580,6 +581,56 @@ export declare function AlertingDialog(props: IAlertingDialogProps): ReactElemen
|
|
|
580
581
|
*/
|
|
581
582
|
export declare function AlertingDialogActionBar(props: IAlertingDialogActionBarBlockProps): JSX.Element;
|
|
582
583
|
|
|
584
|
+
/**
|
|
585
|
+
* The alerting dialog's attribute field ("For": the attribute value the condition is sliced by),
|
|
586
|
+
* connected to the dialog's state and rendered as a labelled form row.
|
|
587
|
+
*
|
|
588
|
+
* Renders {@link DefaultAlertingDialogAttribute} inside {@link AutomationDialogFormField} with the
|
|
589
|
+
* props of {@link useAlertingDialogAttributeProps}; every prop passed here replaces the hook's
|
|
590
|
+
* value for that prop wholesale. Renders nothing when the insight has no non-date attribute (there
|
|
591
|
+
* is nothing to slice by; the gate reads the `attributes` prop, so an override is honoured), and
|
|
592
|
+
* nothing while `useAlertingDialogContext().isLoading` is true.
|
|
593
|
+
*
|
|
594
|
+
* @alpha
|
|
595
|
+
*/
|
|
596
|
+
export declare function AlertingDialogAttribute(overrides: Partial<IAlertingDialogAttributeProps>): ReactElement;
|
|
597
|
+
|
|
598
|
+
/**
|
|
599
|
+
* The alerting dialog's condition field ("Condition": the operator — fixed threshold, change,
|
|
600
|
+
* difference or anomaly detection), connected to the dialog's state and rendered as a labelled
|
|
601
|
+
* form row.
|
|
602
|
+
*
|
|
603
|
+
* Renders {@link DefaultAlertingDialogComparisonOperator} inside {@link AutomationDialogFormField}
|
|
604
|
+
* with the props of {@link useAlertingDialogComparisonOperatorProps}; every prop passed here
|
|
605
|
+
* replaces the hook's value for that prop wholesale. Pass `enableAnomalyDetectionAlert={false}` to
|
|
606
|
+
* hide the anomaly-detection options. Renders nothing while
|
|
607
|
+
* `useAlertingDialogContext().isLoading` is true.
|
|
608
|
+
*
|
|
609
|
+
* @example
|
|
610
|
+
* ```tsx
|
|
611
|
+
* <AlertingDialogComparisonOperator enableAnomalyDetectionAlert={false} />
|
|
612
|
+
* ```
|
|
613
|
+
*
|
|
614
|
+
* @alpha
|
|
615
|
+
*/
|
|
616
|
+
export declare function AlertingDialogComparisonOperator(overrides: Partial<IAlertingDialogComparisonOperatorProps>): ReactElement;
|
|
617
|
+
|
|
618
|
+
/**
|
|
619
|
+
* The alerting dialog's comparison-period field ("Compared to": the period a change or difference
|
|
620
|
+
* condition compares against), connected to the dialog's state and rendered as a labelled form
|
|
621
|
+
* row.
|
|
622
|
+
*
|
|
623
|
+
* Renders {@link DefaultAlertingDialogComparisonPeriod} inside {@link AutomationDialogFormField}
|
|
624
|
+
* with the props of {@link useAlertingDialogComparisonPeriodProps}; every prop passed here
|
|
625
|
+
* replaces the hook's value for that prop wholesale. Renders nothing unless the `alert` prop's
|
|
626
|
+
* condition is a change or difference (only those have a comparison period; the gate reads the
|
|
627
|
+
* prop, so an override is honoured), and nothing while `useAlertingDialogContext().isLoading` is
|
|
628
|
+
* true.
|
|
629
|
+
*
|
|
630
|
+
* @alpha
|
|
631
|
+
*/
|
|
632
|
+
export declare function AlertingDialogComparisonPeriod(overrides: Partial<IAlertingDialogComparisonPeriodProps>): ReactElement;
|
|
633
|
+
|
|
583
634
|
/**
|
|
584
635
|
* Provides the alerting create/edit dialog context.
|
|
585
636
|
*
|
|
@@ -620,6 +671,19 @@ export declare function AlertingDialogDestination(overrides: Partial<IAutomation
|
|
|
620
671
|
*/
|
|
621
672
|
export declare function AlertingDialogFilters(overrides: Partial<IAlertingDialogFiltersProps>): JSX.Element;
|
|
622
673
|
|
|
674
|
+
/**
|
|
675
|
+
* The alerting dialog's granularity field (the period anomaly detection evaluates over), connected
|
|
676
|
+
* to the dialog's state and rendered as a labelled form row.
|
|
677
|
+
*
|
|
678
|
+
* Renders {@link DefaultAlertingDialogGranularity} inside {@link AutomationDialogFormField} with
|
|
679
|
+
* the props of {@link useAlertingDialogGranularityProps}; every prop passed here replaces the
|
|
680
|
+
* hook's value for that prop wholesale. Renders nothing unless the draft uses anomaly detection,
|
|
681
|
+
* and nothing while `useAlertingDialogContext().isLoading` is true.
|
|
682
|
+
*
|
|
683
|
+
* @alpha
|
|
684
|
+
*/
|
|
685
|
+
export declare function AlertingDialogGranularity(overrides: Partial<IAlertingDialogGranularityProps>): ReactElement;
|
|
686
|
+
|
|
623
687
|
/**
|
|
624
688
|
* The alerting dialog's header region (the title input row), connected to the dialog's state.
|
|
625
689
|
*
|
|
@@ -655,6 +719,34 @@ export declare type AlertingDialogHeaderDefaultProps = IAlertingDialogHeaderProp
|
|
|
655
719
|
ref?: Ref<HTMLInputElement>;
|
|
656
720
|
};
|
|
657
721
|
|
|
722
|
+
/**
|
|
723
|
+
* The alerting dialog's measure field ("Metric": the measure the condition targets), connected to
|
|
724
|
+
* the dialog's state and rendered as a labelled form row.
|
|
725
|
+
*
|
|
726
|
+
* Renders {@link DefaultAlertingDialogMeasure} inside {@link AutomationDialogFormField} with the
|
|
727
|
+
* props of {@link useAlertingDialogMeasureProps}; every prop passed here replaces the hook's value
|
|
728
|
+
* for that prop wholesale. Renders nothing while `useAlertingDialogContext().isLoading` is true.
|
|
729
|
+
* The row's label is the default dialog's — a shell that wants its own label renders the hook and
|
|
730
|
+
* the render component inside its own `AutomationDialogFormField`.
|
|
731
|
+
*
|
|
732
|
+
* @example
|
|
733
|
+
* ```tsx
|
|
734
|
+
* function MyAlertingDialog(props: IAlertingDialogProps) {
|
|
735
|
+
* return (
|
|
736
|
+
* <MyShell onClose={props.onCancel}>
|
|
737
|
+
* <AlertingDialogMeasure />
|
|
738
|
+
* <AlertingDialogComparisonOperator />
|
|
739
|
+
* <AlertingDialogThreshold />
|
|
740
|
+
* </MyShell>
|
|
741
|
+
* );
|
|
742
|
+
* }
|
|
743
|
+
* <Dashboard AlertingDialogComponent={MyAlertingDialog} />;
|
|
744
|
+
* ```
|
|
745
|
+
*
|
|
746
|
+
* @alpha
|
|
747
|
+
*/
|
|
748
|
+
export declare function AlertingDialogMeasure(overrides: Partial<IAlertingDialogMeasureProps>): ReactElement;
|
|
749
|
+
|
|
658
750
|
/**
|
|
659
751
|
* The alerting dialog's recipients region, connected to the dialog's state.
|
|
660
752
|
*
|
|
@@ -667,6 +759,64 @@ export declare type AlertingDialogHeaderDefaultProps = IAlertingDialogHeaderProp
|
|
|
667
759
|
*/
|
|
668
760
|
export declare function AlertingDialogRecipients(overrides: Partial<IAutomationDialogRecipientsProps>): JSX.Element;
|
|
669
761
|
|
|
762
|
+
/**
|
|
763
|
+
* The alerting dialog's sensitivity field (the "Sensitivity" of anomaly detection), connected to
|
|
764
|
+
* the dialog's state and rendered as a labelled form row.
|
|
765
|
+
*
|
|
766
|
+
* Renders {@link DefaultAlertingDialogSensitivity} inside {@link AutomationDialogFormField} with
|
|
767
|
+
* the props of {@link useAlertingDialogSensitivityProps}; every prop passed here replaces the
|
|
768
|
+
* hook's value for that prop wholesale. Renders nothing unless the draft uses anomaly detection,
|
|
769
|
+
* and nothing while `useAlertingDialogContext().isLoading` is true.
|
|
770
|
+
*
|
|
771
|
+
* @alpha
|
|
772
|
+
*/
|
|
773
|
+
export declare function AlertingDialogSensitivity(overrides: Partial<IAlertingDialogSensitivityProps>): ReactElement;
|
|
774
|
+
|
|
775
|
+
/**
|
|
776
|
+
* The alerting dialog's threshold field (the value a fixed-threshold, change or difference
|
|
777
|
+
* condition is compared against), connected to the dialog's state and rendered as a labelled form
|
|
778
|
+
* row.
|
|
779
|
+
*
|
|
780
|
+
* Renders {@link DefaultAlertingDialogThreshold} inside {@link AutomationDialogFormField} with the
|
|
781
|
+
* props of {@link useAlertingDialogThresholdProps}; every prop passed here replaces the hook's
|
|
782
|
+
* value for that prop wholesale. **The one `useAlertThreshold` mount**:
|
|
783
|
+
* {@link useAlertingDialogThresholdProps} owns the field's state and writes the draft
|
|
784
|
+
* (auto-computing a new alert's threshold), so place this block once per dialog and do not also
|
|
785
|
+
* call the hook. Renders nothing while the draft uses anomaly detection (that condition has no
|
|
786
|
+
* threshold); the hook stays mounted behind the gate, so the field's touched state survives a
|
|
787
|
+
* switch to anomaly detection and back. Renders nothing while
|
|
788
|
+
* `useAlertingDialogContext().isLoading` is true.
|
|
789
|
+
*
|
|
790
|
+
* @alpha
|
|
791
|
+
*/
|
|
792
|
+
export declare function AlertingDialogThreshold(overrides: Partial<IAlertingDialogThresholdProps>): ReactElement;
|
|
793
|
+
|
|
794
|
+
/**
|
|
795
|
+
* The alerting dialog's trigger-interval field (the interval a once-per-interval trigger notifies
|
|
796
|
+
* on), connected to the dialog's state and rendered as a labelled form row.
|
|
797
|
+
*
|
|
798
|
+
* Renders {@link DefaultAlertingDialogTriggerInterval} inside {@link AutomationDialogFormField}
|
|
799
|
+
* with the props of {@link useAlertingDialogTriggerIntervalProps}; every prop passed here replaces
|
|
800
|
+
* the hook's value for that prop wholesale. Renders nothing unless the draft's trigger mode is
|
|
801
|
+
* `ONCE_PER_INTERVAL`, and nothing while `useAlertingDialogContext().isLoading` is true.
|
|
802
|
+
*
|
|
803
|
+
* @alpha
|
|
804
|
+
*/
|
|
805
|
+
export declare function AlertingDialogTriggerInterval(overrides: Partial<IAlertingDialogTriggerIntervalProps>): ReactElement;
|
|
806
|
+
|
|
807
|
+
/**
|
|
808
|
+
* The alerting dialog's trigger-mode field ("Trigger": how often a met condition notifies),
|
|
809
|
+
* connected to the dialog's state and rendered as a labelled form row.
|
|
810
|
+
*
|
|
811
|
+
* Renders {@link DefaultAlertingDialogTriggerMode} inside {@link AutomationDialogFormField} with
|
|
812
|
+
* the props of {@link useAlertingDialogTriggerModeProps}; every prop passed here replaces the
|
|
813
|
+
* hook's value for that prop wholesale. Renders nothing while
|
|
814
|
+
* `useAlertingDialogContext().isLoading` is true.
|
|
815
|
+
*
|
|
816
|
+
* @alpha
|
|
817
|
+
*/
|
|
818
|
+
export declare function AlertingDialogTriggerMode(overrides: Partial<IAlertingDialogTriggerModeProps>): ReactElement;
|
|
819
|
+
|
|
670
820
|
/**
|
|
671
821
|
* @internal
|
|
672
822
|
*/
|
|
@@ -930,6 +1080,17 @@ export declare type AttributeValue = {
|
|
|
930
1080
|
name: string;
|
|
931
1081
|
};
|
|
932
1082
|
|
|
1083
|
+
/**
|
|
1084
|
+
* A labelled form row of the automation dialogs: the label on the left, the control on the right.
|
|
1085
|
+
* Props-driven — reads no context. The default alerting dialog renders every condition field
|
|
1086
|
+
* through it, as do the field blocks ({@link AlertingDialogMeasure} and siblings); a custom dialog
|
|
1087
|
+
* that wants its own label renders a field's `Default*` control inside its own
|
|
1088
|
+
* `AutomationDialogFormField`.
|
|
1089
|
+
*
|
|
1090
|
+
* @alpha
|
|
1091
|
+
*/
|
|
1092
|
+
export declare function AutomationDialogFormField({ label, children, htmlFor, fullWidth }: IAutomationDialogFormFieldProps): ReactElement;
|
|
1093
|
+
|
|
933
1094
|
/**
|
|
934
1095
|
* @alpha
|
|
935
1096
|
*/
|
|
@@ -4177,9 +4338,16 @@ export declare const DEFAULT_TAB_ID = "defaultTabId";
|
|
|
4177
4338
|
* The dialog is composed from the exported region renders — {@link DefaultAlertingDialogHeader},
|
|
4178
4339
|
* {@link DefaultAlertingDialogFilters}, {@link DefaultAlertingDialogDestination},
|
|
4179
4340
|
* {@link DefaultAlertingDialogRecipients}, {@link DefaultAutomationDialogActionBar} — fed by the
|
|
4180
|
-
* matching `use*Props` hooks ({@link useAlertingDialogFiltersProps} and siblings)
|
|
4181
|
-
*
|
|
4182
|
-
*
|
|
4341
|
+
* matching `use*Props` hooks ({@link useAlertingDialogFiltersProps} and siblings), and from the
|
|
4342
|
+
* connected field blocks — {@link AlertingDialogMeasure}, {@link AlertingDialogAttribute},
|
|
4343
|
+
* {@link AlertingDialogComparisonOperator}, {@link AlertingDialogThreshold},
|
|
4344
|
+
* {@link AlertingDialogComparisonPeriod}, {@link AlertingDialogSensitivity},
|
|
4345
|
+
* {@link AlertingDialogGranularity}, {@link AlertingDialogTriggerMode},
|
|
4346
|
+
* {@link AlertingDialogTriggerInterval} — each a labelled {@link AutomationDialogFormField} row; the
|
|
4347
|
+
* conditional ones (Attribute, Threshold, ComparisonPeriod, Sensitivity, Granularity, TriggerInterval)
|
|
4348
|
+
* gate themselves on the draft. A custom `AlertingDialogComponent` that keeps our regions and fields
|
|
4349
|
+
* but owns the markup places the connected blocks ({@link AlertingDialogFilters},
|
|
4350
|
+
* {@link AlertingDialogThreshold} and siblings) instead of this component, and reads or writes the
|
|
4183
4351
|
* same draft through {@link useAlertDraft} and {@link useAlertActions}.
|
|
4184
4352
|
*
|
|
4185
4353
|
* Slots render only in the fully rendered dialog: not while the dialog context reports loading,
|
|
@@ -4189,6 +4357,40 @@ export declare const DEFAULT_TAB_ID = "defaultTabId";
|
|
|
4189
4357
|
*/
|
|
4190
4358
|
export declare function DefaultAlertingDialog(props: IDefaultAlertingDialogProps): JSX.Element;
|
|
4191
4359
|
|
|
4360
|
+
/**
|
|
4361
|
+
* Default render of the alerting dialog's attribute field: the dropdown slicing the condition by an
|
|
4362
|
+
* attribute value; renders nothing when the insight has no non-date attribute. Props-driven — the
|
|
4363
|
+
* bare control without its label; reads no dialog context (only `useIntl`). The default dialog and
|
|
4364
|
+
* {@link AlertingDialogAttribute} render it with {@link useAlertingDialogAttributeProps} inside
|
|
4365
|
+
* {@link AutomationDialogFormField}.
|
|
4366
|
+
*
|
|
4367
|
+
* @alpha
|
|
4368
|
+
*/
|
|
4369
|
+
export declare function DefaultAlertingDialogAttribute({ id, disabled, selectedAttribute: selectedAttributeProp, getAttributeValues, isResultLoading, selectedValue, onAttributeChange, attributes, catalogAttributes, catalogDateDatasets, showLabel, closeOnParentScroll }: IAlertingDialogAttributeProps): ReactElement | null;
|
|
4370
|
+
|
|
4371
|
+
/**
|
|
4372
|
+
* Default render of the alerting dialog's comparison-operator field: the dropdown selecting the
|
|
4373
|
+
* condition's operator (fixed threshold, change, difference, anomaly detection); renders nothing
|
|
4374
|
+
* without a measure. Props-driven — the bare control without its label; reads no dialog context
|
|
4375
|
+
* (only `useIntl`). The default dialog and {@link AlertingDialogComparisonOperator} render it with
|
|
4376
|
+
* {@link useAlertingDialogComparisonOperatorProps} inside {@link AutomationDialogFormField}.
|
|
4377
|
+
*
|
|
4378
|
+
* @alpha
|
|
4379
|
+
*/
|
|
4380
|
+
export declare function DefaultAlertingDialogComparisonOperator(props: IAlertingDialogComparisonOperatorProps): ReactElement | null;
|
|
4381
|
+
|
|
4382
|
+
/**
|
|
4383
|
+
* Default render of the alerting dialog's comparison-period field: the dropdown selecting the
|
|
4384
|
+
* period a change or difference condition compares against; static text with a single comparator,
|
|
4385
|
+
* nothing for other condition types. Props-driven — the bare control without its label; reads no
|
|
4386
|
+
* dialog context (only `useIntl`). The default dialog and {@link AlertingDialogComparisonPeriod}
|
|
4387
|
+
* render it with {@link useAlertingDialogComparisonPeriodProps} inside
|
|
4388
|
+
* {@link AutomationDialogFormField}.
|
|
4389
|
+
*
|
|
4390
|
+
* @alpha
|
|
4391
|
+
*/
|
|
4392
|
+
export declare function DefaultAlertingDialogComparisonPeriod({ alert, measure, overlayPositionType, selectedComparison, selectedGranularity, onComparisonChange, id, closeOnParentScroll }: IAlertingDialogComparisonPeriodProps): ReactElement | null;
|
|
4393
|
+
|
|
4192
4394
|
/**
|
|
4193
4395
|
* Default render of the alerting dialog's destination region: the "Action" row selecting the
|
|
4194
4396
|
* notification channel. Props-driven — reads no context. The default dialog and
|
|
@@ -4210,6 +4412,16 @@ export declare function DefaultAlertingDialogDestination({ notificationChannels,
|
|
|
4210
4412
|
*/
|
|
4211
4413
|
export declare function DefaultAlertingDialogFilters(props: IAlertingDialogFiltersProps): JSX.Element;
|
|
4212
4414
|
|
|
4415
|
+
/**
|
|
4416
|
+
* Default render of the alerting dialog's granularity field: the dropdown selecting the
|
|
4417
|
+
* anomaly-detection granularity. Props-driven — the bare control without its label; reads no
|
|
4418
|
+
* dialog context (only `useIntl`). The default dialog and {@link AlertingDialogGranularity} render
|
|
4419
|
+
* it with {@link useAlertingDialogGranularityProps} inside {@link AutomationDialogFormField}.
|
|
4420
|
+
*
|
|
4421
|
+
* @alpha
|
|
4422
|
+
*/
|
|
4423
|
+
export declare function DefaultAlertingDialogGranularity({ id, allowHourlyRecurrence, selectedGranularity, onGranularityChange, overlayPositionType, closeOnParentScroll }: IAlertingDialogGranularityProps): ReactElement;
|
|
4424
|
+
|
|
4213
4425
|
/**
|
|
4214
4426
|
* Default render of the alerting dialog's header region: the back button and the title input with
|
|
4215
4427
|
* its length validation. Props-driven — reads no alerting dialog state. The default dialog and
|
|
@@ -4220,6 +4432,16 @@ export declare function DefaultAlertingDialogFilters(props: IAlertingDialogFilte
|
|
|
4220
4432
|
*/
|
|
4221
4433
|
export declare const DefaultAlertingDialogHeader: ForwardRefExoticComponent<IAlertingDialogHeaderProps & RefAttributes<HTMLInputElement>>;
|
|
4222
4434
|
|
|
4435
|
+
/**
|
|
4436
|
+
* Default render of the alerting dialog's measure field: the dropdown selecting the measure the
|
|
4437
|
+
* condition targets. Props-driven — the bare control without its label; reads no dialog context
|
|
4438
|
+
* (only `useIntl`). The default dialog and {@link AlertingDialogMeasure} render it with
|
|
4439
|
+
* {@link useAlertingDialogMeasureProps} inside {@link AutomationDialogFormField}.
|
|
4440
|
+
*
|
|
4441
|
+
* @alpha
|
|
4442
|
+
*/
|
|
4443
|
+
export declare function DefaultAlertingDialogMeasure({ id, disabled, selectedMeasure, onMeasureChange, measures, overlayPositionType, closeOnParentScroll }: IAlertingDialogMeasureProps): ReactElement;
|
|
4444
|
+
|
|
4223
4445
|
/**
|
|
4224
4446
|
* Default render of the alerting dialog's recipients region: the recipients select in a form-field
|
|
4225
4447
|
* row; the row carries the label, so the select's own label is off. Props-driven — reads no context.
|
|
@@ -4230,6 +4452,47 @@ export declare const DefaultAlertingDialogHeader: ForwardRefExoticComponent<IAle
|
|
|
4230
4452
|
*/
|
|
4231
4453
|
export declare function DefaultAlertingDialogRecipients(props: IAutomationDialogRecipientsProps): JSX.Element;
|
|
4232
4454
|
|
|
4455
|
+
/**
|
|
4456
|
+
* Default render of the alerting dialog's sensitivity field: the dropdown selecting the
|
|
4457
|
+
* anomaly-detection sensitivity. Props-driven — the bare control without its label; reads no
|
|
4458
|
+
* dialog context (only `useIntl`). The default dialog and {@link AlertingDialogSensitivity} render
|
|
4459
|
+
* it with {@link useAlertingDialogSensitivityProps} inside {@link AutomationDialogFormField}.
|
|
4460
|
+
*
|
|
4461
|
+
* @alpha
|
|
4462
|
+
*/
|
|
4463
|
+
export declare function DefaultAlertingDialogSensitivity({ id, selectedSensitivity, onSensitivityChange, overlayPositionType, closeOnParentScroll }: IAlertingDialogSensitivityProps): ReactElement;
|
|
4464
|
+
|
|
4465
|
+
/**
|
|
4466
|
+
* Default render of the alerting dialog's threshold field: the numeric input for the threshold,
|
|
4467
|
+
* with its unit suffix and validation message. Props-driven — the bare control without its label;
|
|
4468
|
+
* reads no dialog context (only `useIntl`). The default dialog and {@link AlertingDialogThreshold}
|
|
4469
|
+
* render it with {@link useAlertingDialogThresholdProps} inside {@link AutomationDialogFormField}.
|
|
4470
|
+
*
|
|
4471
|
+
* @alpha
|
|
4472
|
+
*/
|
|
4473
|
+
export declare function DefaultAlertingDialogThreshold({ id, value, onChange, onBlur, suffix, errorMessage }: IAlertingDialogThresholdProps): ReactElement;
|
|
4474
|
+
|
|
4475
|
+
/**
|
|
4476
|
+
* Default render of the alerting dialog's trigger-interval field: the dropdown selecting the
|
|
4477
|
+
* interval of a once-per-interval trigger. Props-driven — the bare control without its label;
|
|
4478
|
+
* reads no dialog context (only `useIntl`). The default dialog and
|
|
4479
|
+
* {@link AlertingDialogTriggerInterval} render it with {@link useAlertingDialogTriggerIntervalProps}
|
|
4480
|
+
* inside {@link AutomationDialogFormField}.
|
|
4481
|
+
*
|
|
4482
|
+
* @alpha
|
|
4483
|
+
*/
|
|
4484
|
+
export declare function DefaultAlertingDialogTriggerInterval({ id, selectedTriggerInterval, onTriggerIntervalChange, overlayPositionType, closeOnParentScroll }: IAlertingDialogTriggerIntervalProps): ReactElement;
|
|
4485
|
+
|
|
4486
|
+
/**
|
|
4487
|
+
* Default render of the alerting dialog's trigger-mode field: the dropdown selecting when the
|
|
4488
|
+
* alert fires. Props-driven — the bare control without its label; reads no dialog context (only
|
|
4489
|
+
* `useIntl`). The default dialog and {@link AlertingDialogTriggerMode} render it with
|
|
4490
|
+
* {@link useAlertingDialogTriggerModeProps} inside {@link AutomationDialogFormField}.
|
|
4491
|
+
*
|
|
4492
|
+
* @alpha
|
|
4493
|
+
*/
|
|
4494
|
+
export declare function DefaultAlertingDialogTriggerMode({ id, selectedTriggerMode, onTriggerModeChange, overlayPositionType, closeOnParentScroll, enableAlertOncePerInterval }: IAlertingDialogTriggerModeProps): ReactElement;
|
|
4495
|
+
|
|
4233
4496
|
/**
|
|
4234
4497
|
* Self-contained version of DefaultAlertingManagementDialogNew that builds the required
|
|
4235
4498
|
* AutomationsContext and AlertingManagementDialogContext internally from the dashboard
|
|
@@ -6396,6 +6659,158 @@ export declare interface IAlertFiltersContextValue {
|
|
|
6396
6659
|
*/
|
|
6397
6660
|
export declare type IAlertingDialogActionBarBlockProps = IUseAlertingDialogActionBarPropsInput & Partial<IAutomationDialogActionBarProps>;
|
|
6398
6661
|
|
|
6662
|
+
/**
|
|
6663
|
+
* Props of the default alerting dialog's attribute field (the "For" row).
|
|
6664
|
+
*
|
|
6665
|
+
* @alpha
|
|
6666
|
+
*/
|
|
6667
|
+
export declare interface IAlertingDialogAttributeProps {
|
|
6668
|
+
/**
|
|
6669
|
+
* Id of the dropdown button; the form row's label points at it.
|
|
6670
|
+
*/
|
|
6671
|
+
id: string;
|
|
6672
|
+
/**
|
|
6673
|
+
* Disables the select. The default dialog disables it when the dialog has no insight to pick measures from.
|
|
6674
|
+
*/
|
|
6675
|
+
disabled?: boolean;
|
|
6676
|
+
/**
|
|
6677
|
+
* The attribute the condition is sliced by; undefined for the whole measure.
|
|
6678
|
+
*/
|
|
6679
|
+
selectedAttribute: AlertAttribute | undefined;
|
|
6680
|
+
/**
|
|
6681
|
+
* The attribute element the condition is sliced to; null for the empty value, undefined for all values.
|
|
6682
|
+
*/
|
|
6683
|
+
selectedValue: string | null | undefined;
|
|
6684
|
+
/**
|
|
6685
|
+
* Called with the picked attribute and value; `(undefined, undefined)` clears the slice.
|
|
6686
|
+
*/
|
|
6687
|
+
onAttributeChange: (attribute: AlertAttribute | undefined, value: AttributeValue | undefined) => void;
|
|
6688
|
+
/**
|
|
6689
|
+
* The insight's attributes; the select offers the non-date ones and renders nothing when there is none.
|
|
6690
|
+
*/
|
|
6691
|
+
attributes: AlertAttribute[];
|
|
6692
|
+
/**
|
|
6693
|
+
* The workspace catalog's attributes, to resolve titles and display forms.
|
|
6694
|
+
*/
|
|
6695
|
+
catalogAttributes: ICatalogAttribute[];
|
|
6696
|
+
/**
|
|
6697
|
+
* The workspace catalog's date datasets, to resolve date attributes.
|
|
6698
|
+
*/
|
|
6699
|
+
catalogDateDatasets: ICatalogDateDataset[];
|
|
6700
|
+
/**
|
|
6701
|
+
* Distinct values of an attribute in the widget's execution result.
|
|
6702
|
+
*/
|
|
6703
|
+
getAttributeValues: (attribute: IAttributeMetadataObject) => AttributeValue[];
|
|
6704
|
+
/**
|
|
6705
|
+
* Disables the select while the execution result is loading.
|
|
6706
|
+
*/
|
|
6707
|
+
isResultLoading?: boolean;
|
|
6708
|
+
/**
|
|
6709
|
+
* Renders the select's own "For" label above the control. The default dialog passes false — the
|
|
6710
|
+
* form row carries the label.
|
|
6711
|
+
*/
|
|
6712
|
+
showLabel?: boolean;
|
|
6713
|
+
/**
|
|
6714
|
+
* Closes the dropdown when an ancestor scrolls; the default dialog sets it.
|
|
6715
|
+
*/
|
|
6716
|
+
closeOnParentScroll?: boolean;
|
|
6717
|
+
}
|
|
6718
|
+
|
|
6719
|
+
/**
|
|
6720
|
+
* Props of the default alerting dialog's comparison-operator field (the "Condition" row).
|
|
6721
|
+
*
|
|
6722
|
+
* @alpha
|
|
6723
|
+
*/
|
|
6724
|
+
export declare interface IAlertingDialogComparisonOperatorProps {
|
|
6725
|
+
/**
|
|
6726
|
+
* Id of the dropdown button; the form row's label points at it.
|
|
6727
|
+
*/
|
|
6728
|
+
id: string;
|
|
6729
|
+
/**
|
|
6730
|
+
* The measure the condition targets; the select renders nothing without one.
|
|
6731
|
+
*/
|
|
6732
|
+
measure: AlertMetric | undefined;
|
|
6733
|
+
/**
|
|
6734
|
+
* Offers the anomaly-detection operators. The default dialog passes the conjunction of the
|
|
6735
|
+
* `enableAnomalyDetectionAlert` and `canUseAiAssistant` features; pass false to hide those
|
|
6736
|
+
* options.
|
|
6737
|
+
*/
|
|
6738
|
+
enableAnomalyDetectionAlert: boolean;
|
|
6739
|
+
/**
|
|
6740
|
+
* The operator of a fixed-threshold condition, when that is the condition type.
|
|
6741
|
+
*/
|
|
6742
|
+
selectedComparisonOperator: IAlertComparisonOperator | undefined;
|
|
6743
|
+
/**
|
|
6744
|
+
* The relative and arithmetic operators of a relative condition, when that is the condition type.
|
|
6745
|
+
*/
|
|
6746
|
+
selectedRelativeOperator: [IAlertRelativeOperator, IAlertRelativeArithmeticOperator] | undefined;
|
|
6747
|
+
/**
|
|
6748
|
+
* The operator id of an anomaly-detection condition, when that is the condition type.
|
|
6749
|
+
*/
|
|
6750
|
+
selectedAiOperator: AlertAiOperator | undefined;
|
|
6751
|
+
/**
|
|
6752
|
+
* Called when a fixed-threshold operator is picked.
|
|
6753
|
+
*/
|
|
6754
|
+
onComparisonOperatorChange: (measure: AlertMetric, comparisonOperator: IAlertComparisonOperator) => void;
|
|
6755
|
+
/**
|
|
6756
|
+
* Called when the anomaly-detection operator is picked.
|
|
6757
|
+
*/
|
|
6758
|
+
onAnomalyDetectionChange: (measure: AlertMetric) => void;
|
|
6759
|
+
/**
|
|
6760
|
+
* Called when a relative (change / difference) operator is picked.
|
|
6761
|
+
*/
|
|
6762
|
+
onRelativeOperatorChange: (measure: AlertMetric, relativeOperator: IAlertRelativeOperator, arithmeticOperator: IAlertRelativeArithmeticOperator) => void;
|
|
6763
|
+
/**
|
|
6764
|
+
* Positioning of the dropdown overlay; the default dialog uses `"sameAsTarget"`.
|
|
6765
|
+
*/
|
|
6766
|
+
overlayPositionType?: OverlayPositionType;
|
|
6767
|
+
/**
|
|
6768
|
+
* Closes the dropdown when an ancestor scrolls; the default dialog sets it.
|
|
6769
|
+
*/
|
|
6770
|
+
closeOnParentScroll?: boolean;
|
|
6771
|
+
}
|
|
6772
|
+
|
|
6773
|
+
/**
|
|
6774
|
+
* Props of the default alerting dialog's comparison-period field (the "Compared to" row).
|
|
6775
|
+
*
|
|
6776
|
+
* @alpha
|
|
6777
|
+
*/
|
|
6778
|
+
export declare interface IAlertingDialogComparisonPeriodProps {
|
|
6779
|
+
/**
|
|
6780
|
+
* Id of the dropdown button; the form row's label points at it.
|
|
6781
|
+
*/
|
|
6782
|
+
id: string;
|
|
6783
|
+
/**
|
|
6784
|
+
* The alert draft; the select renders nothing unless its condition is a change or difference.
|
|
6785
|
+
*/
|
|
6786
|
+
alert: IAutomationMetadataObjectDefinition | undefined;
|
|
6787
|
+
/**
|
|
6788
|
+
* The measure the condition targets, whose comparators are the options; with a single
|
|
6789
|
+
* comparator the select renders it as static text.
|
|
6790
|
+
*/
|
|
6791
|
+
measure: AlertMetric | undefined;
|
|
6792
|
+
/**
|
|
6793
|
+
* The selected period comparison.
|
|
6794
|
+
*/
|
|
6795
|
+
selectedComparison?: AlertMetricComparatorType;
|
|
6796
|
+
/**
|
|
6797
|
+
* The selected granularity of the period shift.
|
|
6798
|
+
*/
|
|
6799
|
+
selectedGranularity?: DateAttributeGranularity;
|
|
6800
|
+
/**
|
|
6801
|
+
* Called with the picked comparison and its granularity.
|
|
6802
|
+
*/
|
|
6803
|
+
onComparisonChange: (comparison: AlertMetricComparatorType, granularity?: DateAttributeGranularity) => void;
|
|
6804
|
+
/**
|
|
6805
|
+
* Positioning of the dropdown overlay; the default dialog uses `"sameAsTarget"`.
|
|
6806
|
+
*/
|
|
6807
|
+
overlayPositionType?: OverlayPositionType;
|
|
6808
|
+
/**
|
|
6809
|
+
* Closes the dropdown when an ancestor scrolls; the default dialog sets it.
|
|
6810
|
+
*/
|
|
6811
|
+
closeOnParentScroll?: boolean;
|
|
6812
|
+
}
|
|
6813
|
+
|
|
6399
6814
|
/**
|
|
6400
6815
|
* Sub-context for the alerting create/edit dialog.
|
|
6401
6816
|
*
|
|
@@ -6451,6 +6866,38 @@ export declare interface IAlertingDialogFiltersProps extends IAutomationDialogFi
|
|
|
6451
6866
|
disableDateFilters: boolean;
|
|
6452
6867
|
}
|
|
6453
6868
|
|
|
6869
|
+
/**
|
|
6870
|
+
* Props of the default alerting dialog's granularity field (anomaly detection).
|
|
6871
|
+
*
|
|
6872
|
+
* @alpha
|
|
6873
|
+
*/
|
|
6874
|
+
export declare interface IAlertingDialogGranularityProps {
|
|
6875
|
+
/**
|
|
6876
|
+
* Id of the dropdown button; the form row's label points at it.
|
|
6877
|
+
*/
|
|
6878
|
+
id: string;
|
|
6879
|
+
/**
|
|
6880
|
+
* Offers the `"HOUR"` granularity.
|
|
6881
|
+
*/
|
|
6882
|
+
allowHourlyRecurrence: boolean;
|
|
6883
|
+
/**
|
|
6884
|
+
* The anomaly-detection granularity; undefined renders as `"WEEK"`.
|
|
6885
|
+
*/
|
|
6886
|
+
selectedGranularity: IAlertAnomalyDetectionGranularity | undefined;
|
|
6887
|
+
/**
|
|
6888
|
+
* Called with the picked granularity.
|
|
6889
|
+
*/
|
|
6890
|
+
onGranularityChange: (granularity: IAlertAnomalyDetectionGranularity) => void;
|
|
6891
|
+
/**
|
|
6892
|
+
* Positioning of the dropdown overlay; the default dialog uses `"sameAsTarget"`.
|
|
6893
|
+
*/
|
|
6894
|
+
overlayPositionType?: OverlayPositionType;
|
|
6895
|
+
/**
|
|
6896
|
+
* Closes the dropdown when an ancestor scrolls; the default dialog sets it.
|
|
6897
|
+
*/
|
|
6898
|
+
closeOnParentScroll?: boolean;
|
|
6899
|
+
}
|
|
6900
|
+
|
|
6454
6901
|
/**
|
|
6455
6902
|
* Props of the default alerting dialog's header region (the title input row).
|
|
6456
6903
|
*
|
|
@@ -6463,6 +6910,42 @@ export declare interface IAlertingDialogHeaderProps extends IAutomationDialogHea
|
|
|
6463
6910
|
onCancel?: () => void;
|
|
6464
6911
|
}
|
|
6465
6912
|
|
|
6913
|
+
/**
|
|
6914
|
+
* Props of the default alerting dialog's measure field (the "Metric" row).
|
|
6915
|
+
*
|
|
6916
|
+
* @alpha
|
|
6917
|
+
*/
|
|
6918
|
+
export declare interface IAlertingDialogMeasureProps {
|
|
6919
|
+
/**
|
|
6920
|
+
* Id of the dropdown button; the form row's label points at it.
|
|
6921
|
+
*/
|
|
6922
|
+
id?: string;
|
|
6923
|
+
/**
|
|
6924
|
+
* Disables the select. The default dialog disables it when the dialog has no insight to pick measures from.
|
|
6925
|
+
*/
|
|
6926
|
+
disabled?: boolean;
|
|
6927
|
+
/**
|
|
6928
|
+
* The measure the condition targets; undefined shows the placeholder.
|
|
6929
|
+
*/
|
|
6930
|
+
selectedMeasure: AlertMetric | undefined;
|
|
6931
|
+
/**
|
|
6932
|
+
* Called with the picked measure.
|
|
6933
|
+
*/
|
|
6934
|
+
onMeasureChange: (measure: AlertMetric) => void;
|
|
6935
|
+
/**
|
|
6936
|
+
* The insight's measures an alert can be built on.
|
|
6937
|
+
*/
|
|
6938
|
+
measures: AlertMetric[];
|
|
6939
|
+
/**
|
|
6940
|
+
* Positioning of the dropdown overlay; the default dialog uses `"sameAsTarget"`.
|
|
6941
|
+
*/
|
|
6942
|
+
overlayPositionType?: OverlayPositionType;
|
|
6943
|
+
/**
|
|
6944
|
+
* Closes the dropdown when an ancestor scrolls; the default dialog sets it.
|
|
6945
|
+
*/
|
|
6946
|
+
closeOnParentScroll?: boolean;
|
|
6947
|
+
}
|
|
6948
|
+
|
|
6466
6949
|
/**
|
|
6467
6950
|
* @alpha
|
|
6468
6951
|
*/
|
|
@@ -6544,6 +7027,34 @@ export declare interface IAlertingDialogProps {
|
|
|
6544
7027
|
onDeleteError?: (error: GoodDataSdkError) => void;
|
|
6545
7028
|
}
|
|
6546
7029
|
|
|
7030
|
+
/**
|
|
7031
|
+
* Props of the default alerting dialog's sensitivity field (anomaly detection).
|
|
7032
|
+
*
|
|
7033
|
+
* @alpha
|
|
7034
|
+
*/
|
|
7035
|
+
export declare interface IAlertingDialogSensitivityProps {
|
|
7036
|
+
/**
|
|
7037
|
+
* Id of the dropdown button; the form row's label points at it.
|
|
7038
|
+
*/
|
|
7039
|
+
id: string;
|
|
7040
|
+
/**
|
|
7041
|
+
* The anomaly-detection sensitivity; undefined renders as `"MEDIUM"`.
|
|
7042
|
+
*/
|
|
7043
|
+
selectedSensitivity: IAlertAnomalyDetectionSensitivity | undefined;
|
|
7044
|
+
/**
|
|
7045
|
+
* Called with the picked sensitivity.
|
|
7046
|
+
*/
|
|
7047
|
+
onSensitivityChange: (sensitivity: IAlertAnomalyDetectionSensitivity) => void;
|
|
7048
|
+
/**
|
|
7049
|
+
* Positioning of the dropdown overlay; the default dialog uses `"sameAsTarget"`.
|
|
7050
|
+
*/
|
|
7051
|
+
overlayPositionType?: OverlayPositionType;
|
|
7052
|
+
/**
|
|
7053
|
+
* Closes the dropdown when an ancestor scrolls; the default dialog sets it.
|
|
7054
|
+
*/
|
|
7055
|
+
closeOnParentScroll?: boolean;
|
|
7056
|
+
}
|
|
7057
|
+
|
|
6547
7058
|
/**
|
|
6548
7059
|
* Section-level overrides of the default alerting dialog.
|
|
6549
7060
|
*
|
|
@@ -6603,6 +7114,98 @@ export declare interface IAlertingDialogSlots {
|
|
|
6603
7114
|
ActionBar?: ComponentType<ISlotProps<IAutomationDialogActionBarProps>>;
|
|
6604
7115
|
}
|
|
6605
7116
|
|
|
7117
|
+
/**
|
|
7118
|
+
* Props of the default alerting dialog's threshold field (the "Threshold" row).
|
|
7119
|
+
*
|
|
7120
|
+
* @alpha
|
|
7121
|
+
*/
|
|
7122
|
+
export declare interface IAlertingDialogThresholdProps {
|
|
7123
|
+
/**
|
|
7124
|
+
* Id of the input; the form row's label and the error message point at it.
|
|
7125
|
+
*/
|
|
7126
|
+
id: string;
|
|
7127
|
+
/**
|
|
7128
|
+
* The threshold shown; undefined for an empty input.
|
|
7129
|
+
*/
|
|
7130
|
+
value: number | undefined;
|
|
7131
|
+
/**
|
|
7132
|
+
* Called with the raw input value on every keystroke.
|
|
7133
|
+
*/
|
|
7134
|
+
onChange: (value: string | number) => void;
|
|
7135
|
+
/**
|
|
7136
|
+
* Called on blur; the default dialog rounds the value to the measure's format here.
|
|
7137
|
+
*/
|
|
7138
|
+
onBlur: (event: FocusEvent_2<HTMLInputElement>) => void;
|
|
7139
|
+
/**
|
|
7140
|
+
* Unit shown after the input — `"%"` for a change condition.
|
|
7141
|
+
*/
|
|
7142
|
+
suffix?: string;
|
|
7143
|
+
/**
|
|
7144
|
+
* Validation message shown under the input; undefined when there is none.
|
|
7145
|
+
*/
|
|
7146
|
+
errorMessage?: string;
|
|
7147
|
+
}
|
|
7148
|
+
|
|
7149
|
+
/**
|
|
7150
|
+
* Props of the default alerting dialog's trigger-interval field (the "Interval" row).
|
|
7151
|
+
*
|
|
7152
|
+
* @alpha
|
|
7153
|
+
*/
|
|
7154
|
+
export declare interface IAlertingDialogTriggerIntervalProps {
|
|
7155
|
+
/**
|
|
7156
|
+
* Id of the dropdown button; the form row's label points at it.
|
|
7157
|
+
*/
|
|
7158
|
+
id: string;
|
|
7159
|
+
/**
|
|
7160
|
+
* The interval of a `"ONCE_PER_INTERVAL"` trigger.
|
|
7161
|
+
*/
|
|
7162
|
+
selectedTriggerInterval: IAlertTriggerInterval;
|
|
7163
|
+
/**
|
|
7164
|
+
* Called with the picked interval.
|
|
7165
|
+
*/
|
|
7166
|
+
onTriggerIntervalChange: (triggerInterval: IAlertTriggerInterval) => void;
|
|
7167
|
+
/**
|
|
7168
|
+
* Positioning of the dropdown overlay; the default dialog uses `"sameAsTarget"`.
|
|
7169
|
+
*/
|
|
7170
|
+
overlayPositionType?: OverlayPositionType;
|
|
7171
|
+
/**
|
|
7172
|
+
* Closes the dropdown when an ancestor scrolls; the default dialog sets it.
|
|
7173
|
+
*/
|
|
7174
|
+
closeOnParentScroll?: boolean;
|
|
7175
|
+
}
|
|
7176
|
+
|
|
7177
|
+
/**
|
|
7178
|
+
* Props of the default alerting dialog's trigger-mode field (the "Trigger" row).
|
|
7179
|
+
*
|
|
7180
|
+
* @alpha
|
|
7181
|
+
*/
|
|
7182
|
+
export declare interface IAlertingDialogTriggerModeProps {
|
|
7183
|
+
/**
|
|
7184
|
+
* Id of the dropdown button; the form row's label points at it.
|
|
7185
|
+
*/
|
|
7186
|
+
id: string;
|
|
7187
|
+
/**
|
|
7188
|
+
* When the alert fires: `"ALWAYS"`, `"ONCE"` or `"ONCE_PER_INTERVAL"`.
|
|
7189
|
+
*/
|
|
7190
|
+
selectedTriggerMode: IAlertTriggerMode;
|
|
7191
|
+
/**
|
|
7192
|
+
* Called with the picked mode.
|
|
7193
|
+
*/
|
|
7194
|
+
onTriggerModeChange: (triggerMode: IAlertTriggerMode) => void;
|
|
7195
|
+
/**
|
|
7196
|
+
* Positioning of the dropdown overlay; the default dialog uses `"sameAsTarget"`.
|
|
7197
|
+
*/
|
|
7198
|
+
overlayPositionType?: OverlayPositionType;
|
|
7199
|
+
/**
|
|
7200
|
+
* Closes the dropdown when an ancestor scrolls; the default dialog sets it.
|
|
7201
|
+
*/
|
|
7202
|
+
closeOnParentScroll?: boolean;
|
|
7203
|
+
/**
|
|
7204
|
+
* Offers `"ONCE_PER_INTERVAL"`; the default dialog passes the feature flag.
|
|
7205
|
+
*/
|
|
7206
|
+
enableAlertOncePerInterval?: boolean;
|
|
7207
|
+
}
|
|
7208
|
+
|
|
6606
7209
|
/**
|
|
6607
7210
|
* Sub-context for the alerting management dialog.
|
|
6608
7211
|
* The connector hydrates this from dashboard state.
|
|
@@ -7029,6 +7632,30 @@ export declare interface IAutomationDialogFiltersProps {
|
|
|
7029
7632
|
onParameterDelete: (ref: IdentifierRef) => void;
|
|
7030
7633
|
}
|
|
7031
7634
|
|
|
7635
|
+
/**
|
|
7636
|
+
* Props of {@link AutomationDialogFormField}: a labelled form row of the automation dialogs.
|
|
7637
|
+
*
|
|
7638
|
+
* @alpha
|
|
7639
|
+
*/
|
|
7640
|
+
export declare interface IAutomationDialogFormFieldProps {
|
|
7641
|
+
/**
|
|
7642
|
+
* The row's label, rendered in a `<label>` on the left.
|
|
7643
|
+
*/
|
|
7644
|
+
label: ReactNode;
|
|
7645
|
+
/**
|
|
7646
|
+
* The control, rendered on the right.
|
|
7647
|
+
*/
|
|
7648
|
+
children: ReactNode;
|
|
7649
|
+
/**
|
|
7650
|
+
* The id of the control the label is for.
|
|
7651
|
+
*/
|
|
7652
|
+
htmlFor?: string;
|
|
7653
|
+
/**
|
|
7654
|
+
* Lets the control span the full row width instead of the default control column.
|
|
7655
|
+
*/
|
|
7656
|
+
fullWidth?: boolean;
|
|
7657
|
+
}
|
|
7658
|
+
|
|
7032
7659
|
/**
|
|
7033
7660
|
* Members shared by both automation dialogs' header regions.
|
|
7034
7661
|
*
|
|
@@ -30376,6 +31003,39 @@ export declare function useAlertFilters(): IAlertFiltersContextValue;
|
|
|
30376
31003
|
*/
|
|
30377
31004
|
export declare function useAlertingDialogActionBarProps({ onCancel, onSubmit, isSaving, onDelete }: IUseAlertingDialogActionBarPropsInput): IAutomationDialogActionBarProps;
|
|
30378
31005
|
|
|
31006
|
+
/**
|
|
31007
|
+
* The exact props the default alerting dialog renders its attribute field with.
|
|
31008
|
+
*
|
|
31009
|
+
* Throws outside the alerting dialog's state providers.
|
|
31010
|
+
*
|
|
31011
|
+
* @alpha
|
|
31012
|
+
*/
|
|
31013
|
+
export declare function useAlertingDialogAttributeProps(): IAlertingDialogAttributeProps;
|
|
31014
|
+
|
|
31015
|
+
/**
|
|
31016
|
+
* The exact props the default alerting dialog renders its comparison-operator field with.
|
|
31017
|
+
*
|
|
31018
|
+
* `enableAnomalyDetectionAlert` is the conjunction of the `enableAnomalyDetectionAlert` and
|
|
31019
|
+
* `canUseAiAssistant` features.
|
|
31020
|
+
*
|
|
31021
|
+
* Throws outside the alerting dialog's state providers.
|
|
31022
|
+
*
|
|
31023
|
+
* @alpha
|
|
31024
|
+
*/
|
|
31025
|
+
export declare function useAlertingDialogComparisonOperatorProps(): IAlertingDialogComparisonOperatorProps;
|
|
31026
|
+
|
|
31027
|
+
/**
|
|
31028
|
+
* The exact props the default alerting dialog renders its comparison-period field with.
|
|
31029
|
+
*
|
|
31030
|
+
* `onComparisonChange` closes over the selected measure (and relative operator), so it takes only
|
|
31031
|
+
* the field's value.
|
|
31032
|
+
*
|
|
31033
|
+
* Throws outside the alerting dialog's state providers.
|
|
31034
|
+
*
|
|
31035
|
+
* @alpha
|
|
31036
|
+
*/
|
|
31037
|
+
export declare function useAlertingDialogComparisonPeriodProps(): IAlertingDialogComparisonPeriodProps;
|
|
31038
|
+
|
|
30379
31039
|
/**
|
|
30380
31040
|
* Reads the alerting create/edit dialog context.
|
|
30381
31041
|
*
|
|
@@ -30408,6 +31068,18 @@ export declare function useAlertingDialogDestinationProps(): IAutomationDialogDe
|
|
|
30408
31068
|
*/
|
|
30409
31069
|
export declare function useAlertingDialogFiltersProps(): IAlertingDialogFiltersProps;
|
|
30410
31070
|
|
|
31071
|
+
/**
|
|
31072
|
+
* The exact props the default alerting dialog renders its granularity field with.
|
|
31073
|
+
*
|
|
31074
|
+
* `onGranularityChange` closes over the selected measure (and relative operator), so it takes only
|
|
31075
|
+
* the field's value.
|
|
31076
|
+
*
|
|
31077
|
+
* Throws outside the alerting dialog's state providers.
|
|
31078
|
+
*
|
|
31079
|
+
* @alpha
|
|
31080
|
+
*/
|
|
31081
|
+
export declare function useAlertingDialogGranularityProps(): IAlertingDialogGranularityProps;
|
|
31082
|
+
|
|
30411
31083
|
/**
|
|
30412
31084
|
* The exact props the default alerting dialog renders its header region with.
|
|
30413
31085
|
*
|
|
@@ -30417,6 +31089,15 @@ export declare function useAlertingDialogFiltersProps(): IAlertingDialogFiltersP
|
|
|
30417
31089
|
*/
|
|
30418
31090
|
export declare function useAlertingDialogHeaderProps({ onCancel, ref }: IUseAlertingDialogHeaderPropsInput): AlertingDialogHeaderDefaultProps;
|
|
30419
31091
|
|
|
31092
|
+
/**
|
|
31093
|
+
* The exact props the default alerting dialog renders its measure field with.
|
|
31094
|
+
*
|
|
31095
|
+
* Throws outside the alerting dialog's state providers.
|
|
31096
|
+
*
|
|
31097
|
+
* @alpha
|
|
31098
|
+
*/
|
|
31099
|
+
export declare function useAlertingDialogMeasureProps(): IAlertingDialogMeasureProps;
|
|
31100
|
+
|
|
30420
31101
|
/**
|
|
30421
31102
|
* The exact props the default alerting dialog renders its recipients region with.
|
|
30422
31103
|
*
|
|
@@ -30426,6 +31107,46 @@ export declare function useAlertingDialogHeaderProps({ onCancel, ref }: IUseAler
|
|
|
30426
31107
|
*/
|
|
30427
31108
|
export declare function useAlertingDialogRecipientsProps(): IAutomationDialogRecipientsProps;
|
|
30428
31109
|
|
|
31110
|
+
/**
|
|
31111
|
+
* The exact props the default alerting dialog renders its sensitivity field with.
|
|
31112
|
+
*
|
|
31113
|
+
* Throws outside the alerting dialog's state providers.
|
|
31114
|
+
*
|
|
31115
|
+
* @alpha
|
|
31116
|
+
*/
|
|
31117
|
+
export declare function useAlertingDialogSensitivityProps(): IAlertingDialogSensitivityProps;
|
|
31118
|
+
|
|
31119
|
+
/**
|
|
31120
|
+
* The exact props the default alerting dialog renders its threshold field with.
|
|
31121
|
+
*
|
|
31122
|
+
* Owns the field's state: its effect auto-computes the threshold of a new alert from the measure's
|
|
31123
|
+
* current value and clears it for a relative operator, writing the draft. **Call it once per
|
|
31124
|
+
* dialog** — through {@link AlertingDialogThreshold}, which is that mount in the default dialog and
|
|
31125
|
+
* in a shell of blocks, or directly, never both. Throws outside the alerting dialog's state
|
|
31126
|
+
* providers.
|
|
31127
|
+
*
|
|
31128
|
+
* @alpha
|
|
31129
|
+
*/
|
|
31130
|
+
export declare function useAlertingDialogThresholdProps(): IAlertingDialogThresholdProps;
|
|
31131
|
+
|
|
31132
|
+
/**
|
|
31133
|
+
* The exact props the default alerting dialog renders its trigger-interval field with.
|
|
31134
|
+
*
|
|
31135
|
+
* Throws outside the alerting dialog's state providers.
|
|
31136
|
+
*
|
|
31137
|
+
* @alpha
|
|
31138
|
+
*/
|
|
31139
|
+
export declare function useAlertingDialogTriggerIntervalProps(): IAlertingDialogTriggerIntervalProps;
|
|
31140
|
+
|
|
31141
|
+
/**
|
|
31142
|
+
* The exact props the default alerting dialog renders its trigger-mode field with.
|
|
31143
|
+
*
|
|
31144
|
+
* Throws outside the alerting dialog's state providers.
|
|
31145
|
+
*
|
|
31146
|
+
* @alpha
|
|
31147
|
+
*/
|
|
31148
|
+
export declare function useAlertingDialogTriggerModeProps(): IAlertingDialogTriggerModeProps;
|
|
31149
|
+
|
|
30429
31150
|
/**
|
|
30430
31151
|
* Reads the alerting management dialog context.
|
|
30431
31152
|
*
|