UNPKG

@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.

31 lines (30 loc) 2.1 kB
import type { Channel, CartesianChartMark, CartesianScaleBindings, ChartKey, ChartMark, ChartMarkMotionOptions, ChartMarkState, ChartAreaStateStyle, ChartValue, MarkCallOptions, MarkChannelOutput, MarkScaleBindings, VisualChannel } from './types.js'; import type { StackLayout } from './stack.js'; export interface AreaXCurve { areaX: (right: readonly (readonly [number, number])[], left: readonly (readonly [number, number])[]) => string; } export interface AreaXOptions<TDatum> extends ChartMarkMotionOptions<TDatum>, CartesianScaleBindings { id?: string; x?: Channel<TDatum, number | null | undefined>; x1?: number | Channel<TDatum, number | null | undefined>; x2?: number | Channel<TDatum, number | null | undefined>; y?: Channel<TDatum, ChartValue | null | undefined>; z?: Channel<TDatum, ChartKey | null | undefined>; color?: Channel<TDatum, ChartKey | null | undefined>; key?: Channel<TDatum, ChartKey>; fill?: VisualChannel<TDatum, string>; fillOpacity?: number; stroke?: VisualChannel<TDatum, string>; strokeWidth?: number; curve?: AreaXCurve; layout?: StackLayout; states?: readonly ChartMarkState<TDatum, ChartAreaStateStyle<TDatum>>[]; } type AreaXCallOptions<TDatum, TYChannel, TXScaleId extends string | undefined, TYScaleId extends string | undefined> = MarkCallOptions<AreaXOptions<NoInfer<TDatum>>, { y?: TYChannel; xScale?: TXScaleId; yScale?: TYScaleId; }>; export declare function areaX<TDatum>(source: Iterable<TDatum>): ChartMark<TDatum, number, number>; export declare function areaX<TDatum, const TYChannel extends Channel<NoInfer<TDatum>, ChartValue | null | undefined> | undefined = never, const TXScaleId extends string | undefined = undefined, const TYScaleId extends string | undefined = undefined>(source: Iterable<TDatum>, options: AreaXCallOptions<TDatum, TYChannel, TXScaleId, TYScaleId> | undefined): CartesianChartMark<TDatum, number, MarkChannelOutput<TDatum, TYChannel, number>, number, MarkChannelOutput<TDatum, TYChannel, number>, MarkScaleBindings<TXScaleId, TYScaleId>>; export {};