Documentation / @ripl/charts / CartesianChartOptions
Interface: CartesianChartOptions<TData>
Defined in: charts/src/core/cartesian.ts:119
Options shared by all cartesian charts.
Extends
Extended by
AreaChartOptionsBarChartOptionsBoxPlotChartOptionsHistogramChartOptionsLineChartOptionsScatterChartOptions
Type Parameters
| Type Parameter | Default type |
|---|---|
TData | unknown |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
animation? | boolean | Partial<ChartAnimationOptions> | Animation configuration, or a boolean toggling all transitions. See ChartAnimationOptions. | BaseChartOptions.animation | charts/src/core/chart.ts:89 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:83 |
axis? | ChartAxisInput<TData> | X/y axis configuration, or a boolean toggling both axes. See ChartAxisInput. | - | charts/src/core/cartesian.ts:121 |
crosshair? | ChartCrosshairInput | Crosshair configuration, or a boolean toggle. See ChartCrosshairInput. | - | charts/src/core/cartesian.ts:129 |
grid? | ChartGridInput | Background grid configuration, or a boolean toggle. See ChartGridInput. | - | charts/src/core/cartesian.ts:123 |
legend? | ChartLegendInput | Legend configuration, a position string, or a boolean toggle. See ChartLegendInput. | - | charts/src/core/cartesian.ts:127 |
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. | - | charts/src/core/cartesian.ts:137 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | BaseChartOptions.padding | charts/src/core/chart.ts:85 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:87 |
tooltip? | ChartTooltipInput | Hover-tooltip configuration, or a boolean toggle. See ChartTooltipInput. | - | charts/src/core/cartesian.ts:125 |