@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.
28 lines (27 loc) • 1.93 kB
TypeScript
import type { Channel, CartesianChartMark, CartesianScaleBindings, ChartKey, ChartMark, ChartMarkMotionOptions, ChartMarkState, ChartLineStateStyle, ChartValue, ChartCurve, VisualChannel, OptionChannelOutput } from './types.js';
interface LineOptions<TDatum> extends ChartMarkMotionOptions<TDatum>, CartesianScaleBindings {
id?: string;
z?: Channel<TDatum, ChartKey | null | undefined>;
color?: Channel<TDatum, ChartKey | null | undefined>;
key?: Channel<TDatum, ChartKey>;
stroke?: VisualChannel<TDatum, string>;
strokeOpacity?: number;
strokeWidth?: number;
strokeDasharray?: string;
points?: boolean;
curve?: ChartCurve;
states?: readonly ChartMarkState<TDatum, ChartLineStateStyle<TDatum>>[];
}
export interface LineYOptions<TDatum> extends LineOptions<TDatum> {
x?: Channel<TDatum, ChartValue | null | undefined>;
y?: Channel<TDatum, number | null | undefined>;
}
export interface LineXOptions<TDatum> extends LineOptions<TDatum> {
x?: Channel<TDatum, number | null | undefined>;
y?: Channel<TDatum, ChartValue | null | undefined>;
}
export declare function lineY<TDatum>(source: Iterable<TDatum>): ChartMark<TDatum, number, number>;
export declare function lineY<TDatum, const TOptions extends LineYOptions<NoInfer<TDatum>> | undefined>(source: Iterable<TDatum>, options: TOptions): CartesianChartMark<TDatum, OptionChannelOutput<TDatum, TOptions, 'x', number>, number, OptionChannelOutput<TDatum, TOptions, 'x', number>, number, TOptions>;
export declare function lineX<TDatum>(source: Iterable<TDatum>): ChartMark<TDatum, number, number>;
export declare function lineX<TDatum, const TOptions extends LineXOptions<NoInfer<TDatum>> | undefined>(source: Iterable<TDatum>, options: TOptions): CartesianChartMark<TDatum, number, OptionChannelOutput<TDatum, TOptions, 'y', number>, number, OptionChannelOutput<TDatum, TOptions, 'y', number>, TOptions>;
export {};