Skip to content
Scientific & mathematicalGenerated from the public API

PolarRoseChart

Read a field, a geometry or a spectrum, with the scale handled for you.

@luc/ui/charts

What it shows

Compare magnitudes by angle in a polar layout, where radius carries the measured value.

Live preview

Eight equal-angle sectors whose radius — not their angle — carries the measurement.

<PolarRoseChart
  data={[
    { name: "N", value: 12 },
    { name: "NE", value: 18 },
    { name: "E", value: 24 },
    { name: "SE", value: 31 },
    { name: "S", value: 27 },
    { name: "SW", value: 19 },
    { name: "W", value: 15 },
    { name: "NW", value: 9 },
  ]}
  variant="rose"
  format={{ kind: "integer" }}
  height={340}
  ariaLabel="Readings by sector"
/>

Controls

Height

340px

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 { PolarRoseChart } from "@luc/ui/charts";

<PolarRoseChart
  data={[
    { name: "N", value: 12 },
    { name: "NE", value: 18 },
    { name: "E", value: 24 },
    { name: "SE", value: 31 },
    { name: "S", value: 27 },
    { name: "SW", value: 19 },
    { name: "W", value: 15 },
    { name: "NW", value: 9 },
  ]}
  variant="rose"
  format={{ kind: "integer" }}
  height={340}
  ariaLabel="Readings by sector"
  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 `PolarRoseChart` from Luc UI. It is: Read a field, a geometry or a spectrum, with the scale handled for you.

Import it with: import { PolarRoseChart } 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="Readings by sector"`.

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
<PolarRoseChart
  data={[
    { name: "N", value: 12 },
    { name: "NE", value: 18 },
    { name: "E", value: 24 },
    { name: "SE", value: 31 },
    { name: "S", value: 27 },
    { name: "SW", value: 19 },
    { name: "W", value: 15 },
    { name: "NW", value: 9 },
  ]}
  variant="rose"
  format={{ kind: "integer" }}
  height={340}
  ariaLabel="Readings by sector"
  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 { PolarRoseChart } from "@luc/ui/charts";
<PolarRoseChart
  data={[
    { name: "N", value: 12 },
    { name: "NE", value: 18 },
    { name: "E", value: 24 },
    { name: "SE", value: 31 },
    { name: "S", value: 27 },
    { name: "SW", value: 19 },
    { name: "W", value: 15 },
    { name: "NW", value: 9 },
  ]}
  variant="rose"
  format={{ kind: "integer" }}
  height={340}
  ariaLabel="Readings by sector"
/>

Data contract

`data` is an ordered array of named numeric values; `variant` selects the rose geometry and `format` describes the measure. The angle is a category position, not a second value.

Important configuration

Keep a consistent category order, choose `variant` deliberately, and format the radial values because radial length is harder to compare than a linear bar.

Guidelines

When not to use

Do not use angle as a quantitative encoding or compare many similar radial lengths without exact labels.

Configuration

Exported symbols
ExportKindSignature
PolarRoseChart13 documented props({ data, variant, format, title, description, state, height, className, ariaLabel, ariaDescription, onReady, onEvent, eager, }: PolarRoseChartProps) => import("@types/react").JSX.Element

PolarRoseChart props

Type: PolarRoseChartProps

Values the compiler reads from the declaration.

PolarRoseChart props
PropTypeDefaultNotes
ariaDescription?string | undefined—
ariaLabel?string | undefined—
className?string | undefined—
datareadonly { name: string; value: number; }[]—
description?string | undefined—
eager?boolean | undefined—Create the engine on mount rather than when the surface is approached.
format?ChartFormat | undefined—
height?string | number | undefined—
onEvent?((event: EChartEvent) => void) | undefined—
onReady?((chart: EChartsInstance) => void) | undefined—
state?ChartState | undefined—
title?string | undefined—
variant?"pie" | "donut" | "rose" | undefined—`rose` (Nightingale) varies the radius; `radius` varies the radius too but keeps the slices even. `pie` is the flat composition for comparison.

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.

Luc UI v1.0PolarRoseChartdark theme