Scatter chart

Points by two numbers, bubbles sized by area, groups, log axes, quadrants and trend lines; rows it can't place are counted. Same props on both engines.

Install

Pick one engine. Both builds take the same props, so switching later changes only the import path.

Recharts

npx shadcn@latest add https://beautifulcharts.dev/r/instrument-scatter-chart-recharts.json

import { ScatterChart } from "@/components/beautiful-charts/themes/instrument/recharts/scatter-chart";
npm dependencies: recharts@^3.10.1

Apache ECharts

npx shadcn@latest add https://beautifulcharts.dev/r/instrument-scatter-chart-echarts.json

import { ScatterChart } from "@/components/beautiful-charts/themes/instrument/echarts/scatter-chart";
npm dependencies: echarts@^6.1.0

Example

A complete client module. Paste it into your app after installing the Recharts build; for ECharts, change recharts to echarts in the import.

"use client";

import { ScatterChart } from "@/components/beautiful-charts/themes/instrument/recharts/scatter-chart";
import type { ChartConfig } from "@/components/beautiful-charts/core/contracts";

const data = [
  { team: "Atlas", cycle: 3.1, bugs: 4, size: 12 }, { team: "Beacon", cycle: 2.2, bugs: 2, size: 7 },
  { team: "Cobalt", cycle: 5.4, bugs: 11, size: 20 }, { team: "Drift", cycle: 2.8, bugs: 3, size: 9 },
  { team: "Ember", cycle: 4.0, bugs: 7, size: 15 }, { team: "Fjord", cycle: null, bugs: 1, size: 5 }, // not drawn, and counted
];

// Entries for the fields set labels and formats; bubbles are sized by area, so twice the people looks twice as big.
const config = {
  cycle: { label: "Cycle time", format: (days: number) => `${days} d` },
  bugs: { label: "Bugs" },
  size: { label: "People" },
} satisfies ChartConfig;

export function CycleTimeAndBugs() {
  return <ScatterChart data={data} xKey="cycle" yKey="bugs" sizeKey="size" nameKey="team" config={config} trend labelPoints="top" title="Longer cycles, more bugs" />;
}

Scatter chart props

Generated from ScatterChartProps in the installed source, so this table and your editor's hints always agree. * marks a required prop.

