Neo4j Visualization Library
    Preparing search index...

    Interface Node

    A node inside the graph visualization.

    interface Node {
        activated?: boolean;
        caption?: string;
        captionAlign?: "top" | "bottom" | "center";
        captions?: StyledCaption[];
        captionSize?: number;
        color?: string;
        disabled?: boolean;
        hovered?: boolean;
        html?: HTMLElement;
        icon?: string;
        id: string;
        overlayIcon?: { position?: number[]; size?: number; url: string };
        pinned?: boolean;
        selected?: boolean;
        size?: number;
    }

    Hierarchy

    • GraphElement
      • Node
    Index
    activated? caption? captionAlign? captions? captionSize? color? disabled? hovered? html? icon? id overlayIcon? pinned? selected? size?
    activated?: boolean

    Whether or not the current node is activated.

    caption?: string

    The text to display on the node or relationship.

    If both caption and captions are provided, captions takes precedence. To provide multiple captions with custom styles, use the captions property. Captions are only visible when using the 'canvas' renderer.

    Node.html and Node.icon for labelling nodes with the WebGL renderer.

    captionAlign?: "top" | "bottom" | "center"

    The caption align. Has no affect on self-referring relationships.

    captions?: StyledCaption[]

    Multiple captions with individual text styles.

    Only drawn by the 'canvas' renderer. For a single unstyled caption use caption.

    captionSize?: number

    The caption text size.

    color?: string

    The color of the graph element.

    disabled?: boolean

    Whether or not the current node or relationship is disabled.

    hovered?: boolean

    Whether or not the current node or relationship is hovered.

    html?: HTMLElement

    The DOM element to display on top of a node. Positioned by NVL on every frame.

    Any HTML overlay disables the WebGL renderer's GPU fast path because node positions must be available on the CPU every frame. Prefer icon or overlayIcon for many nodes.

    icon?: string

    The url to an icon to display inside the node. Icons are expected to be black and square. If the node's background color is dark, the icon will be inverted to white. Works with both renderers.

    The WebGL renderer keeps at most 256 distinct icon images (per url and inverted/not inverted); icons beyond that are not drawn and no warning is logged. The canvas renderer has no such cap. Keep the set of distinct icon urls small.

    id: string

    The id of the current node or relationship. Ids need to be unique across all nodes and relationships. Ids need to be strings and cannot be empty.

    overlayIcon?: { position?: number[]; size?: number; url: string }

    An icon to be displayed anywhere on top of the graph element. Icons are expected to be square. Works with both renderers.

    Type Declaration

    • Optionalposition?: number[]

      The position of the icon relative to the node or relationship. The position is a percentage of the node or relationship size. [1, 1] is the bottom right corner of the node or relationship. [-1, -1] is the top left corner of the node or relationship.

      [0, 0], the center of the node or relationship.

    • Optionalsize?: number

      The size of the icon relative to the node size or relationship caption size. The size is a percentage of the node size or relationship caption size.

      1, the same size as the node size or relationship caption size.

    • url: string

      The url to the icon.

    pinned?: boolean

    Whether or not the current node is pinned.

    selected?: boolean

    Whether or not the current node or relationship is selected.

    size?: number

    The size of the node.

    Settings

    On This Page
    Properties