MAIDR JavaScript API
    Preparing search index...

    Interface HighchartsAxis

    Represents an axis in a Highcharts chart.

    interface HighchartsAxis {
        categories?: string[];
        names?: string[];
        getExtremes: () => { min: number; max: number };
        isDatetimeAxis?: boolean;
        reversed?: boolean;
        top?: number;
        left?: number;
        height?: number;
        width?: number;
        options: {
            title?: { text?: string };
            type?: string;
            visible?: boolean;
            reversed?: boolean;
            reversedStacks?: boolean;
            plotLines?: { value?: number }[];
            plotBands?: {
                from?: number;
                to?: number;
                label?: { text?: string };
                className?: string;
            }[];
        };
    }
    Index

    Properties

    categories? names? getExtremes isDatetimeAxis? reversed? top? left? height? width? options

    Properties

    categories?: string[]
    names?: string[]

    The other place Highcharts keeps a category axis' labels.

    An axis declared categories: [...] fills categories and leaves this empty. An axis declared type: 'category' -- the spelling Highcharts' own documentation uses for a chart of named tuples -- does the reverse: it collects the point names here and leaves categories an empty array, which is truthy and indexes to undefined (#1146).

    Read through declaredCategories() rather than directly, so that "what does the axis call slot 2" has one answer.

    getExtremes: () => { min: number; max: number }
    isDatetimeAxis?: boolean
    reversed?: boolean

    Whether the axis runs the other way — the resolved value, which Highcharts copies from options.reversed and also sets by itself on an inverted chart's x axis.

    top?: number

    Rendered distance from the chart top in px (present after render).

    left?: number

    Rendered distance from the chart left in px (present after render).

    height?: number

    Rendered axis height in px (present after render).

    width?: number

    Rendered axis width in px (present after render).

    options: {
        title?: { text?: string };
        type?: string;
        visible?: boolean;
        reversed?: boolean;
        reversedStacks?: boolean;
        plotLines?: { value?: number }[];
        plotBands?: {
            from?: number;
            to?: number;
            label?: { text?: string };
            className?: string;
        }[];
    }

    Type Declaration

    • Optionaltitle?: { text?: string }
    • Optionaltype?: string
    • Optionalvisible?: boolean

      False on an axis the chart does not draw — a timeline's, usually. Its title is then drawn nowhere, though Highcharts still fills one in.

    • Optionalreversed?: boolean

      Declares HighchartsAxis.reversed; read as its fallback.

    • OptionalreversedStacks?: boolean

      Whether the first series of a stack is drawn at the top of it rather than at its base. Highcharts defaults it to true on a y axis, so a stacked chart that never mentions it draws its first series on top.

    • OptionalplotLines?: { value?: number }[]

      Reference lines drawn across the plot — the significance cutoff of a volcano or Manhattan plot, which is the only place either chart states where its threshold is.

    • OptionalplotBands?: { from?: number; to?: number; label?: { text?: string }; className?: string }[]

      Qualitative bands drawn behind the axis — the shaded zones of a gauge or a bullet chart. Highcharts names one only in styled mode (via className) or through a label, so both are read.

    Settings

    Member Visibility

    On This Page

    Properties