MAIDR JavaScript API
    Preparing search index...

    Interface UPlotSeriesMaidrOptions

    Per-series options, set on the series itself as maidr: { ... } or passed through MaidrUPlotOptions.series.

    interface UPlotSeriesMaidrOptions {
        kind?: UPlotSeriesKind;
        exclude?: boolean;
        prevalence?: number;
        ap?: number;
        bands?: readonly { band: number; lower: number; upper: number }[];
    }
    Index

    Properties

    What the series is read as. uPlot draws every kind through an opaque paths function, so MAIDR infers the kind from the path uPlot last built for it; set this when a custom path builder defeats that inference. area is never inferred unless MaidrUPlotOptions.areas is set; it reads as MAIDR's experimental area trace type.

    exclude?: boolean

    Leave this series out of MAIDR entirely.

    prevalence?: number

    With kind: 'pr_curve': the share of positives this curve was scored on, as a fraction from 0 to 1 -- the height of its chance baseline. Describes this series' curve only; never inferred, and a percentage is refused.

    ap?: number

    With kind: 'pr_curve': this curve's average precision, from 0 to 1.

    bands?: readonly { band: number; lower: number; upper: number }[]

    Read this series as the median of a fan chart, with the uPlot bands around it as its percentile bands. Each entry names one of the chart's own bands by its index there -- { series: [upper, lower] }, the pair uPlot fills between -- and the two quantile levels its edges are. The levels are checked as the co-located maidr declaration's are: fractions, straddling the median, nesting.