MAIDR Documentation - v4.4.0
    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;
        valueKey?: string;
        densityKey?: string;
    }
    Index

    Properties

    groupKey valueKey? densityKey?

    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 announced in and the order the <Area>s have to be declared in for highlighting.

    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.

    Settings

    Member Visibility

    On This Page

    Properties