charton

Appearance

charton API

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

Interface: TimeBandOptions ​

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

Shades the full pane height between two bars, e.g. an earnings or news window.

Properties ​

color? ​

optional color?: string

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

Fill colour. Default: the theme's annotationFill.

from ​

from: number

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

Time of the first bar (unix seconds). A time between two bars lands on the bar that contains it.

label? ​

optional label?: string

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

Text at the top of the band.

labelColor? ​

optional labelColor?: string

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

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:27

Series whose pane the band shades. Default: the main series.

to? ​

optional to?: number

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

Time of the last bar. Omitted: the band covers the bar of from only.