IChartTooltipProps

interface
Data Visualisation

Props for OrigamChartTooltip — the floating card that follows the cursor and shows the current data point. Extracted from the legacy OrigamChart so every chart family can share the same rendering and slot API. Position is driven by x/y pixel coordinates; no Popper.js dependency.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

point
required
IChartPoint | null
Hovered point payload (denormalised). When null the tooltip is hidden entirely.
series
required
IChartSeries | null
Hovered series reference. Companion to point. Hidden when null even if point is set.
category
required
string | number
Friendly category for the X axis — string for categorical axes, number otherwise.
x
required
number
Mouse X position relative to the chart body, in pixels.
y
required
number
Mouse Y position relative to the chart body, in pixels.
xAxisFormat
(value: string | number) => string
Formatter applied to the X value shown in the tooltip body. Defaults to String(value).
yAxisFormat
(value: number) => string
Formatter applied to the Y value shown in the tooltip body. Defaults to String(value).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Standalone OrigamChartTooltip usage

vue