IAlertFiltersContextValue
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The alerting dialog’s filter and export-parameter model: the current selection, the available filters, the two filter mutators and the staleness flags, plus the automation’s execution parameters and their mutators.
Changes when a filter or a parameter is edited.
export interface IAlertFiltersContextValue
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (BETA) False when the saved filters or the saved parameters no longer match the dashboard; gates the stale-filters confirmation. | ||
(BETA) The parameter chips to render. Empty when the | |||
FilterContextItem[] | undefined | (BETA) The dashboard filters the alert may use; undefined until resolved. | ||
IAvailableAutomationParameter[] | (BETA) Workspace parameters addable via the “+” menu. Empty when the feature is off. | ||
() => void | (BETA) Drops stored parameters whose | ||
boolean | (BETA) Whether the saved filters alone no longer match the dashboard. | ||
() => void | (BETA) Replaces the selection with the dashboard’s current filters (the stale-filters repair). | ||
(filters: FilterContextItem[]) => void | (BETA) Replaces the selection with the complete updated array and mirrors it into the draft. | ||
(ref: IdentifierRef) => void | (BETA) Adds a workspace parameter with its default value. | ||
(ref: IdentifierRef, value: ParameterValue) => void | (BETA) Sets a parameter’s value. | ||
(ref: IdentifierRef) => void | (BETA) Removes a parameter override. | ||
(BETA) The filters the alert is saved with. |
Property details
IAlertFiltersContextValue.automationIsValidpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
False when the saved filters or the saved parameters no longer match the dashboard; gates the stale-filters confirmation.
automationIsValid: boolean;
IAlertFiltersContextValue.automationParameterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The parameter chips to render. Empty when the enableParameters feature is off.
automationParameters: IAutomationParameter[];
IAlertFiltersContextValue.availableFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The dashboard filters the alert may use; undefined until resolved.
availableFilters: FilterContextItem[] | undefined;
IAlertFiltersContextValue.availableParameterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Workspace parameters addable via the “+” menu. Empty when the feature is off.
availableParameters: IAvailableAutomationParameter[];
IAlertFiltersContextValue.dropStaleParameterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Drops stored parameters whose ref left the workspace catalog, keeping every other override.
dropStaleParameters: () => void;
IAlertFiltersContextValue.filtersAreStalepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Whether the saved filters alone no longer match the dashboard.
filtersAreStale: boolean;
IAlertFiltersContextValue.onApplyCurrentFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Replaces the selection with the dashboard’s current filters (the stale-filters repair).
onApplyCurrentFilters: () => void;
IAlertFiltersContextValue.onFiltersChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Replaces the selection with the complete updated array and mirrors it into the draft.
onFiltersChange: (filters: FilterContextItem[]) => void;
IAlertFiltersContextValue.onParameterAddpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Adds a workspace parameter with its default value.
onParameterAdd: (ref: IdentifierRef) => void;
IAlertFiltersContextValue.onParameterChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets a parameter’s value.
onParameterChange: (ref: IdentifierRef, value: ParameterValue) => void;
IAlertFiltersContextValue.onParameterDeletepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Removes a parameter override.
onParameterDelete: (ref: IdentifierRef) => void;
IAlertFiltersContextValue.selectedFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The filters the alert is saved with.
selectedFilters: FilterContextItem[];