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

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

point
requis
IChartPoint | null
Hovered point payload (denormalised). When null the tooltip is hidden entirely.
series
requis
IChartSeries | null
Hovered series reference. Companion to point. Hidden when null even if point is set.
category
requis
string | number
Friendly category for the X axis — string for categorical axes, number otherwise.
x
requis
number
Mouse X position relative to the chart body, in pixels.
y
requis
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).

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Standalone OrigamChartTooltip usage

vue