Documentation / @ripl/charts / LineChartOptions
Interface: LineChartOptions<TData>
Defined in: charts/src/charts/line.ts:116
Options for configuring a LineChart.
Extends
CartesianChartOptions<TData>
Type Parameters
| Type Parameter | Default type |
|---|---|
TData | unknown |
Properties
| Property | Type | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|
animation? | boolean | Partial<ChartAnimationOptions> | Animation configuration, or a boolean toggling all transitions. See ChartAnimationOptions. | - | CartesianChartOptions.animation | charts/src/core/chart.ts:89 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | - | CartesianChartOptions.autoRender | charts/src/core/chart.ts:83 |
axis? | ChartAxisInput<TData> | Axis configuration for the x and y axes. | CartesianChartOptions.axis | - | charts/src/charts/line.ts:132 |
crosshair? | ChartCrosshairInput | Crosshair overlay configuration (true/false or detailed crosshair options). | CartesianChartOptions.crosshair | - | charts/src/charts/line.ts:126 |
data | TData[] | The dataset rendered by the chart. | - | - | charts/src/charts/line.ts:118 |
format? | ValueFormatInput | Format applied to marker values shown as text (tooltips and labels). | - | - | charts/src/charts/line.ts:136 |
grid? | ChartGridInput | Background grid configuration (true/false or detailed grid options). | CartesianChartOptions.grid | - | charts/src/charts/line.ts:124 |
key | keyof TData | ((item) => string) | Accessor for each item's category key (the value plotted along the x axis). | - | - | charts/src/charts/line.ts:122 |
labels? | ChartDataLabelsInput | Show value labels next to each marker. true uses the default anchor; a string sets the anchor side. | - | - | charts/src/charts/line.ts:134 |
legend? | ChartLegendInput | Legend configuration (true/false, a position, or detailed legend options). | CartesianChartOptions.legend | - | charts/src/charts/line.ts:130 |
navigator? | boolean | NavigatorInteractions | Enables pan/zoom (and optionally brush) navigation on the plot. true turns on wheel-zoom and click-drag pan; an object configures each interaction individually. The chart auto-creates a DOMNavigator on its context and rescales the axis domains as the view changes — no data rebuild. Access the underlying controller via chart.navigator for imperative framing (centerOn/fitBounds) or brush-and-link. | - | CartesianChartOptions.navigator | charts/src/core/cartesian.ts:137 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | - | CartesianChartOptions.padding | charts/src/core/chart.ts:85 |
series | LineChartSeriesOptions<TData>[] | The series to draw from each data item. | - | - | charts/src/charts/line.ts:120 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | - | CartesianChartOptions.title | charts/src/core/chart.ts:87 |
tooltip? | ChartTooltipInput | Hover tooltip configuration (true/false or detailed tooltip options). | CartesianChartOptions.tooltip | - | charts/src/charts/line.ts:128 |