Documentation / @finchart/core / index / OverlayHost

Interface: OverlayHost

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

Can mount onto the overlay. The core doesn't know what the overlay is — it just hands back whatever the layers supplied (ChartLayers.overlay). null on a headless chart.

An extension that requires the overlay narrows it at the door (requireOverlayElement) — otherwise it throws as a wiring error. This isn't a place to silently do nothing.

Consumers: legend, tooltip

Properties

overlay

readonly overlay: unknown

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