IIndicatorEditableSetting

Type interface

Inheritance

IIndicatorEditableSetting does not extend any other symbol.

IIndicatorEditableSetting is not extended by any other symbol.

Properties

key
#

Type string

Setting key.

maxValue
#

Type undefined | number

Maximum numeric value allowable in this field.

@since 5.20.0

minValue
#

Type undefined | number

Minimum numeric value allowable in this field.

@since 5.8.1

name
#

Type string

Name of the setting (displayed in edit modal).

Settings with the same name will be grouped in modal.

options
#

Type Array

If type: "dropdown", options should contain a list of items it.

scale
#

Type undefined | number

Display multiplier for the settings modal only. The value shown/edited in the UI is stored value × scale, and it is divided back on save. Use it when a setting's stored unit is awkward to show — e.g. Acceleration Bands factor is stored in thousandths, so scale: 1000 displays the conventional 1 (= single band width) instead of 0.001.

Does NOT affect the stored/serialized value, the API, or minValue/ maxValue/step — those all stay in stored units.

@since 5.20.0

step
#

Type undefined | number

Step for the numeric input. A step of 1 also marks the setting as an integer, so typed decimals are rounded to whole numbers.

@since 5.20.0

type
#

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

Type of the control to show for editing the setting in modal.