MAIDR JavaScript API
    Preparing search index...

    Interface PercentileBandDeclaration

    A percentile band (fan chart): a median line with nested bands of quantiles drawn around it, as a forecast's prediction intervals or TensorBoard's distribution dashboard draw them.

    A range series says nothing about which quantiles its edges are: the same arearange draws a min-max envelope, a 95% confidence interval and a mean plus or minus one standard deviation. Read undeclared, the median is a line and each band an area of its own, correct about every number and silent about how much of the distribution each band holds. The declaration is written on the median line and names each band's series and its two levels, so the figure becomes one percentile_band layer whose quantiles are the bands' edges and the median, at every x the median draws.

    The bands must nest: each one strictly inside the next wider one, every lower below 0.5 and every upper above it. A list that does not nest describes no fan chart and is refused. The band series are absorbed into the layer and become no layer of their own; one that cannot be resolved is reported and left out, and the layer keeps the bands that can.

    // Highcharts, a median with a 90% and a 50% band
    {
    custom: { maidr: { type: 'percentile_band', bands: [
    { series: 'p5-95', lower: 0.05, upper: 0.95 },
    { series: 'p25-75', lower: 0.25, upper: 0.75 },
    ] } }
    }
    interface PercentileBandDeclaration {
        title?: string;
        name?: string;
        type: PERCENTILE_BAND;
        bands: PercentileBandRef[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    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.

    TraceType.PERCENTILE_BAND — the string 'percentile_band'.

    The bands around the median, in any order; they are read outermost first. Required: a fan chart without its bands is the line it is drawn as.