Documentation / @finchart/core / index / DataProbe

Interface: DataProbe

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

Asks what each series is drawing under the cursor.

The channel tooltip and legend use to get values, and it's read-only — asking for only this gets you neither the ability to remove a series nor to push the value axis around.

Consumers: legend, tooltip

Extended by

• Pane

Methods

probe()

probe(x): SeriesSample[]

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

Parameters

x

number

Returns

SeriesSample[]

---

xRange()

xRange(): Range | null

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

The x range of the points being drawn. null if empty — legend's "last value" uses this.

Returns

Range | null