MAIDR JavaScript API
    Preparing search index...

    Interface HighchartsSeries

    interface HighchartsSeries {
        type: string;
        name: string;
        data: HighchartsPoint[];
        group?: { element: SVGElement };
        nodes?: HighchartsNode[];
        xAxis: HighchartsAxis;
        yAxis: HighchartsAxis;
        colorAxis?: HighchartsAxis;
        index: number;
        visible: boolean;
        linkedParent?: HighchartsSeries;
        options: {
            type?: string;
            id?: string;
            linkedTo?: string;
            stacking?: string;
            step?: boolean | "left" | "right" | "center";
            tileShape?: string;
            startAngle?: number;
            isInternal?: boolean;
            className?: string;
            custom?: { maidr?: MaidrTraceDeclaration };
        };
    }
    Index

    Properties

    type name data group? nodes? xAxis yAxis colorAxis? index visible linkedParent? options

    Properties

    type: string
    name: string
    data: HighchartsPoint[]
    group?: { element: SVGElement }

    The SVG group the series draws its marks into. A line draws its path here, and MAIDR draws the dot for a line's point beside it.

    nodes?: HighchartsNode[]

    The nodes of a node-and-link series, resolved by Highcharts from the links. Absent on every other series type.

    xAxis: HighchartsAxis
    yAxis: HighchartsAxis
    colorAxis?: HighchartsAxis

    The colour axis a heatmap or a map shades its cells by, when the chart has one. Its title, when drawn, names what the colours measure.

    index: number
    visible: boolean
    linkedParent?: HighchartsSeries

    The series this one is drawn against, resolved by Highcharts from options.linkedTo before it renders. An error bar's estimate lives here: the whip carries only the interval.

    options: {
        type?: string;
        id?: string;
        linkedTo?: string;
        stacking?: string;
        step?: boolean | "left" | "right" | "center";
        tileShape?: string;
        startAngle?: number;
        isInternal?: boolean;
        className?: string;
        custom?: { maidr?: MaidrTraceDeclaration };
    }

    Type Declaration

    • Optionaltype?: string
    • Optionalid?: string

      Identifier another series' linkedTo can name.

    • OptionallinkedTo?: string

      Binds this series to another one, either by its id or as ':previous'. Highcharts resolves it into HighchartsSeries.linkedParent.

    • Optionalstacking?: string
    • Optionalstep?: boolean | "left" | "right" | "center"

      Where a line series' staircase rises, when it draws one. Highcharts resolves plotOptions into here, so this is set however the chart asked for it. Legacy true means 'left'.

    • OptionaltileShape?: string

      The shape a tilemap draws its tiles with — hexagon (the default), diamond, circle or square. The first three stagger alternate columns; a square tilemap is an aligned grid.

    • OptionalstartAngle?: number

      Where a pie's first slice begins, in degrees clockwise from 12 o'clock (Highcharts' own convention, and the grammar's). Resolved here from plotOptions.pie however the chart asked for it; 0 when unset.

    • OptionalisInternal?: boolean

      Set by Highcharts on internal series (e.g. the Highstock navigator).

    • OptionalclassName?: string

      User- or Highcharts-assigned class name (e.g. highcharts-navigator-series).

    • Optionalcustom?: { maidr?: MaidrTraceDeclaration }

      Highcharts' reserved subspace — documented as "a reserved subspace to store options and values for customized functionality". MAIDR reads only the maidr key of it, and leaves everything else alone.

      This is where a chart says what a series means when the drawing cannot: nothing about a stepped line series says it is a survival curve, and nothing about a scatter on an inverted category axis says its rows are studies in a meta-analysis. See MaidrTraceDeclaration.

    Settings

    Member Visibility

    On This Page

    Properties