Skip to content

charton API


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

Interface: ReferenceLineOptions ​

Defined in: packages/core/src/reference-lines.ts:24

Look of one reference line: visibility, colour, stroke, axis label and tag.

Extended by ​

Properties ​

axisLabel ​

axisLabel: boolean

Defined in: packages/core/src/reference-lines.ts:32

Price label on the price axis.


color? ​

optional color?: string

Defined in: packages/core/src/reference-lines.ts:28

Line and label colour; defaults to the line's theme token (pass undefined to return to it).


lineStyle ​

lineStyle: LineStyle

Defined in: packages/core/src/reference-lines.ts:29


lineWidth ​

lineWidth: number

Defined in: packages/core/src/reference-lines.ts:30


title ​

title: string

Defined in: packages/core/src/reference-lines.ts:34

Short tag beside the axis label; empty for none.


visible ​

visible: boolean

Defined in: packages/core/src/reference-lines.ts:26

Draw the line (and its label). Every reference line is off by default.