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

    Interface ErrorBarDeclaration

    An estimate with the interval drawn around it — an error bar, a confidence interval, a point range.

    The bounds are absolute positions on the value axis, never offsets from the estimate. Producers disagree about which they hand out (matplotlib's yerr is an offset, Vega-Lite's errorbar computes bounds), so the grammar fixes one and ErrorBarDeclaration.error is how the other is declared and converted.

    The two bounds are optional and independently so: a one-sided interval is a real chart, and dropping the point for want of its other half would lose the estimate too.

    interface ErrorBarDeclaration {
        title?: string;
        name?: string;
        type: ERROR_BAR;
        yMin?: string;
        yMax?: string;
        error?: string;
        intervalSeries?: 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: ERROR_BAR

    TraceType.ERROR_BAR — the string 'error_bar'.

    yMin?: string

    Field holding the absolute lower bound. Maps to ErrorBarPoint.yMin.

    'yMin', falling back to lower, lo, ciLower, ciLow, ci_low, low or min

    yMax?: string

    Field holding the absolute upper bound. Maps to ErrorBarPoint.yMax.

    'yMax', falling back to upper, hi, ciUpper, ciHigh, ci_high, high or max

    error?: string

    Field holding the interval as an offset from the estimate — the field a Recharts <ErrorBar dataKey> or a matplotlib yerr points at. A number is a symmetric offset; a [lower, upper] pair is an asymmetric one.

    Both forms are positive magnitudes, as yerr is: the bounds are estimate - lower and estimate + upper, so an interval given as [0.2, 0.3] around 1.4 is 1.2 to 1.7. Signed offsets are not a second accepted spelling — read that way the same pair would give 1.6 to 1.7, and neither reading is detectable downstream once the absolute bounds are emitted. A negative entry is left out rather than flipped.

    Normalised to absolute bounds on the way into the payload. Loses to yMin/yMax where both are declared, since those need no arithmetic.

    Alone among the field refs here, this one has no fallback chain: an offset column is named explicitly or spelled exactly error. Every common spelling is either axis-specific (yerr, xerr, and a row carrying both says nothing about which axis this chart draws its intervals on) or a dispersion statistic a chart commonly draws a multiple of (sd, sem, err — ±1.96 SEM is as ordinary as ±1). Read as the drawn offset, one of those resizes every interval on the figure without saying so.

    intervalSeries?: string

    Companion series drawing the interval rather than the estimate — an amCharts openValueY/openValueX column, a Highcharts errorbar.

    Merged into this layer by x and suppressed from becoming a layer of its own.

    orientation?: Orientation

    Which axis the estimate runs along. Maps to MaidrLayer.orientation.

    The Orientation values, which are 'horz' and 'vert' — not the words they abbreviate. 'horizontal' is not accepted, and a declaration carrying it is warned about and read without the key.