Scatter chart props
PropTypeDescription
xKey*keyof TDatum & stringThe field for the horizontal position (a number).
yKey*keyof TDatum & stringThe field for the vertical position (a number).
sizeKeykeyof TDatum & stringA field that sizes each point by area, making a bubble chart.
groupKeykeyof TDatum & stringA field that sorts points into coloured groups. Group names are the keys of config.
nameKeykeyof TDatum & stringA field naming each point, for tooltips, the table and labels.
labelPointsstring[] | "top"Label these points on the chart (by name), or the largest few ("top").
xScale"linear" | "log""linear" (default) or "log" (powers of ten).
yScale"linear" | "log""linear" (default) or "log" (powers of ten).
trendbooleanDraw a least-squares trend line per group (or for all points without groups).
quadrants{ x: number; y: number; labels?: [string, string, string, string] }Split the plot into quadrants at these values, with optional labels (top-left, top-right, bottom-left, bottom-right).
maxRadiusnumberLargest bubble radius in px (default 22).
radiusnumberPoint radius when there's no sizeKey, in px (default 4.5).
gridbooleanDraw grid lines behind the plot. On by default.
xAxisAxisOptionsHorizontal axis: hide it, format ticks, or add a label (defaults to the x field's label).
yAxisAxisOptionsVertical axis: hide it, format ticks, or add a label (defaults to the y field's label).

Recharts build only

Native Recharts children render inside the chart with your original rows, so ReferenceArea, Label or a custom Customized layer work as they do in any Recharts chart.

Recharts build props
PropTypeDescription
childrenReactNodeRecharts children render inside the same ScatterChart, which receives your original rows.

Apache ECharts build only

Escape hatches into the engine. Your option is deep-merged over the generated one, so you can change one nested setting without replacing a whole section.

Apache ECharts build props
PropTypeDescription
rendererEChartsRenderer"canvas" (default, best for many points) or "svg".
optionOptionOverrideDeep-merged over the generated option, or (generated) => option. Points are custom series "points" (one item per point); trend lines are "trends".

Series config

One entry per series key in config. shadcn's ChartConfig entries work as they are. Give a series at most one of color, theme or colors; TypeScript rejects more than one. This table lists only the options this chart reads.

Scatter chart series config
PropTypeDescription
labelReactNodeName shown in the legend, tooltip and table. Defaults to the key, humanised.
ariaLabelstringPlain text for tables, summaries and announcements when label is not a string.
iconComponentType<{ className?: string }>An icon component (e.g. from lucide-react) shown in place of the swatch in the legend and tooltip.
format(value: number) => stringFormats this series' values everywhere: tooltip, legend, table, readout.
colorColorValueOne colour: any CSS colour or var(--chart-1), or { light, dark }.
themenevershadcn's per-theme colours, { light, dark }.
colorsneverGradient stops from base to value end, per theme. The last stop is the series' single colour.

Events

Every callback, and the payload types it receives. Indexes always point into the data you passed, even when a brush or grouping shows a subset.

Scatter chart events
PropTypeDescription
onSelectedChange(selection: Selection<TDatum> | null) => voidCalled when a row is selected or cleared, by pointer, keyboard or the data table.
onSelectedSeriesChange(key: string | null) => voidCalled when the selected series changes (legend "select" action, or a click on a series).
onHiddenChange(hidden: string[]) => voidCalled when the legend hides or shows a series.
onActiveChange(index: number | null) => voidCalled as the hovered or focused row changes, or null when it leaves.
onReady(chart: EChartsType) => voidCalled once with the ECharts instance, e.g. to add event listeners.
export type Selection<TDatum> = {
  /** Index into the data you passed in, even when a brush shows a subset. */
  dataIndex: number;
  datum: TDatum;
  seriesKey: string | null;
  source: "pointer" | "keyboard" | "table";
  /** For a grouped segment (a donut's "Other"): the indexes of every row it stands for. `dataIndex` is the largest. */
  members?: number[] | undefined;
};

export type TooltipContext<TDatum> = {
  datum: TDatum;
  /** Index into the data you passed in. */
  dataIndex: number;
  /** Visible series at this index. `value` is your raw value; `share` is its part of the row in 100% mode. */
  series: { key: string; label: ReactNode; value: number | null; share?: number | null | undefined; color: string; selected: boolean }[];
};

Parts and styling hooks

Each part carries a data-slot attribute. Theme rules inside the chart are one attribute selector deep, so a selector such as .my-chart [data-slot="chart-title"] overrides them. These are the slots in the files this chart installs; parts a chart doesn't use are simply absent from its markup.

chartchart-bodychart-descriptionchart-eyebrowchart-footerchart-headerchart-headingchart-legendchart-legend-itemchart-legend-labelchart-legend-swatchchart-legend-valuechart-livechart-mainchart-plotchart-readoutchart-statchart-stat-notechart-stat-valuechart-statechart-state-boxchart-state-messagechart-statschart-tablechart-table-scrollchart-takeawaychart-titlechart-tooltipodometerodometer-digitodometer-glyphsodometer-reelodometer-signpartial-notereadout-deltareadout-unitreadout-valuesr-onlytooltip-indicatortooltip-rowtooltip-titletooltip-value

Props every chart shares

Header, states, legend, tooltip, formatting, motion, sound and controlled interaction state. They work the same on every Instrument chart and both engines. The guide explains colours, controlled state and accessibility.

Show all 34 shared props
Props every chart shares
PropTypeDescription
data*TDatum[]Your rows, as they are. Missing values (null, undefined, NaN) stay missing and are never drawn as zero.
localestringBCP 47 locale. Defaults to "en-US" so server and client render the same text.
timeZonestringIANA time zone for dates. Defaults to "UTC" so server and client agree.
configChartConfigPer-series label, colour, icon, format and style, keyed by series key. shadcn ChartConfig works as it is.
eyebrowReactNodeSmall label above the title.
titleReactNodeCard title. A string also names the chart for screen readers.
descriptionReactNodeA line under the title.
takeawayReactNode | ((summary: string) => ReactNode) | falseThe sentence under the title. Computed from the data by default; pass text, a function of the computed sentence, or false to hide it.
ariaDescriptionstringAccessible summary for screen readers. Computed from the data by default.
motionMotionPreference"full" (default), "subtle" or "off". Reduced-motion settings always win.
motionOptionsMotionOptionsWhen the entrance plays.
soundbooleanSound cues on hover, scrub and select. Plays only if the visitor has also turned sound on for the page.
densityDensity"comfortable" (default) or "compact" for dashboards.
legendLegendOptions | falseLegend position, alignment, shape and click action, or false to hide it.
tooltipTooltipOptions<TDatum> | falseTooltip position, indicator, cursor and custom content, or false to turn it off.
valueFormatter(value: number) => stringValues formatted for display. Series formatters in config win.
loadingbooleanShow the loading state. Over existing data, the old marks stay dimmed instead of vanishing.
errorstring | nullAn error message. Shows the error state in place of the plot.
emptyStateReactNodeShown instead of the plot when there is no data.
loadingStateReactNodeShown while loading is true and there is no data yet.
errorStateReactNodeShown when error is set.
selectednumber | nullControlled and uncontrolled interaction state. Point selection (selected) pins one row by its index in data. Series selection (selectedSeries) picks one series and dims the others. They are separate: picking a row doesn't pick a series.
defaultSelectednumber | nullInitial selected row when uncontrolled.
selectedSeriesstring | nullControlled series selection: this series stays lit and the others dim.
defaultSelectedSeriesstring | nullInitial series selection when uncontrolled.
hiddenstring[]Controlled hidden series keys.
defaultHiddenstring[]Series hidden at first when uncontrolled.
activeIndexnumber | nullControlled hover or focus index, for syncing several charts on one cursor.
palette"theme" | "shadcn"Series colours: "theme" (default) uses the theme's designed palette; "shadcn" uses your --chart-1..5. --bc-series-N always wins. You can also opt a whole section in with the class bc-use-shadcn-colors.
tablebooleanShow the "Show data table" disclosure. On by default.
statsChartStat[]A row of figures under the title, for dashboard cards and blocks.
classNamestringClasses on the card, for spacing and layout.
heightnumberHeight of the plot area in px. The frame sizes around it.