Class Graphs

Utility class related with graph creation and manipulation.

Current implementation uses Cytoscape.js (https://js.cytoscape.org/)

Index

Constructors

Methods

addEdge addNode isLeaf loadLibrary newGraph removeNode toDot

Constructors

constructor

new Graphs(): Graphs
Returns Graphs

Methods

`Static`addEdge

addEdge(
    graph: Core,
    sourceNode: NodeSingular,
    targetNode: NodeSingular,
    edgeData: EdgeData | Record<string, unknown>,
): CollectionReturnValue
Parameters
- graph: Core
- sourceNode: NodeSingular
- targetNode: NodeSingular
- edgeData: EdgeData | Record<string, unknown>
Returns CollectionReturnValue
- Defined in lara-framework/Lara-JS/src-api/lara/graphs/Graphs.ts:32

`Static`addNode

addNode(
graph: Core,
nodeData: NodeData | Record<string, unknown>,
): CollectionReturnValue
Parameters
- graph: Core
- nodeData: NodeData | Record<string, unknown>
Returns CollectionReturnValue
- Defined in lara-framework/Lara-JS/src-api/lara/graphs/Graphs.ts:25

`Static`isLeaf

isLeaf(node: NodeSingular, loopsAreLeafs?: boolean): boolean
Parameters
- node: NodeSingular
- loopsAreLeafs: boolean = false
Returns boolean
True if the outdegree (number of edges with this node as source) is zero, false otherwise. By default, if a node has a connection to itself (loop) it is not considered a leaf
- Defined in lara-framework/Lara-JS/src-api/lara/graphs/Graphs.ts:86

`Static`loadLibrary

loadLibrary(): void
Returns void
Deprecated
Does nothing. Cytoscape should be loaded by the user.
- Defined in lara-framework/Lara-JS/src-api/lara/graphs/Graphs.ts:23

`Static`newGraph

newGraph(config?: {}): Core
Parameters
- config: {} = {}
  Configuration for the graph, according to what Cytoscape accepts as configuration object
Returns Core
- Defined in lara-framework/Lara-JS/src-api/lara/graphs/Graphs.ts:16

`Static`removeNode

removeNode(
    graph: Core,
    node: NodeSingular,
    edgeMapper: (incoming: EdgeSingular, outgoing: EdgeSingular) => EdgeData,
): void
Removes a node from the graph. Before removing the node, creates connections between all connecting sources and targets.
Parameters
- graph: Core
- node: NodeSingular
- edgeMapper: (incoming: EdgeSingular, outgoing: EdgeSingular) => EdgeData
Returns void
- Defined in lara-framework/Lara-JS/src-api/lara/graphs/Graphs.ts:98

`Static`toDot

toDot(graph: Core, dotFormatter?: DotFormatter): string
Parameters
- graph: Core
- dotFormatter: DotFormatter = ...
Returns string
- Defined in lara-framework/Lara-JS/src-api/lara/graphs/Graphs.ts:48