Skip to content
EliteChart

AxisAnnotation

Documentation

Documentation / @elitechart/core / AxisAnnotation

Defined in: renderer/axis-annotation.ts:47

One pill on the right price gutter. Pass to chart.addAxisAnnotation(...).

Example

code
chart.addAxisAnnotation({
  id: 'tp-1', price: asPrice(68_000),
  label: 'TP 68k', tone: 'up', emphasis: 'bold',
});

Properties

emphasis?

code
readonly optional emphasis?: AxisAnnotationEmphasis;

Defined in: renderer/axis-annotation.ts:57

Emphasis — bold (default) is filled; subtle is outlined.

id

code
readonly id: string;

Defined in: renderer/axis-annotation.ts:49

Stable id so consumers can update / remove individual entries.

label

code
readonly label: string;

Defined in: renderer/axis-annotation.ts:53

What text the pill shows.

price

code
readonly price: Price;

Defined in: renderer/axis-annotation.ts:51

Where the pill anchors on the price axis.

tone?

code
readonly optional tone?: AxisAnnotationTone;

Defined in: renderer/axis-annotation.ts:55

Tone — picks the colour per palette below. Defaults to accent.