MAIDR JavaScript API
    Preparing search index...

    Interface RidgelineCurveConfig

    Configuration for ridgeline (joy) plots. Required when chartType is 'ridgeline'.

    Recharts has no ridgeline primitive: the chart is overlapping <Area>s with a per-group vertical offset baked into the plotted values. The offset is presentation — it exists so the curves do not overlap illegibly — so the payload carries each curve on its own terms and the config must name the density BEFORE the offset was added.

    The kernel density itself is computed outside Recharts and outside the adapter; data is the sampled curves, one row per sample, tagged with the group they belong to.

    interface RidgelineCurveConfig {
        groupKey: string;
        plottedKey?: string;
        plottedAxisReversed?: boolean;
        areas?: readonly RechartsRidgelineArea[];
        valueKey?: string;
        densityKey?: string;
    }
    Index

    Properties

    groupKey: string

    Key holding the group a sample's curve belongs to. Rows are grouped by it in first-appearance order, which is the order the ridges are read in when plottedKey cannot place them, and the order the <Area>s have to be declared in for highlighting when areas does not name them.

    plottedKey?: string

    Key holding the height the <Area>s draw: the density with the group's ridge offset added.

    Read only for where each ridge is drawn, never as data: a group's offset is its drawn height less its density. With it the ridges are read bottom first, as RidgelineTrace takes them, so Up moves to the ridge drawn above. MaidrRecharts reads it off the <Area dataKey> in its children when not given; through useRechartsAdapter it is yours to state. Without it, or when a group has no sample to read an offset from, the groups are read in first-appearance order, the first as the lowest.

    plottedAxisReversed?: boolean

    Whether the drawn heights are plotted on a reversed axis (<YAxis reversed>), where a larger offset is drawn lower on the page, so the ridges are read from the largest offset down. MaidrRecharts reads it off the first <YAxis> in its children when not given.

    areas?: readonly RechartsRidgelineArea[]

    The chart's <Area>s, in the order they are declared, each by its name and its dataKey.

    Each ridge is highlighted on the band of the <Area> named after its group, or else of the one whose dataKey is the group, so the order the <Area>s are declared in does not matter. MaidrRecharts reads them off its children when not given; through useRechartsAdapter they are yours to state. When they do not name every group's <Area>, each ridge is highlighted on the <Area> declared at its group's first appearance in data, and the console says so once per chart.

    valueKey?: string

    Key holding the position along the shared value axis.

    Defaults to a value column, then x, t, position.

    densityKey?: string

    Key holding the kernel-density value BEFORE the group's ridge offset was added.

    Fed the drawn y instead, every group's loudness would become a function of where it was stacked and the lowest ridge would be the loudest. Where nothing resolves, the reading is refused rather than a baseline guessed.

    Defaults to a density column, then kde, width, p, estimate.