MAIDR JavaScript API
    Preparing search index...

    One node of a node-and-link series.

    A sankey, a dependency wheel and an organization chart all declare their data as links and let Highcharts build the nodes from them, so the nodes are a resolved structure rather than a declared one: series.nodes is what the chart drew, and it is the only place a node's own options and its drawn element can be reached.

    Only the organization converter reads this today. A sankey's payload is its links, so nothing there needs the node objects.

    interface HighchartsNode {
        id: string | number;
        name?: string;
        linksTo?: HighchartsPoint[];
        linksFrom?: HighchartsPoint[];
        graphic?: { element: SVGElement };
        options?: { title?: string };
    }
    Index

    Properties

    id: string | number

    The identifier the links name this node by.

    Numeric as well as textual, because a chart may declare its links as [[1, 2], [1, 3]] and Highcharts builds the nodes from whatever it is given -- measured, such a chart draws the tree correctly. Readers key on String(id) so both spellings resolve.

    name?: string

    Display name, which Highcharts falls back to id for.

    linksTo?: HighchartsPoint[]

    The links whose to is this node — its parents, in an org chart.

    linksFrom?: HighchartsPoint[]

    The links whose from is this node — its children.

    graphic?: { element: SVGElement }

    The rendered box, which the per-node selectors are stamped onto.

    options?: { title?: string }

    Type Declaration

    • Optionaltitle?: string

      The second line an organization box draws, under the name — a job title. Highcharts names it title, and it is a node option rather than a point one, which is why it is reached through here.