Skip to content

Documentation / @finchart/core / index / DecorationHost

Interface: DecorationHost ​

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

Can mount a decoration on the whole chart. This is where anything that doesn't use the value axis goes.

If y is needed, get a pane through PaneHost and use pane.addDecoration instead — Plot owns x, Pane owns y.

Consumers: crosshair

Methods ​

addDecoration() ​

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

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

Parameters ​

decoration ​

PlotDecoration

options? ​

DecorationOptions

Returns ​

() => void