@finchart

Appearance

Documentation / @finchart/core / index / PaneDecorationContext

Interface: PaneDecorationContext ​

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

What a pane-registered decoration receives.

Needing y is what makes it pane-scoped — Plot owns x, and Pane owns y. So here, both yScale and pane are guaranteed to be present.

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

formatY ​

formatY: ValueFormat

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

The resolved y formatting — sugar over pane.formatValue.

pane ​

pane: Pane

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

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

Already-computed ticks. y belongs to this pane.

x ​

x: Tick[]

y ​

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

yScale ​

yScale: Scale

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