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

    Interface BoxenDeclaration

    A letter-value plot: the box plot's five-number summary generalised to a variable-depth ladder of quantiles.

    The ladder is precomputed outside the charting library, so the declaration names the columns it was computed into. A box plot's summary is this shape with exactly one rung, and that fixed depth is why a box plot cannot express a boxen.

    interface BoxenDeclaration {
        title?: string;
        name?: string;
        type: BOXEN;
        x?: string;
        median?: string;
        levels?: string;
        lowerOutliers?: string;
        upperOutliers?: string;
        orientation?: Orientation;
    }

    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: BOXEN

    TraceType.BOXEN — the string 'boxen'.

    x?: string

    Field holding the category this boxen summarises. Maps to BoxenPoint.z.

    'x'
    
    median?: string

    Field holding the middle of the distribution. Maps to BoxenPoint.median.

    'median', falling back to q2, mid or y

    levels?: string

    Field holding the rungs — the ladder of { p, lo, hi } quantile pairs. Maps to BoxenPoint.levels.

    The trace sorts them outward from the median rather than trusting the order they arrive in.

    This names the column; the rungs inside it are not declared field by field. A rung is read as a row of its own, so its three numbers answer to the same spread of spellings a top-level field does: p also to prob, probability or depth; lo to lower, low, min or y0; hi to upper, high, max or y1.

    'levels', falling back to letterValues, letter_values, quantiles or ladder

    lowerOutliers?: string

    Field holding the values below the deepest rung. Maps to BoxenPoint.lowerOutliers.

    upperOutliers?: string

    Field holding the values above the deepest rung. Maps to BoxenPoint.upperOutliers.

    orientation?: Orientation

    Which axis the distributions run along. Maps to MaidrLayer.orientation.

    The Orientation values, which are 'horz' and 'vert' — not the words they abbreviate, exactly as ErrorBarDeclaration.orientation.