Skip to content

Documentation / @finchart/core / index / PaneDecorationHost

Interface: PaneDecorationHost ​

Defined in: packages/core/src/plot/capabilities.ts:282

Can mount a decoration on this pane. This is where anything that uses the value axis goes.

DecorationHost is the chart-wide counterpart — the two aren't merged into one because of context: a pane decoration is guaranteed a yScale, and a plot decoration is not.

Consumers: @finchart/tools

Extended by ​

Methods ​

addDecoration() ​

addDecoration(decoration, options?): () => void

Defined in: packages/core/src/plot/capabilities.ts:283

Parameters ​

decoration ​

PaneDecoration

options? ​

DecorationOptions

Returns ​

() => void