---
id: "packages/active-charts/all-exports/box-plot-chart"
title: "BoxPlotChart"
description: "BoxPlotChart, BoxPlotChartProps, BoxPlotChartSeriesConfig: generated from the source of active-charts."
url: "/packages/active-charts/all-exports/box-plot-chart"
locale: "en"
revision: "g0mvjxwj5c-88bdbe1c:box-plot-chart"
---

# BoxPlotChart

Exported by `@workspace/active-charts`. Generated from the package source; part of [the index of every export](/packages/active-charts/all-exports).

## `BoxPlotChart`

| Prop | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | `TDatum[]` | yes | Flat array of row objects keyed by field name. |
| `height` | `number` | yes | Container height in pixels. Width is always responsive. |
| `xKey` | `Extract<keyof TDatum, string> \| XKeyFor<TDatum>` | yes |  |
| `accessibility` | `AccessibilityOptions` | no | Accessibility configuration — ARIA label/description, screen-reader data table, live-region announcements. Merged with ChartDefaults. |
| `animation` | `NoUpdateAnimationOption` | no | The entrance animation. No `update`: the series redraws on new data without a transition (LAB-AT10). |
| `annotations` | `AnnotationOptions[]` | no | Point annotations: a label with an optional connector and marker at a data coordinate, `xValue` on the x axis and `yValue` on the first value axis. The contract of `<Chart>`'s `options.annotations` (BC1). |
| `className` | `string` | no | Optional className applied to the outer container. |
| `colors` | `string[]` | no | Categorical palette for this chart only: replaces the host palette (`--chart-1` … `--chart-10`) in the chart's colour assignment, and nothing else. It is a data encoding, not a theme: surfaces, text, grid and semantic roles keep coming from the CSS token contract, and a series, datum or annotation that sets its own colour keeps it. Any CSS colour string (a public token reference such as `var(--chart-3)`, hex, oklch). |
| `contextMenu` | `FeatureOption<ChartContextMenuOptions<CartesianPoint<TDatum>, "copy" \| "export" \| "series" \| "zoom">>` | no | The context menu. Opened on a mark, the host's builder receives a typed {@link CartesianPoint} as `context.target.element` (the point the tooltip names, or the focused point); on empty plot area the target is the chart, on a legend entry the entry. Its own groups are copy, zoom, series and export; a Cartesian chart has no replay. |
| `crosshairs` | `boolean \| CrosshairOptions` | no | Enable crosshairs. Default: `false` for box plots. |
| `crossLines` | `CrossLineOptions[]` | no | Cross lines (reference lines/bands). |
| `defaultSelectedItems` | `readonly ChartItemRef[]` | no | The initial selection of an uncontrolled chart. |
| `dir` | `"ltr" \| "rtl"` | no | The chart's UI direction: the reading direction of its HTML text and chrome (tooltip, legend, menus, the accessible table), and the direction the context menu carries under `<body>`.  Left out, the chart inherits the direction of the page around it (the nearest `dir` attribute, else the computed CSS direction) and follows a later change of that attribute. It is never inferred from `locale`, and it never reverses an axis or reorders data: `reversed` stays an explicit axis choice. Under `rtl` the chrome mirrors (legend flow, tooltip side, context menu and submenus, report text in exports), a title-like label starts at the inline start, and a label placed by geometry (an axis tick, a slice or bar label) keeps its physical side; plot arrow keys stay spatial while legend and menu arrows follow the reading direction. |
| `events` | `(ChartEvents & ChartSelectionEvents<TDatum, ChartSeriesItem<TDatum>>)` | no | Every event callback in one prop, selection events included. |
| `fill` | `string` | no | Fill color for the IQR box. |
| `horizontal` | `boolean` | no | Horizontal layout (T4): categories on the y axis, values on x; the same statistics, min stays the low value. Default: false. |
| `legend` | `boolean \| LegendOptions` | no | Enable legend. Default: `false`. |
| `legendLink` | `ChartLegendLink` | no | Connects the chart's legend to `useChartLegend()`, for a legend the host renders itself. Give one link to one chart. |
| `locale` | `ValuePresentation` | no | Presentation input for axis labels, tooltips, labels and accessibility announcements: a locale code (notation follows the language), or a presentation-context object (`{languageLocale, dateShape?, dateFormat?, timeFormat?, numberFormat?, currencyDisplay?}`) carrying language and notation independently. `dateShape` is the normal human date shape a plain date consumer inherits; an axis that declares its own preset for readability keeps it. Forwarded untouched to the central `@workspace/active-format`; the package never resolves tenant or application settings itself. When omitted, `<ChartDefaults>` supplies it; with neither, the chart throws a configuration error (no `'en'` fallback, active-format D14). Object inputs must be referentially stable across renders. |
| `maxKey` | `string` | no | Key for maximum value (whisker high). |
| `medianKey` | `string` | no | Key for median. |
| `medianStroke` | `string` | no | Median line color. |
| `medianStrokeWidth` | `number` | no | Median line width. Default: 2. |
| `minKey` | `string` | no | Key for minimum value (whisker low). |
| `name` | `string` | no | Series display name. |
| `navigator` | `boolean \| NavigatorOptions` | no | Enable navigator mini-chart with brush. Default: `false`. |
| `onAnimationComplete` | `((event: AnimationCompleteEvent) => void)` | no | Fired when a chart animation completes. - `'load'`: initial mount animation finished (or immediately if animation disabled / prefers-reduced-motion is active). - `'update'`: data-update transition finished.  Not triggered by zoom animations (use `onZoomChange`) or tooltip fades. |
| `onExportComplete` | `((result: ChartExportResult) => void)` | no | Fired after a successful export action (PNG/SVG/CSV/PDF), including from the context menu and from imperative `ChartHandle` calls. |
| `onExportError` | `((format: ChartExportFormat, error: unknown) => void)` | no | Fired when an export could not produce its file (W11), from the handle as well as from the context menu. Without it a failed context-menu export is reported as an error diagnostic (`<ChartDefaults diagnostics>`). |
| `onItemActivate` | `((item: ChartSeriesItem<TDatum>, source: ChartInteractionSource) => void)` | no | Fired when the reader activates an item: a click or tap on it, or `Enter` on the focused item (`Shift+Enter` on a sankey, whose `Enter` moves between nodes and links). With a handler, `Enter` activates instead of opening the context menu (`Shift+F10` and the context-menu key still open it). |
| `onLegendChange` | `((change: ChartLegendChange) => void)` | no | Fired once for every legend change the chart applies: a hide, a show, an isolation or a show-all, from the built-in legend (click, key, double click, double tap), its menu, or `useChartLegend()`. The change names the entry and its target by identity and lists every hidden target after it. A refused action (the last visible target, `legend.interactive: false`) changes nothing and reports nothing. |
| `onReady` | `(() => void)` | no | Fired exactly once per chart instance, after the first successful mount with valid dimensions and **before** any entrance animation starts. "Ready" means: the SVG is in the DOM, layout has run with real dimensions, and the chart can be queried by integration tests.  Distinct from {@link onAnimationComplete} with `type: 'load'`, which fires *after* the load animation finishes. A chart with `animation={false}` still fires `onReady` — animation state has no effect on readiness.  A new React `key` on the host produces a new component instance and `onReady` fires again. Identity changes of the callback itself after the first fire are ignored (latch is per-instance).  **Consumer requirement — stable from first render.** The latch closes on the first effect run regardless of whether `onReady` was defined at that moment. If `onReady` is initially `undefined` and later resolves to a function, the callback will **never** fire — the latch has already closed with a no-op. Pass a stable reference (typically via `useCallback`) or pass the final function unconditionally from the first render. |
| `onSelectionChange` | `((selection: ChartItemRef[], change: ChartSelectionChange<TDatum, ChartSeriesItem<TDatum>>) => void)` | no | Fired when the reader changes the selection (pointer, touch or keyboard), and when an uncontrolled selection drops items the data no longer contains. `selection` is the complete selection the change makes; it keeps every reference the selection held, of whatever form. On a controlled chart it is a proposal (`change.requested: true`), computed from the current `selectedItems` and never from an earlier proposal; the host applies it, changes it or ignores it. |
| `onZoomChange` | `((startFraction: number, endFraction: number, yStartFraction?: number, yEndFraction?: number) => void)` | no | Fired when the zoom range changes (after animation completes). Fractions [0..1]. Y params are only provided when Y-zoom is active. Cartesian charts only. |
| `outlierRadius` | `number` | no | Outlier dot radius. Default: 3. |
| `outliersKey` | `string` | no | Optional key for outlier values (array of numbers per row). |
| `q1Key` | `string` | no | Key for first quartile (Q1). |
| `q3Key` | `string` | no | Key for third quartile (Q3). |
| `ref` | `Ref<ChartHandle>` | no | Imperative handle — see {@link ChartHandle}. Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). |
| `selectedItems` | `readonly ChartItemRef[]` | no | The selection, controlled by the host. The chart draws, announces and lists the items it resolves to and never changes it; the host updates it from `onSelectionChange`. A request the host applies is announced when the host passes it back; one it ignores is never announced. A reference to an item that is hidden, zoomed or drilled out of view, or not in the data stays in the host's selection and is not shown as selected. |
| `selection` | `FeatureOption<ChartSelectionOptions>` | no | Item selection. `true` = single selection keyed by the default key. |
| `series` | `BoxPlotChartSeriesConfig[]` | no | Several series, side by side in their category in this order; hiding one closes its gap (T4). |
| `stroke` | `string` | no | Stroke color for box outline and whiskers. |
| `strokeWidth` | `number` | no | Stroke width. Default: 1.5. |
| `sync` | `boolean \| ChartSyncOptions` | no | Synchronize with other charts in a SyncGroup. Default: `false`. |
| `t` | `ChartTranslateFn` | no | The host translator for every text the chart shows or announces. When omitted, `<ChartDefaults>` supplies it; with neither, the chart throws a configuration error (no English fallback, ADR-028). |
| `tooltip` | `SingleItemTooltipOption` | no | The tooltip of the addressed item, with every value it has. Mode 'single' only: the item has no single value for a shared or split row (LAB-AT6). |
| `width` | `number` | no | Optional fixed width in pixels. Default: fill container. |
| `widthRatio` | `number` | no | The box's width as a share of its category band (the band, not the step; T4-X3). Default: 0.5 for one series; several visible series stand side by side and the ratio sizes their group, default 0.8 (T4). |
| `xAxis` | `"category" \| NumericXAxis<string> \| TemporalXAxis<string, TemporalAxisType> \| (Omit<AxisConfig, "formatter" \| "temporalSemantic" \| "type"> & { formatter?: AxisFormatter<string> \| undefined; } & { type?: "category"; temporalSemantic?: never; })` | no |  |
| `yAxis` | `UprightValueAxisConfig` | no | Value-axis configuration: the y axis upright, the x axis when `horizontal`. |
| `zoom` | `boolean \| ZoomOptions` | no | Enable zoom & pan. Default: `false`. |

## Types

**BoxPlotChartProps**

```ts
type BoxPlotChartProps<TDatum extends ChartDatum = ChartDatum> =
  BoxPlotChartBaseProps<TDatum> &
    BoxPlotSeriesSource &
    BoxPlotOrientationProps &
    CartesianXKeyCategoryDefault<TDatum>;
```

Props for {@link BoxPlotChart}. Default xAxis is `'category'`:
box plots are overwhelmingly categorical (per-group distributions).
Discriminated union on `xAxis`, see {@link CartesianXKeyCategoryDefault}.

**BoxPlotChartSeriesConfig**

```ts
interface BoxPlotChartSeriesConfig {
  id?: string;
  minKey: string;
  q1Key: string;
  medianKey: string;
  q3Key: string;
  maxKey: string;
  outliersKey?: string;
  name?: string;
  fill?: string;
  stroke?: string;
  medianStroke?: string;
  visible?: boolean;
  showInLegend?: boolean;
}
```

One series of a {@link BoxPlotChart} with several (`series`, T4-D12):
its five statistics, its outliers, its identity and its colours. The
chart-level fields (stroke width, width ratio, median width, outlier
radius, orientation) hold for every series. Several visible series stand
side by side in their category, in this order (T4).