Line Chart API
Complete API reference for the Line Chart, including data format, configuration options, custom parts, and context methods.
Data Format
Each dataset represents a line series with a legend name and an array of values corresponding to the labels.
type LineChartData = {
labels: string[];
datasets: { legend: string; values: number[] }[];
};AG Style Config
Line
| Property | Type | Default | Description |
|---|---|---|---|
| line.strokeWidth | number | 2 | Stroke width of the line in pixels. |
| line.spline | boolean | false | Whether to use spline (smooth curve) interpolation. |
Toast Style Config
Line
| Property | Type | Default | Description |
|---|---|---|---|
| line.strokeWidth | number | 2 | Stroke width of the line in pixels. |
| line.spline | boolean | false | Whether to use spline (smooth curve) interpolation. |
Custom Parts
Override any visual element by providing a custom builder function: (args, context) => Widget
| Part | Args | Description |
|---|---|---|
| line | { values: number[]; legend: string; index: number; isHovered: boolean } | The line path element for a single series. |
| xAxis | { line: Widget; labels: Widget[]; tick: Widget } | The complete x-axis assembly. |
| yAxis | { line: Widget; labels: Widget[]; tick: Widget } | The complete y-axis assembly. |
| xAxisLabel | { name: string; index: number } | Individual x-axis label. |
| yAxisLabel | { name: string; index: number } | Individual y-axis label. |
| xAxisTick | undefined | X-axis tick mark. |
| yAxisTick | undefined | Y-axis tick mark. |
| xAxisLine | undefined | X-axis line. |
| yAxisLine | undefined | Y-axis line. |
| axisCorner | undefined | Corner element where x and y axes meet. |
| dataView | { lines: Widget[] } | Container for all line widgets in the data area. |
| layout | { title: Widget; legends: Widget[]; plot: Widget } | Top-level layout composing title, legends, and the plot area. |
| plot | { xAxis: Widget; yAxis: Widget; dataView: Widget; grid: Widget; axisCorner: Widget; tooltipArea: Widget } | The plot area composing axes, data view, grid, and tooltip. |
| legend | { name: string; index: number; isVisible: boolean } | Individual legend item. |
| title | undefined | Chart title element. |
| dataLabel | { value: number; label: string; legend: string } | Data label displayed at a data point. |
| grid | { xLine: Widget; yLine: Widget } | Grid container for horizontal and vertical grid lines. |
| gridXLine | undefined | Individual vertical grid line. |
| gridYLine | undefined | Individual horizontal grid line. |
| tooltip | { label: string; items: { legend: string; color: string; value: number }[] } | Tooltip content widget. |
| tooltipArea | { tooltip: Widget | null; hoveredPoint: HoveredLinePoint | null } | Tooltip positioning area that manages tooltip display. |
Context: LineChartContext
Available in every custom builder via the second argument.
| Name | Type | Kind | Description |
|---|---|---|---|
| data | LineChartData | property | Current chart data (filtered by hidden series). |
| legends | string[] | property | All legend names from the raw data. |
| width | number | property | Current chart width in pixels. |
| height | number | property | Current chart height in pixels. |
| plotWidth | number | property | Width of the plot area in pixels. |
| plotHeight | number | property | Height of the plot area in pixels. |
| scale | LineChartScale | null | property | Computed scale with min, max, and step. |
| hiddenSeries | ReadonlySet<string> | property | Set of currently hidden series legend names. |
| hoveredPoint | { index: number; legend: string } | null | property | Currently hovered point info. |
| config | TConfig | property | The resolved chart configuration object. |
| isSeriesVisible(legend) | (legend: string) => boolean | method | Check if a series is currently visible. |
| toggleSeries(legend) | (legend: string) => void | method | Toggle visibility of a series. |
| showSeries(legend) | (legend: string) => void | method | Show a hidden series. |
| hideSeries(legend) | (legend: string) => void | method | Hide a visible series. |
| showAllSeries() | () => void | method | Show all hidden series. |
| hoverPoint(index, legend) | (index: number, legend: string) => void | method | Set hover state on a specific point. |
| unhoverPoint(index, legend) | (index: number, legend: string) => void | method | Clear hover if the specified point is currently hovered. |
| unhoverAllPoints() | () => void | method | Clear all point hover state. |
| isPointHovered(index, legend) | (index: number, legend: string) => boolean | method | Check if a specific point is hovered. |
| getPointValue(index, legend) | (index: number, legend: string) => number | null | method | Get the value of a data point. |
| getPointPosition(index, legend) | (index: number, legend: string) => { x: number; y: number } | null | method | Get the pixel position of a data point. |
| setSize(width, height) | (width: number, height: number) => void | method | Update chart dimensions. |
| setPlotSize(width, height) | (width: number, height: number) => void | method | Update plot area dimensions. |
Custom Part Example
import { ToastLineChart } from "@/components/flitter/charts/toast-line-chart";
<ToastLineChart
data={data}
custom={{
line: (args, context) => {
const color = context.config.colors[args.index % context.config.colors.length];
return CustomPaint({
painter: new LinePainter({
values: args.values,
color: args.isHovered ? color : `${color}66`,
strokeWidth: args.isHovered ? 3 : 2,
}),
});
},
}}
/>