charton API

---

charton API / @chart-on/core / index / ChartSettingField

Interface: ChartSettingField

Defined in: packages/core/src/chart-settings.ts:32

One option. path is a dotted path into the chart options (legend.mode, crosshair.vertical.visible, theme.up, features.legend), into the main series' options with a series. prefix (series.wicks), or into the main pane's price scale settings with a priceScale. prefix (priceScale.lockPriceToBarRatio).

Properties

choices?

optional choices?: readonly ChartSettingChoice[]

Defined in: packages/core/src/chart-settings.ts:39

The values a select offers.

---

hint?

optional hint?: string

Defined in: packages/core/src/chart-settings.ts:37

Help text under the control.

---

kind

kind: ChartSettingKind

Defined in: packages/core/src/chart-settings.ts:35

---

label

label: string

Defined in: packages/core/src/chart-settings.ts:34

---

max?

optional max?: number

Defined in: packages/core/src/chart-settings.ts:41

---

min?

optional min?: number

Defined in: packages/core/src/chart-settings.ts:40

---

path

path: string

Defined in: packages/core/src/chart-settings.ts:33

---

plugin?

optional plugin?: string

Defined in: packages/core/src/chart-settings.ts:50

Show the field only on a chart with this plugin installed (its ChartPlugin.name), whose option it sets.

---

step?

optional step?: number

Defined in: packages/core/src/chart-settings.ts:42

---

unit?

optional unit?: string

Defined in: packages/core/src/chart-settings.ts:44

Shown after a slider's value, e.g. %.

---

unset?

optional unset?: { path: string; } | { value: unknown; }

Defined in: packages/core/src/chart-settings.ts:46

What the option means while it is not set: another setting's value, or a fixed value.

---

when?

optional when?: object

Defined in: packages/core/src/chart-settings.ts:48

Show the field only while the setting at path equals equals.

equals

equals: unknown

path

path: string