Skip to content

Documentation / @ripl/charts / CartesianChartOptions

Interface: CartesianChartOptions<TData>

Defined in: charts/src/core/cartesian.ts:119

Options shared by all cartesian charts.

Extends

Extended by

Type Parameters

Type ParameterDefault type
TDataunknown

Properties

PropertyTypeDescriptionInherited fromDefined in
animation?boolean | Partial<ChartAnimationOptions>Animation configuration, or a boolean toggling all transitions. See ChartAnimationOptions.BaseChartOptions.animationcharts/src/core/chart.ts:89
autoRender?booleanWhether the chart renders automatically on construction and after every Chart.update. Defaults to true.BaseChartOptions.autoRendercharts/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?ChartCrosshairInputCrosshair configuration, or a boolean toggle. See ChartCrosshairInput.-charts/src/core/cartesian.ts:129
grid?ChartGridInputBackground grid configuration, or a boolean toggle. See ChartGridInput.-charts/src/core/cartesian.ts:123
legend?ChartLegendInputLegend configuration, a position string, or a boolean toggle. See ChartLegendInput.-charts/src/core/cartesian.ts:127
navigator?boolean | NavigatorInteractionsEnables 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.paddingcharts/src/core/chart.ts:85
title?string | Partial<ChartTitleOptions>Chart title as plain text, or a ChartTitleOptions object for full control.BaseChartOptions.titlecharts/src/core/chart.ts:87
tooltip?ChartTooltipInputHover-tooltip configuration, or a boolean toggle. See ChartTooltipInput.-charts/src/core/cartesian.ts:125