WindRoseChart
Read a field, a geometry or a spectrum, with the scale handled for you.
@luc/ui/chartsWhat it shows
Show directional frequency or magnitude as a stacked polar histogram, with speed bins supplied by the caller.
Live preview
A stacked polar histogram: each sector's rings are speed bins the caller already binned.
<WindRoseChart
directions={["N", "NE", "E", "SE", "S", "SW", "W", "NW"]}
series={[
{ label: "< 5 m/s", tone: "neutral", values: [6, 8, 11, 14, 12, 9, 7, 5] },
{ label: "5–10 m/s", tone: "accent", values: [4, 6, 9, 12, 10, 7, 5, 3] },
{ label: "> 10 m/s", tone: "info", values: [2, 3, 4, 5, 4, 3, 2, 1] },
]}
format={{ kind: "integer" }}
height={340}
ariaLabel="Speed by direction"
/>Controls
Height
A chart measures its container, so it always needs a definite height.
State
The surface the chart is in — loading, empty and error are drawn by the component.
Accessible name
A drawing is not readable by a screen reader, so it needs a name that states what it shows.
The same fixture as the live preview above; the controls change how it is drawn, not what it measures.
Code
import { WindRoseChart } from "@luc/ui/charts";
<WindRoseChart
directions={["N", "NE", "E", "SE", "S", "SW", "W", "NW"]}
series={[
{ label: "< 5 m/s", tone: "neutral", values: [6, 8, 11, 14, 12, 9, 7, 5] },
{ label: "5–10 m/s", tone: "accent", values: [4, 6, 9, 12, 10, 7, 5, 3] },
{ label: "> 10 m/s", tone: "info", values: [2, 3, 4, 5, 4, 3, 2, 1] },
]}
format={{ kind: "integer" }}
height={340}
ariaLabel="Speed by direction"
state="ready"
/>Not controllable here
series / rows— The numbers are the caller's; the fixture above is the example.
Copy for an AI agentA specification an agent can act on: the import, the setup, the chosen props, the data contract and the accessibility expectation.
Implement `WindRoseChart` from Luc UI. It is: Read a field, a geometry or a spectrum, with the scale handled for you.
Import it with: import { WindRoseChart } from "@luc/ui/charts";
Requires: react ^19.0.0; react-dom ^19.0.0; react-hook-form ^7.0.0 (optional, for @luc/ui/forms/react-hook-form); tailwindcss ^4.0.0; node >= 22 (repository tools). Import the stylesheet once at the app root and wrap the tree in `LucProvider`. Both come from the package that publishes @luc.
Chosen configuration: `height={340}`, `state="ready"`, `ariaLabel="Speed by direction"`.
Accessibility: keep the component's own semantics. Do not re-implement its ARIA wiring, do not add roles it does not declare, and make sure every interactive element is reachable and operable from the keyboard with a visible focus state.
Styling: use Luc UI design tokens and the component's own props. Do not restyle with raw colour literals and do not override the component's internal structure with page CSS.
Motion: respect `prefers-reduced-motion`. The component already does, so do not disable it.
Reproduce this state:
```tsx
<WindRoseChart
directions={["N", "NE", "E", "SE", "S", "SW", "W", "NW"]}
series={[
{ label: "< 5 m/s", tone: "neutral", values: [6, 8, 11, 14, 12, 9, 7, 5] },
{ label: "5–10 m/s", tone: "accent", values: [4, 6, 9, 12, 10, 7, 5, 3] },
{ label: "> 10 m/s", tone: "info", values: [2, 3, 4, 5, 4, 3, 2, 1] },
]}
format={{ kind: "integer" }}
height={340}
ariaLabel="Speed by direction"
state="ready"
/>
```Usage
The values are prepared by the caller: this component draws the points it is given and computes no statistic of its own, so units, scaling and any summary have to be settled before the data reaches it.
It is drawn by the ECharts engine.
Worked examples with real data are on the family overview: Scientific & mathematical
import { WindRoseChart } from "@luc/ui/charts";<WindRoseChart
directions={["N", "NE", "E", "SE", "S", "SW", "W", "NW"]}
series={[
{ label: "< 5 m/s", tone: "neutral", values: [6, 8, 11, 14, 12, 9, 7, 5] },
{ label: "5–10 m/s", tone: "accent", values: [4, 6, 9, 12, 10, 7, 5, 3] },
{ label: "> 10 m/s", tone: "info", values: [2, 3, 4, 5, 4, 3, 2, 1] },
]}
format={{ kind: "integer" }}
height={340}
ariaLabel="Speed by direction"
/>Data contract
`directions` defines the ordered compass sectors; `series` supplies one numeric value per direction for each speed bin. The binning is the caller's.
Important configuration
Keep direction order clockwise or anticlockwise consistently, label the radial unit, and use a stable speed-bin order for comparison.
Guidelines
When not to use
Do not pass raw wind observations and expect the chart to bin them, or compare roses with different bin definitions without disclosure.
Configuration
| Export | Kind | Signature |
|---|---|---|
WindRoseChart | 14 documented props | ({ directions, series, format, northUp, title, description, state, height, className, ariaLabel, ariaDescription, onReady, onEvent, eager, }: WindRoseChartProps) => import("@types/react").JSX.Element |
WindRoseChart props
Type: WindRoseChartProps
Values the compiler reads from the declaration.
| Prop | Type | Default | Notes |
|---|---|---|---|
ariaDescription? | string | undefined | — | |
ariaLabel? | string | undefined | — | |
className? | string | undefined | — | |
description? | string | undefined | — | |
directions | readonly string[] | — | Compass or sector labels, in order. |
eager? | boolean | undefined | — | Create the engine on mount rather than when the surface is approached. |
format? | ChartFormat | undefined | — | |
height? | string | number | undefined | — | |
northUp? | boolean | undefined | — | Start the first sector at the top rather than at 3 o'clock. Default `true`. |
onEvent? | ((event: EChartEvent) => void) | undefined | — | |
onReady? | ((chart: EChartsInstance) => void) | undefined | — | |
series | readonly { label: string; values: readonly number[]; tone?: SeriesTone; }[] | — | |
state? | ChartState | undefined | — | |
title? | string | undefined | — |
Accessibility
A chart is a picture of data, so it needs a name that states what it shows, and the numbers must exist as text somewhere on the page — in a table or a written summary — because a drawing is not readable by a screen reader and cannot be copied.
What happens on the server, and when hydration changes it.
Family
Scientific & mathematical
Fields, geometry and spectra for scientific readers.
Related