MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface RidgelineDeclaration

    One density curve per group along a shared value axis, the curves offset down the page so their shapes can be compared.

    The offset is presentation — it exists so the curves do not overlap illegibly — so a layer carries each group's curve on its own terms and never the baseline it was drawn from.

    interface RidgelineDeclaration {
        title?: string;
        name?: string;
        type: RIDGELINE;
        group: string;
        value?: string;
        density?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    title?: string

    Overrides the layer's announced title. Maps to MaidrLayer.title.

    Names the chart; use DeclarationBase.name to say which layer of it this is.

    name?: string

    Names this layer among sibling layers. Maps to MaidrLayer.name.

    Announced on a layer switch in place of the trace type, so a hue-split figure says "Male" and "Female" rather than "error_bar plot" twice.

    type: RIDGELINE

    TraceType.RIDGELINE — the string 'ridgeline'.

    group: string

    Field holding the group a curve belongs to — the row it is drawn on. Maps to the categorical axis of ViolinKdePoint.

    Required, and therefore always used verbatim: without it there is nothing to separate the curves by, and one ridgeline read as a single density is a different chart.

    value?: string

    Field holding the position along the value axis. Maps to ViolinKdePoint.y.

    'value', falling back to x, t or position

    density?: string

    Field holding the kernel-density value before the group's ridge offset was added. Maps to ViolinKdePoint.density.

    Fed the drawn y instead, every group's loudness becomes a function of where it was stacked and the lowest ridge is the loudest. Where this resolves to nothing the reading is refused outright — an adapter warns and falls back to the undeclared chart type rather than subtracting a guessed baseline.

    'density', falling back to kde, width, p or estimate