IIndicatorEditableSetting

Type interface

Inheritance

IIndicatorEditableSetting does not extend any other symbol.

IIndicatorEditableSetting is not extended by any other symbol.

Properties

key
#

Type string

Key of the indicator setting this field edits.

maxValue
#

Type undefined | number

Largest value allowed for a "number" setting.

@since 5.20.0

minValue
#

Type undefined | number

Smallest value allowed for a "number" setting.

@since 5.8.1

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 | number

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.

@since 5.20.0

step
#

Type undefined | number

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

@since 5.20.0

type
#

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

Kind of input the settings modal shows for the setting.