RadarChart
RadarChart, RadarChartProps, RadarChartSeriesConfig: generated from the source of active-charts.
Exported by @workspace/. Generated from the package source; part of the index of every export.
Radar Chart#
Generic over TDatum extends Chart; the props below name it.
Props
- Type
string
Key in each data object that holds the variable name/label.
- Type
TDatum[]
Data: one object per variable. Each object has a key matching the variable name (used as label) plus one numeric key per series.
Example: [{variable: 'Rendement', profile
- Type
number
Container height in pixels. Width is always responsive.
- Type
RadarChart Series Config[]
Series configuration — one per data polygon.
- Type
boolean | LegendOptions
Enable legend.
- Type
StandaloneAccessibility Options
Accessible name, description, data table and keyboard navigation. No announcements: it switches <Chart>'s interaction announcements, which this family does not make.
- Type
StandaloneAnimation Option<"type">
The entrance: on, off, duration, easing and the entrance type (ADR-082, LAB-AT17).
- Type
string
Optional className applied to the outer container.
- Type
string[]
Categorical palette for this chart only: replaces the host palette (--chart- … --chart-) 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-, hex, oklch).
- Type
readonly ChartItem Ref[]
The initial selection of an uncontrolled chart.
- Type
"ltr""rtl"
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.
- Type
(Omit<ChartEvents, "on Zoom Change"…
The chart's events, and the selection events (T8). An item is a vertex: one series at one variable, as the pointer and the menu address it. Its series is id:<id> for a series with an id, else radar:<value; its key the row's category value unless selection. names another field.
- Type
ChartLegend Link
Connects the chart's legend to use, for a legend the host renders itself. Give one link to one chart.
- Type
ValuePresentation
Presentation input for axis labels, tooltips, labels and accessibility announcements: a locale code (notation follows the language), or a presentation-context object ({language) carrying language and notation independently. date 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/; the package never resolves tenant or application settings itself. When omitted, <Chart supplies it; with neither, the chart throws a configuration error (no 'en' fallback, active-format D14). Object inputs must be referentially stable across renders.
- Type
number
Maximum value on each axis. Default: from the data: a readable value at or above the highest visible value, so that every ring value is round. A value above an explicit max is drawn on the outer ring, keeps its true value, and the scale discloses it (≥).
- Type
number
Minimum value on each axis. Default: from the data: zero, or a readable value below the lowest visible value when one is negative. A value below an explicit min is drawn at the centre, keeps its true value in the tooltip, table and announcement, and the scale discloses it (≤).
- Type
Ref<ChartExport Handle>
Imperative handle: exports and element access. A family built on this type has no data-range zoom, so its handle has no set. Allows getting a ref to the component instance. Once the component unmounts, React will set ref. to null (or call the ref with null if you passed a callback ref).
- Type
number
Number of concentric grid rings. Default: 5.
- Type
readonly ChartItem Ref[]
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 on. 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.
- Type
ChartTranslate Fn
The host translator for every text the chart shows or announces. When omitted, <Chart supplies it; with neither, the chart throws a configuration error (no English fallback, ADR-028).
- Type
StandaloneTooltip Option
Tooltip of the vertex under the pointer: enabled, renderer, value and style (ADR-082, LAB-AT17).
- Type
ChartValue Semantics
What the values on the variable axes mean (BC1): unit and precision, declared once with the type the Cartesian charts read (Chart). The ring labels, the tooltip, the data table and the announcement write each value in it; tooltip. still wins in the tooltip. Without a declaration the chart presentation's number applies. CSV and Copy value keep the raw number.
- Type
number
Optional fixed width in pixels. Default: fill container.
Events
Called by the component when something happens.
- Type
(change) => void
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 use. 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.) changes nothing and reports nothing.
- Type
(selection, change) => void
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.), computed from the current selected and never from an earlier proposal; the host applies it, changes it or ignores it.
- Type
(event) => void
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 on) or tooltip fades.
- Type
(result) => void
Fired after a successful export action (PNG/SVG/CSV/PDF), including from the context menu and from imperative Chart calls.
- Type
(format, error) => void
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 (<Chart).
- Type
(item, source) => void
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).
- Type
() => void
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 on with type: 'load', which fires *after* the load animation finishes. A chart with animation={false} still fires on — animation state has no effect on readiness.
A new React key on the host produces a new component instance and on 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 on was defined at that moment. If on 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 use) or pass the final function unconditionally from the first render.
Other props, such as the standard attributes of the underlying element, className and ref, are passed through.
Types#
Props for Radar. Extends Base rather than Categorical because RadarChart has no top-level value — each series carries its own value (per-polygon shape). Precedent: TimelineChart picks BaseChartProps for the same reason (multi-series shape without a uniform top-level value).
No data labels, by design (API § 3.2): every series has a vertex at every spoke, so a value label per vertex would stack one label per series at the same angle over the web. The rings read the scale; a vertex's value is in the tooltip, the data table and the announcement.
Entrance animation: defaults to sweep (clockwise radial reveal). fade and none are also supported. Hover-transitions (150ms opacity) are retained as interaction feedback and fall below the WCAG 2.3.3 threshold for reduced-motion concerns; the global media query in accessibility. suppresses them defensively under prefers-.
The props of Radar, each described in its prop list on this page.
interface RadarChartProps<TDatum extends ChartDatum = ChartDatum>
extends
BaseChartPropsWithout<
'contextMenu' | 'onZoomChange' | 'tooltip' | 'animation' | 'accessibility'
>,
ChartSelectionProps<TDatum, ChartSeriesItem<TDatum>> {
events?: Omit<ChartEvents, 'onZoomChange'> &
ChartSelectionEvents<TDatum, ChartSeriesItem<TDatum>>;
accessibility?: StandaloneAccessibilityOptions;
tooltip?: StandaloneTooltipOption;
animation?: StandaloneAnimationOption<'type'>;
contextMenu?: FeatureOption<
ChartContextMenuOptions<RadarPoint<TDatum>, 'copy' | 'series' | 'export'>
>;
data: TDatum[];
categoryKey: string;
series: RadarChartSeriesConfig[];
min?: number;
max?: number;
rings?: number;
legend?: LegendOptions | boolean;
legendLink?: ChartLegendLink;
valueSemantics?: ChartValueSemantics;
}interface RadarChartSeriesConfig {
id?: string;
valueKey: string;
name?: string;
stroke?: string;
fill?: string;
fillOpacity?: number;
strokeWidth?: number;
marker?: Pick<MarkerOptions, 'shape'>;
}