MAIDR JavaScript API
    Preparing search index...

    Interface ChartJsParsedValue

    What Chart.js parsed one dataset value into.

    Every field is optional because the controllers disagree about which they produce: a plain bar parses to {x, y}, while the boxplot plugin adds the five-number summary and a violin adds coords on top of it.

    min/max are the data extremes and whiskerMin/whiskerMax the ends the chart draws its whiskers to; on a sample with an outlier the two differ, and it is the whiskers a box plot shows (#1049).

    interface ChartJsParsedValue {
        x?: number;
        y?: number;
        r?: number | null;
        min?: number;
        max?: number;
        q1?: number;
        median?: number;
        q3?: number;
        mean?: number;
        whiskerMin?: number;
        whiskerMax?: number;
        outliers?: number[];
        items?: number[];
        coords?: ChartJsKdeCoord[];
        xMin?: number | number[] | null;
        xMax?: number | number[] | null;
        xMinMin?: number;
        xMaxMax?: number;
        yMin?: number | number[] | null;
        yMax?: number | number[] | null;
        yMinMin?: number;
        yMaxMax?: number;
    }
    Index

    Properties

    x?: number
    y?: number
    r?: number | null

    The value a chartjs-chart-geo row is drawn by — the shade of a choropleth region, the radius of a bubble on a bubble map.

    Both controllers parse onto r because both hand their value to a legend scale (color / size) whose axis is r. It is read from here rather than from dataset.data because the field's name is configurable — scales.color.property defaults to 'value' but an author may point it at rate or density — and the parse has already applied it.

    null is a region the chart draws with no value, which the colour scale paints with options.missing rather than a shade.

    min?: number
    max?: number
    q1?: number
    median?: number
    q3?: number
    mean?: number
    whiskerMin?: number
    whiskerMax?: number
    outliers?: number[]
    items?: number[]
    coords?: ChartJsKdeCoord[]

    A violin's density curve; absent on a boxplot.

    xMin?: number | number[] | null

    The interval bounds chartjs-chart-error-bars parses onto a datum.

    Whichever axis carries the measurement carries the bounds: a vertical chart parses to yMin/yMax, and indexAxis: 'y' moves them to xMin/xMax along with the value itself. That is why the reading comes from here rather than from dataset.data, where working out which axis is which would have to be done again.

    An array is the plugin's nested-interval form -- a 95% inside a 99%, say. yMinMin/yMaxMax are then the outermost pair, and are scalars whether or not the bound is an array.

    null is a datum written as a plain number, which draws a bar with no whiskers; an object datum with no bounds omits the keys entirely. Both mean "no interval", which is why the test is != null (#1176).

    xMax?: number | number[] | null
    xMinMin?: number
    xMaxMax?: number
    yMin?: number | number[] | null
    yMax?: number | number[] | null
    yMinMin?: number
    yMaxMax?: number