Skip to content

SiThresholdComponent documentation

selector
si-threshold

Input Properties

NameTypeDefaultDescription
addAriaLabel
TranslatableString$localize`:@@SI_THRESHOLD.ADD:Add step`The aria-label for add button
canAddRemoveSteps
booleantrueWhen disabled, steps cannot be added/removed
deleteAriaLabel
TranslatableString$localize`:@@SI_THRESHOLD.DELETE:Delete step`The aria-label for delete button
horizontalLayout
booleanfalseUse horizontal layout?
inputAriaLabel
TranslatableString$localize`:@@SI_THRESHOLD.INPUT_LABEL:Threshold value`The aria-label for input field
maxSteps
number0Max. number of steps, 0 for no hard limit
maxValue
number100The max. value for the threshold value
minValue
number0The min. value for the threshold value
options
(SelectOptionLegacy[] | SelectOption<unknown>[])[]Options to be shown in select dropdown
readonly
booleanfalseThe obvious
readonlyConditions
booleanfalseIndicate that the threshold options are readonly and cannot be changed. This will also disable adding / removing steps.
showDecIncButtons
booleantrueShow dec/inc buttons?
statusAriaLabel
TranslatableString$localize`:@@SI_THRESHOLD.STATUS:Status`The aria-label for status selection
stepSize
number1The step size for the threshold value
thresholdSteps
ThresholdStep[][]The thresholds
unit
string''The unit to show
validation
booleantrueDo validation?

Output Properties

NameTypeDescription
thresholdStepsChange
ThresholdStep[]The thresholds
validChange
booleanFired when validation status changes

Attributes and Methods

NameTypeDefaultDescription
(readonly) valid
booleanWhether the current input value is valid or not.

Types Documentation

Represents a translatable string. This can either be a translation key, e.g. ACTIONS.EDIT that will be automatically translated when displayed on the UI or a pre-translated string, e.g. Edit . Equivalent to a normal string in usage and functionality.
Copyright (c) Siemens 2016 - 2025 SPDX-License-Identifier: MIT
Deprecated: Use SelectOption instead.
Properties
Optional color class for the icon
color?: string
Is the option disabled?
disabled?: boolean
Optional icon to display
icon?: string
Identifies the option, will be used as value for the component
id: string
Title to display
title: string
Defines this to be the deprecated option.
type?: undefined
A select option
Properties
Whether this option is disabled.
disabled?: boolean
An optional icon.
icon?: string
The color of an icon.
iconColor?: string
A label to be shown for this option. Is optional if a custom template is provided or if the value should directly be rendered.
label?: string
An optional stacked icon.
stackedIcon?: string
The color of a stacked icon.
stackedIconColor?: string
Defines this to be an option.
type: "option"
Used for typeahead functionality when filtering is disabled. If provided, this will be used, otherwise the innerText of the rendered element.
typeaheadLabel?: string
The value if this option.
It will be used for formControls and the value property of this si-select .
The value will internally be checked on equality by using === .
So an app should either use string or ensure that same values are referentially equal.

value: T
One step in a list of thresholds
Properties
One of the SelectOption.id
optionValue: string
When set to false , input fields are highlighted as invalid
valid?: boolean
Threshold value, the first step has no value
value?: number
Translatable
import

Except where otherwise noted, content on this site is licensed under MIT License.