Unique identifier for the chart (used for DOM IDs).
OptionaltitleChart title displayed in text descriptions.
OptionalsubtitleChart subtitle.
OptionalcaptionChart caption.
OptionaldataRecharts data array. Each item is one data point with named fields.
Required in simple/composed mode. In subplot mode it acts as the
default data for panels that do not provide their own data, and may
be omitted when every panel does.
OptionalchartChart type for simple mode (single chart type with one or more series).
Mutually exclusive with layers.
OptionalcategoryWhether the axis carrying the categories is drawn from its far end.
Not a prop an author sets: MaidrRecharts derives it by reading
reversed off the <XAxis> / <YAxis> inside its own children, which is
where Recharts states it and where the converter cannot otherwise see it
(#1017).
OptionalstepWhich way a step curve's riser goes: 'hv' holds the level and jumps at
the next sample (<Line type="stepAfter">), 'vh' jumps at the current
one (type="stepBefore").
Read for 'step' and for the area types, whose trace carries a step the
same way. MaidrRecharts fills it in from the <Line> / <Area>
inside its own children when a step chart does not declare one, so an
author usually need not.
Left undefined rather than defaulted when nothing says. Every curve
Recharts draws has a name — hv, vh, or mid for the centred
type="step" — so a default here would be substituting one of them for a
config that named none, and an undeclared direction is the one case
StepTrace is written to expect.
OptionalcategoryThe same answer per panel, in the grid's row-major order, in subplot mode.
A panel has its own chart and so its own axes: one verdict for the whole grid would apply the first panel's answer to every other. Derived by MaidrRecharts from each panel's own child element.
Key in data objects for x-axis values.
OptionalyKeys in data objects for y-axis values (simple mode).
Each key creates a separate data series.
Mutually exclusive with layers.
OptionallayersLayer configurations for composed charts (composed mode).
Each layer defines a chart type and data key.
Mutually exclusive with chartType/yKeys.
OptionalsubplotsPanel configurations for multi-panel (faceted) figures (subplot mode).
Mutually exclusive with the top-level chartType and layers.
A 2D array describes the panel grid directly in row-major visual
reading order (subplots[0][0] is the top-left panel). A flat array
is chunked into rows of columns panels (one single row when
columns is omitted). Rows may be ragged but never empty.
When rendering through <MaidrRecharts>, pass one Recharts chart per
panel as children in the same row-major order — each child is wrapped
in a generated .maidr-panel-<row>-<col> div used for per-panel
highlight scoping. See RechartsSubplotConfig.panelSelector for
the custom-DOM escape hatch.
OptionalcolumnsNumber of panels per row when subplots is a flat array.
Ignored when subplots is already a 2D grid.
OptionalxX-axis label.
OptionalyY-axis label.
OptionalorientationBar/box chart orientation. Defaults to vertical.
OptionalfillDisplay names for each series in stacked/dodged/normalized/diverging bar
charts. Maps 1:1 with yKeys — the i-th fillKey names the i-th yKey.
When omitted, the yKey strings are used as fill labels.
A dumbbell reads them as the names of its two ends. They are the content of that comparison: announced as "start" and "end", a chart of life expectancy in 1990 against 2020 tells the reader which dot they are on and not which year it is.
OptionalbinHistogram bin range configuration.
Required when chartType is 'histogram', unless every bin's xKey
label is itself a number — then each bin is read as a zero-width bin at
its label. A label such as '0-10' places nothing, and a histogram
carrying those without this config is refused rather than announced with
a bin range nothing stated.
OptionalflowFlow link configuration.
Required when chartType is 'alluvial' or 'sankey'.
OptionalvolcanoPoint labels and cutoffs for a volcano or Manhattan plot.
Used when chartType is 'volcano' or 'manhattan'.
OptionalerrorInterval configuration.
Used when chartType is 'error_bar' or 'forest'.
OptionalforestForest plot configuration.
Used when chartType is 'forest'.
OptionalsurvivalSurvival curve configuration.
Used when chartType is 'survival'.
OptionalwaterfallWaterfall step configuration.
Used when chartType is 'waterfall'.
OptionalganttGantt lane configuration.
Used when chartType is 'gantt'.
OptionalgaugeGauge range, target and bands.
Required when chartType is 'gauge'.
OptionalparallelAxis order and raw value keys for a parallel coordinates plot.
Required when chartType is 'parallel'.
OptionalridgelineGroup, value and density keys for a ridgeline plot.
Required when chartType is 'ridgeline'.
OptionalhexbinBin centre, count and lattice row keys for a hexbin plot.
Used when chartType is 'hexbin'.
OptionalboxenMedian, ladder and outlier keys for a boxen plot.
Used when chartType is 'boxen'.
OptionalselectorCustom CSS selector override for SVG highlighting.
By default the adapter generates selectors from Recharts' built-in class names. For multi-series charts, CSS selectors cannot reliably distinguish between series, so highlighting is disabled.
To enable highlighting for multi-series charts, add a custom
className to each Recharts component and pass the selector here:
Recharts chart component(s) to make accessible.
Props for the MaidrRecharts wrapper component.