Documentation / @ripl/charts / ScatterChartOptions
Interface: ScatterChartOptions<TData>
Defined in: charts/src/charts/scatter.ts:98
Options for configuring a ScatterChart.
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 (labels, ticks, titles). | CartesianChartOptions.axis | - | charts/src/charts/scatter.ts:114 |
crosshair? | ChartCrosshairInput | Crosshair overlay configuration. | CartesianChartOptions.crosshair | - | charts/src/charts/scatter.ts:108 |
data | TData[] | The dataset plotted across all series. | - | - | charts/src/charts/scatter.ts:100 |
format? | ValueFormatInput | Format applied to bubble values shown as text (tooltips and labels). | - | - | charts/src/charts/scatter.ts:118 |
grid? | ChartGridInput | Background grid line configuration. | CartesianChartOptions.grid | - | charts/src/charts/scatter.ts:106 |
key | keyof TData | ((item) => string) | Accessor for each item's unique key, used to match bubbles across data updates. | - | - | charts/src/charts/scatter.ts:104 |
labels? | ChartDataLabelsInput | Show value labels next to each bubble. true uses the default anchor; a string sets the anchor side. | - | - | charts/src/charts/scatter.ts:116 |
legend? | ChartLegendInput | Series legend configuration. | CartesianChartOptions.legend | - | charts/src/charts/scatter.ts:112 |
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 | ScatterChartSeriesOptions<TData>[] | The series to render, each mapping the data to x/y (and optional size) positions. | - | - | charts/src/charts/scatter.ts:102 |
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. | CartesianChartOptions.tooltip | - | charts/src/charts/scatter.ts:110 |