@finchart

Appearance

Documentation / @finchart/core / index / PlotDecorationContext

Interface: PlotDecorationContext ​

Defined in: packages/core/src/plot/decoration.ts:78

What a plot-registered decoration receives.

No y ticks, no value axis — those differ per pane. Iterate panes if you need them.

Extends ​

  • DecorationBase

Properties ​

area ​

area: PlotArea

Defined in: packages/core/src/plot/decoration.ts:44

The drawable area. A pane-registered decoration gets that pane's slice; a plot-registered one gets the entire data area. The axis slice belongs to neither — anything meant for the axis is described, not drawn.

Inherited from ​

DecorationBase.area

formatX ​

formatX: ValueFormat

Defined in: packages/core/src/plot/decoration.ts:54

The resolved x formatting — config.axis.x.format, else the tick strategy's own, else a rounded integer. The axis owns formatting; a decoration falls back to this only when it has no option of its own.

Inherited from ​

DecorationBase.formatX

panes ​

panes: readonly Pane[]

Defined in: packages/core/src/plot/decoration.ts:79

readStyle ​

readStyle: StyleReader

Defined in: packages/core/src/plot/decoration.ts:48

Built once per render and shared by everyone.

Inherited from ​

DecorationBase.readStyle

ticks ​

ticks: object

Defined in: packages/core/src/plot/decoration.ts:81

x is shared by every pane, so there's just one set.

x ​

x: Tick[]

x ​

x: XMapping

Defined in: packages/core/src/plot/decoration.ts:46

Where a point's x lands on screen. The same mapping a series sees.

Inherited from ​

DecorationBase.x