Interface DefaultLinkParams

Context handed to a DefaultLink factory while the user drags a new connection from a port or element.

interface DefaultLinkParams {
    graph: Graph;
    paper: Paper;
    source: ConnectionEnd;
}

Index

Properties

graph paper source

Properties

`Readonly`graph

graph: Graph

The graph instance.

`Readonly`paper

paper: Paper

The paper instance.

`Readonly`source

source: ConnectionEnd

The source end of the connection being created.

Type Declaration

One end (source or target) of a link: the cell it attaches to and the exact port or magnet within that cell. Shared by ValidateConnectionParams and emitted on link:connect / link:disconnect events, so validation and event payloads describe a connection the same way.

Readonlyid: ID
ID of the cell this end attaches to.
Readonlymagnet: Element | null
The SVG magnet node the end attaches to, or null when attaching to the cell's root.
Readonlymodel: Cell
The cell model (element or link) this end attaches to.
Readonlyport: string | null
ID of the port the end attaches to, or null when it attaches to the cell body.
Readonlyselector: string | null
Value of the magnet's joint-selector attribute, or null when it has none.

Interface DefaultLinkParams

Index

Properties

Properties

`Readonly`graph

`Readonly`paper

`Readonly`source

Type Declaration

`Readonly`id: ID

`Readonly`magnet: Element | null

`Readonly`model: Cell

`Readonly`port: string | null

`Readonly`selector: string | null

Settings

On This Page

Interface DefaultLinkParams

Index

Properties

Properties

Readonlygraph

Readonlypaper

Readonlysource

Type Declaration

Readonlyid: ID

Readonlymagnet: Element | null

Readonlymodel: Cell

Readonlyport: string | null

Readonlyselector: string | null

Settings

On This Page

`Readonly`graph

`Readonly`paper

`Readonly`source

`Readonly`id: ID

`Readonly`magnet: Element | null

`Readonly`model: Cell

`Readonly`port: string | null

`Readonly`selector: string | null