@reincharts/tooltip

Functions

Functions exported by @reincharts/tooltip.

import { collectLegend, defaultHeader, formatChange, ... } from "@reincharts/tooltip";

collectLegend

Legend entries of a pane at a data index (like engine.legendItems, but keeping the renderables).

function collectLegend(
    engine: ChartEngine,
    paneId: string,
    index: number,
    o?: CollectOptions,
): LegendEntry[]

defaultHeader

Formatted x of a data point; numbers get a precision that suits their magnitude.

function defaultHeader(engine: ChartEngine, index: number): string

formatChange

Formats a change as "+1.23 (+0.52%)".

function formatChange(change: { value: number; percent: number; }, decimals?: number): string

sameEntries

Deep equality of legend entry lists (used to skip re-renders).

function sameEntries(a: readonly LegendEntry[], b: readonly LegendEntry[]): boolean

useLegend

Legend entries of a pane at the crosshair (or the last bar when there is no crosshair).

Types

Interfaces and type aliases exported by @reincharts/tooltip.

On this page

collectLegenddefaultHeaderformatChangesameEntries