MAIDR JavaScript API
    Preparing search index...

    Interface HighchartsChart

    Represents a Highcharts chart instance. Passed to highchartsToMaidr to generate MAIDR-compatible data.

    interface HighchartsChart {
        series: HighchartsSeries[];
        xAxis: HighchartsAxis[];
        yAxis: HighchartsAxis[];
        title: { textStr?: string };
        subtitle?: { textStr?: string };
        caption?: { textStr?: string };
        container: HTMLElement;
        renderTo: HTMLElement;
        options: {
            chart?: {
                type?: string;
                inverted?: boolean;
                polar?: boolean;
                parallelCoordinates?: boolean;
            };
            plotOptions?: {
                series?: { stacking?: string };
                column?: { stacking?: string };
                bar?: { stacking?: string };
                area?: { stacking?: string };
                areaspline?: { stacking?: string };
            };
        };
        tooltip?: {
            refresh: (point: HighchartsPoint | HighchartsPoint[]) => void;
            hide: () => void;
        };
        time?: { timezone?: string; useUTC?: boolean };
        mapView?: {
            projectedUnitsToLonLat?: (
                point: { x: number; y: number },
            ) => MapLonLat | undefined;
        };
    }
    Index

    Properties

    series xAxis yAxis title subtitle? caption? container renderTo options tooltip? time? mapView?

    Properties

    series: HighchartsSeries[]
    xAxis: HighchartsAxis[]
    yAxis: HighchartsAxis[]
    title: { textStr?: string }
    subtitle?: { textStr?: string }
    caption?: { textStr?: string }
    container: HTMLElement

    The .highcharts-container element created by Highcharts.

    renderTo: HTMLElement

    The user-provided render target element.

    options: {
        chart?: {
            type?: string;
            inverted?: boolean;
            polar?: boolean;
            parallelCoordinates?: boolean;
        };
        plotOptions?: {
            series?: { stacking?: string };
            column?: { stacking?: string };
            bar?: { stacking?: string };
            area?: { stacking?: string };
            areaspline?: { stacking?: string };
        };
    }
    tooltip?: {
        refresh: (point: HighchartsPoint | HighchartsPoint[]) => void;
        hide: () => void;
    }
    time?: { timezone?: string; useUTC?: boolean }

    The time settings the chart draws its dates with. Highcharts 12 and later resolve the zone onto timezone, leaving it undefined for the browser's own; earlier versions say whether it is UTC with useUTC. Both default to UTC.

    mapView?: {
        projectedUnitsToLonLat?: (
            point: { x: number; y: number },
        ) => MapLonLat | undefined;
    }

    The Highmaps view (v10+) — the thing that knows the projection a map is drawn through, and the only way back from where a shape sits to where it is on the globe.

    Type Declaration

    • OptionalprojectedUnitsToLonLat?: (point: { x: number; y: number }) => MapLonLat | undefined

      Turns a position in the map's projected units into degrees.

      Returns nothing on a map with no geographic projection, which is the answer MAIDR wants there: a pre-projected map's units are not degrees and must not be announced as though they were.

    Settings

    Member Visibility

    On This Page

    Properties