IIndicatorEditableSetting

Type interface

Sources

IIndicatorEditableSetting is an interface: it describes a shape of data and is not imported on its own.

Properties

#key

Type string

Key of the indicator setting this field edits.

#maxValue

Type undefined | numberSince 5.20.0

Largest value allowed for a "number" setting.

#minValue

Type undefined | numberSince 5.8.1

Smallest value allowed for a "number" setting.

#name

Type string

Label of the field in the settings modal. Consecutive fields with the same name share one row.

#options

Type Array

Items of a "dropdown": strings, or objects with a value and a text.

An option with extTarget (the key of a "number" field) sets that field to extTargetValue when picked, and its limits to extTargetMinValue, extTargetMaxValue and extTargetStep.

#scale

Type undefined | numberSince 5.20.0

Multiplier for showing the value in the settings modal: the input shows the stored value times scale and divides it back on save. For example, Acceleration Bands factor is stored in thousandths, so scale: 1000 shows 0.001 as 1.

The stored value, minValue, maxValue and step stay in stored units.

#step

Type undefined | numberSince 5.20.0

Step of the number input. A step of 1 or more also makes the setting a whole number: typed decimals are rounded.

#type

Type "color" | "number" | "dropdown" | "checkbox" | "text"

Kind of input the settings modal shows for the setting.