Interface Relationship

A relationship inside the graph visualization.

interface Relationship {
    caption?: string;
    captionAlign?: "center" | "top" | "bottom";
    captionHtml?: HTMLElement;
    captions?: StyledCaption[];
    captionSize?: number;
    color?: string;
    disabled?: boolean;
    from: string;
    hovered?: boolean;
    id: string;
    overlayIcon?: {
        position?: number[];
        size?: number;
        url: string;
    };
    selected?: boolean;
    to: string;
    type?: string;
    width?: number;
}

Hierarchy

  • GraphElement
    • Relationship

Properties

caption? captionAlign? captionHtml? captions? captionSize? color? disabled? from hovered? id overlayIcon? selected? to type? width?

Properties

Optionalcaption

caption?: string

The text to display inside on node or relationship. @note: If both caption and captions are provided, captions takes precedence. @note: To provide multiple captions with custom styles, use the captions property. @note: Captions are only visible when using the 'canvas' renderer.

OptionalcaptionAlign

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

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

Optional ExperimentalcaptionHtml

captionHtml?: HTMLElement

The DOM element to display on top of a relationship caption.

The captionSize and captionAlign properties will affect the position and height of the html container element.

Optionalcaptions

captions?: StyledCaption[]

The caption text and font styles. @note: To provide a single caption without custom styles, you can also use the caption property. @note: Captions are only visible when using the 'canvas' renderer.

OptionalcaptionSize

captionSize?: number

The caption text size.

Optionalcolor

color?: string

The color of the graph element.

Optionaldisabled

disabled?: boolean

Whether or not the current node or relationship is disabled.

from

from: string

Node id where the relationship starts from.

Optionalhovered

hovered?: boolean

Whether or not the current node or relationship is hovered.

Readonlyid

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.

OptionaloverlayIcon

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.

    Default Value

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

    Default Value

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

  • url: string

    The url to the icon.

Optionalselected

selected?: boolean

Whether or not the current node or relationship is selected.

to

to: string

Node id where the relationship points to.

Optionaltype

type?: string

The relationship type.

Optionalwidth

width?: number

The width of the relationship.

Settings

On This Page

Properties