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, sourceNode, targetNode, edgeData): CollectionReturnValue
Parameters
- graph: cytoscape.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, nodeData): CollectionReturnValue
Parameters
- graph: cytoscape.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, loopsAreLeafs?): 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?): cytoscape.Core
Parameters
- config: {} = {}
  Configuration for the graph, according to what Cytoscape accepts as configuration object
Returns cytoscape.Core
- Defined in lara-framework/Lara-JS/src-api/lara/graphs/Graphs.ts:16

`Static`removeNode

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

`Static`toDot

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