@tanstack/charts
Version:
A chart grammar for TypeScript and JavaScript. Marks consume your data directly, channels describe visual encodings, and the engine compiles them into a renderer-neutral keyed scene. TanStack's compact scales cover common numeric and categorical mappings.
11 lines (10 loc) • 1.71 kB
TypeScript
import type { ChartFocusState, ChartPoint, ChartScene, ChartTooltipContent, ChartTooltipOptions, ChartTooltipPosition, ChartValue } from './types.js';
export { resolveChartTooltipPlacement } from './tooltip-placement.js';
export type { TooltipBounds, TooltipSize } from './tooltip-placement.js';
/** Orders focused points for host tooltip presentation. */
export declare function orderChartTooltipPoints<TDatum, TXValue extends ChartValue, TYValue extends ChartValue>(points: readonly ChartPoint<TDatum, TXValue, TYValue>[], scene: ChartScene<TDatum, TXValue, TYValue>, sort: ChartTooltipOptions<TDatum, TXValue, TYValue>['sort']): ChartPoint<TDatum, TXValue, TYValue>[];
/** Resolves authored formatting and the built-in structured tooltip model. */
export declare function createChartTooltipContent<TDatum, TXValue extends ChartValue, TYValue extends ChartValue>(points: readonly ChartPoint<TDatum, TXValue, TYValue>[], scene: ChartScene<TDatum, TXValue, TYValue>, pinned?: boolean, options?: ChartTooltipOptions<TDatum, TXValue, TYValue>, primaryPoint?: ChartPoint<TDatum, TXValue, TYValue>): ChartTooltipContent | string;
/** Resolves a scene-space anchor identically for every tooltip host. */
export declare function resolveChartTooltipAnchor<TDatum, TXValue extends ChartValue, TYValue extends ChartValue>(point: ChartPoint<TDatum, TXValue, TYValue>, points: readonly ChartPoint<TDatum, TXValue, TYValue>[], scene: ChartScene<TDatum, TXValue, TYValue>, pointer: ChartTooltipPosition | null, options?: ChartTooltipOptions<TDatum, TXValue, TYValue>, focus?: ChartFocusState<TDatum, TXValue, TYValue>): ChartTooltipPosition;
export declare function formatChartTooltipValue(value: ChartValue): string;