IAlertingDialogAttributeProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Props of the default alerting dialog’s attribute field (the “For” row).
export interface IAlertingDialogAttributeProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) The insight’s attributes; the select offers the non-date ones and renders nothing when there is none. | |||
(BETA) The workspace catalog’s attributes, to resolve titles and display forms. | |||
(BETA) The workspace catalog’s date datasets, to resolve date attributes. | |||
boolean | (BETA) (Optional) Closes the dropdown when an ancestor scrolls; the default dialog sets it. | ||
boolean | (BETA) (Optional) Disables the select. The default dialog disables it when the dialog has no insight to pick measures from. | ||
(attribute: IAttribute) => AttributeValue[] | (BETA) Distinct values of an insight attribute in the widget’s execution result, by its display form. | ||
string | (BETA) Id of the dropdown button; the form row’s label points at it. | ||
boolean | (BETA) (Optional) Disables the select while the execution result is loading. | ||
(attribute: AlertAttribute | undefined, value: AttributeValue | undefined) => void | (BETA) Called with the picked attribute and value; | ||
AlertAttribute | undefined | (BETA) The attribute the condition is sliced by; undefined for the whole measure. | ||
string | null | undefined | (BETA) The attribute element the condition is sliced to; null for the empty value, undefined for all values. | ||
boolean | (BETA) (Optional) Renders the select’s own “For” label above the control. The default dialog passes false — the form row carries the label. |
Property details
IAlertingDialogAttributeProps.attributespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The insight’s attributes; the select offers the non-date ones and renders nothing when there is none.
attributes: AlertAttribute[];
IAlertingDialogAttributeProps.catalogAttributespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The workspace catalog’s attributes, to resolve titles and display forms.
catalogAttributes: ICatalogAttribute[];
IAlertingDialogAttributeProps.catalogDateDatasetspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The workspace catalog’s date datasets, to resolve date attributes.
catalogDateDatasets: ICatalogDateDataset[];
IAlertingDialogAttributeProps.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;
IAlertingDialogAttributeProps.disabledpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Disables the select. The default dialog disables it when the dialog has no insight to pick measures from.
disabled?: boolean;
IAlertingDialogAttributeProps.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[];
IAlertingDialogAttributeProps.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;
IAlertingDialogAttributeProps.isResultLoadingpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Disables the select while the execution result is loading.
isResultLoading?: boolean;
IAlertingDialogAttributeProps.onAttributeChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called with the picked attribute and value; (undefined, undefined) clears the slice.
onAttributeChange: (attribute: AlertAttribute | undefined, value: AttributeValue | undefined) => void;
IAlertingDialogAttributeProps.selectedAttributepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The attribute the condition is sliced by; undefined for the whole measure.
selectedAttribute: AlertAttribute | undefined;
IAlertingDialogAttributeProps.selectedValuepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The attribute element the condition is sliced to; null for the empty value, undefined for all values.
selectedValue: string | null | undefined;
IAlertingDialogAttributeProps.showLabelpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Renders the select’s own “For” label above the control. The default dialog passes false — the form row carries the label.
showLabel?: boolean;