JgfEdge

JgfEdge

An edge object represents a edge between two nodes in a graph. In graph theory, edges are also called lines or links.

Constructor

new JgfEdge(source, target, relation, label, metadata, directed)

Source:

jgfEdge.js, line 6

Constructor

Parameters:

Name	Type	Default	Description
`source`	string		Source node ID.
`target`	string		Target node ID.
`relation`	string \| null	`null`	Edge relation (aka 'relationship type').
`label`	string \| null	`null`	Edge label (the display name of the edge).
`metadata`	object \| null	`null`	Custom edge meta data.
`directed`	boolean \| null	`true`	Pass true for a directed edge, false for undirected.

Methods

isEqualTo(edge, compareRelation)

Source:

jgfEdge.js, line 67

Determines whether this edge is equal to the passed edge.

Parameters:

Name	Type	Default	Description
`edge`	JgfEdge		The edge to compare to.
`compareRelation`	boolean	`false`	Whether or not to compare the relation as well.