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

    Interface BoxenLadderConfig

    Configuration for boxen (letter-value) plots. Optional when chartType is 'boxen', but a boxen with no ladder is a box plot — see levelsKey.

    Recharts has no box primitive at all, so the rungs are faked as stacked <Bar>s with a transparent base segment. Neither the ladder nor the median is anything the chart holds: both are computed from the raw sample before it is drawn, and this names the columns they were computed into. One data row is one distribution.

    interface BoxenLadderConfig {
        xKey?: string;
        medianKey?: string;
        levelsKey?: string;
        lowerOutliersKey?: string;
        upperOutliersKey?: string;
    }
    Index

    Properties

    xKey? medianKey? levelsKey? lowerOutliersKey? upperOutliersKey?

    Properties

    xKey?: string

    Key holding the category the distribution summarises. Defaults to the chart's xKey.

    medianKey?: string

    Key holding the middle of the distribution.

    Defaults to a median column, then q2, mid, y.

    levelsKey?: string

    Key holding the ladder: an array of { p, lo, hi } rungs, where p is the TAIL probability — 0.25 for the rung spanning the middle half, 0.125 for the middle three quarters, and so on inwards.

    A rung whose three numbers are not all finite is dropped rather than announced as a quantile the data does not contain. The order does not matter: MAIDR walks the ladder outward from the median whichever way round it arrives.

    Defaults to a levels column, then letterValues, letter_values, quantiles, ladder.

    lowerOutliersKey?: string

    Key holding the values below the deepest rung.

    upperOutliersKey?: string

    Key holding the values above the deepest rung.

    Settings

    Member Visibility

    On This Page

    Properties