charton

Appearance

charton API

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

Interface: PriceZoneOptions ​

Defined in: packages/core/src/annotations/zones.ts:31

Shades a horizontal band between two prices, e.g. a supply or demand zone.

Properties ​

axisLabel ​

axisLabel: boolean

Defined in: packages/core/src/annotations/zones.ts:51

Show both edge prices on the price axis, in the zone colour made opaque. Default false.

color? ​

optional color?: string

Defined in: packages/core/src/annotations/zones.ts:45

Fill colour. Default: the theme's annotationFill.

from ​

from: number

Defined in: packages/core/src/annotations/zones.ts:33

One edge of the zone.

fromTime? ​

optional fromTime?: number

Defined in: packages/core/src/annotations/zones.ts:37

Start the zone at this bar instead of the left edge of the pane.

label? ​

optional label?: string

Defined in: packages/core/src/annotations/zones.ts:47

Text in the top-left corner of the zone.

labelColor? ​

optional labelColor?: string

Defined in: packages/core/src/annotations/zones.ts:49

Colour of the label text. Default: the theme's muted text colour.

series? ​

optional series?: Series<object>

Defined in: packages/core/src/annotations/zones.ts:53

Series whose price scale and pane the zone follows. Default: the main series.

to ​

to: number

Defined in: packages/core/src/annotations/zones.ts:35

The other edge; either may be the higher one.

toTime? ​

optional toTime?: number

Defined in: packages/core/src/annotations/zones.ts:43

End the zone at this bar instead of the right edge of the pane. On the main pane its prices then draw adjusted like this bar's under the chart's adjustment option; zones reaching the latest bar keep their prices.