A node inside the graph visualization.

interface Node {
    activated?: boolean;
    caption?: string;
    captionAlign?: "center" | "top" | "bottom";
    captionSize?: number;
    captions?: StyledCaption[];
    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

Properties

activated?: boolean

Whether or not the current node is activated.

caption?: string

The text to display inside on node or relationship.

Use captions instead.

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

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

captionSize?: number

The caption text size.

captions?: StyledCaption[]

The caption text and font style. Captions are only visible when using the 'canvas' renderer.

color?: string
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.

icon?: string

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

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.

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
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.