MAIDR JavaScript API
    Preparing search index...

    Represents an individual data point within a Highcharts series.

    interface HighchartsPoint {
        x: number;
        y: number | null;
        category?: string;
        name?: string;
        label?: string;
        x2?: number;
        z?: number;
        lat?: number;
        lon?: number;
        title?: string;
        text?: string;
        high?: number;
        low?: number;
        q1?: number;
        q3?: number;
        median?: number;
        open?: number;
        close?: number;
        percentage?: number;
        weight?: number;
        from?: string | number;
        to?: string | number;
        id?: string;
        parent?: string;
        value?: number;
        target?: number;
        isSum?: boolean;
        isIntermediateSum?: boolean;
        options?: Record<string, unknown>;
        properties?: Record<string, unknown>;
        bounds?: {
            x1: number;
            y1: number;
            x2: number;
            y2: number;
            midX?: number;
            midY?: number;
        };
        graphic?: { element: SVGElement };
        series: HighchartsSeries;
        index: number;
        setState?: (state: string) => void;
    }
    Index

    Properties

    x: number
    y: number | null
    category?: string
    name?: string
    label?: string

    The second line of a timeline event's box.

    A timeline draws two strings per event — name on the first line and this on the second — and on the ordinary timeline, whose x axis is hidden and whose x is a bare index, this is the only place the date appears. Highcharts uses the same key for a series-level label elsewhere; only the timeline converter reads it.

    x2?: number

    The far end of an interval — a gantt task's finish, an xrange bar's right edge. Highcharts aliases a gantt point's end onto it, so both series read the same way.

    z?: number

    A bubble's size, as the third quantity the marker's area encodes.

    Highcharts names it z and so does ScatterPoint, which reads it through zIntensityFor() -- so a bubble's size is a measurement to be announced and sonified rather than a drawing parameter (#1138).

    lat?: number

    A map marker's own position, in degrees east and degrees north.

    mappoint and mapbubble place their markers from these rather than by joining to a map feature, so they are filled exactly where properties and bounds -- the two places a map region's centroid comes from -- are both empty. Measured on Highcharts 13.0.1, a mappoint declared {name, lat, lon} carries lat/lon on the point and no y at all.

    lon?: number
    title?: string

    A flag's headline, drawn inside the marker Highcharts pins to the axis.

    A flags point carries this and text and no magnitude: measured, its y is absent on a flag placed against a base series and present on the next one, because it is where the marker was put rather than anything the chart measured.

    text?: string

    A flag's body, drawn in its tooltip. See HighchartsPoint.title.

    high?: number

    Boxplot / candlestick high value, error bar upper bound, dumbbell high.

    low?: number

    Boxplot / candlestick low value, error bar lower bound, dumbbell low.

    q1?: number

    Boxplot first quartile.

    q3?: number

    Boxplot third quartile.

    median?: number

    Boxplot median.

    open?: number

    Candlestick open value.

    close?: number

    Candlestick close value.

    percentage?: number

    Percentage of total when stacking is 'percent'.

    weight?: number

    Magnitude for the series that declare pointArrayMap: ['weight'] rather than a y — a word cloud term's weight, and a sankey / dependency wheel / arc diagram link's flow.

    from?: string | number

    Sankey-family and network link source node id.

    to?: string | number

    Sankey-family and network link target node id.

    id?: string

    Treemap / sunburst node id, referenced by a child's parent.

    parent?: string

    Treemap / sunburst id of this node's parent, empty at the top level.

    value?: number

    Treemap / sunburst magnitude, and a heatmap or tilemap cell's colour value. Those series declare value in their pointArrayMap, so the number is here rather than in y — on a tilemap y is the lattice row.

    target?: number

    The marker a bullet chart draws beside its bar.

    isSum?: boolean

    Waterfall step that restates the total of every step so far.

    isIntermediateSum?: boolean

    Waterfall step that restates the total since the previous subtotal.

    options?: Record<string, unknown>
    properties?: Record<string, unknown>

    The map feature's own properties, copied off the GeoJSON / TopoJSON geometry the point was joined to. Some map collections carry a centroid here as hc-middle-lon / hc-middle-lat, in degrees.

    bounds?: {
        x1: number;
        y1: number;
        x2: number;
        y2: number;
        midX?: number;
        midY?: number;
    }

    A map point's extent in the map view's projected units, set while the series projects its geometry. midX/midY are the anchor Highcharts places the shape's label at, which is the nearest thing a map series has to a centroid.

    graphic?: { element: SVGElement }

    Reference to the SVG element for this point (may be undefined if not rendered).

    index: number
    setState?: (state: string) => void