Members

digraph :Boolean

graph/core/Graph.js, line 24

Whether this graph is directed or not.

Default Value:

• false

Methods

addEdge(edge) → {Graph}

graph/core/Graph.js, line 55

Adds an edge to the graph. If the graph is undirected, the method automatically creates the opponent edge.

Parameters:

Name	Type	Description
edge	Edge	The edge to add.

Returns:

Graph -

A reference to this graph.

addNode(node) → {Graph}

graph/core/Graph.js, line 37

Adds a node to the graph.

Parameters:

Name	Type	Description
node	Node	The node to add.

Returns:

Graph -

A reference to this graph.

clear() → {Graph}

graph/core/Graph.js, line 359

Removes all nodes and edges from this graph.

Returns:

Graph -

A reference to this graph.

fromJSON(json) → {Graph}

graph/core/Graph.js, line 412

Restores this instance from the given JSON object.

Parameters:

Name	Type	Description
json	Object	The JSON object.

Returns:

Graph -

A reference to this graph.

getEdge(from, to) → {Edge}

graph/core/Graph.js, line 99

Returns an edge for the given from and to node indices. If no node is found, null is returned.

Parameters:

Name	Type	Description
from	Number	The index of the from node.
to	Number	The index of the to node.

Returns:

Edge -

The requested edge.

getEdgeCount() → {number}

graph/core/Graph.js, line 177

Returns the edge count of the graph.

Returns:

number -

The amount of edges.

getEdgesOfNode(index, result) → {Array.<Edge>}

graph/core/Graph.js, line 146

Gathers all edges leading from the given node index and stores them into the given array.

Parameters:

Name	Type	Description
index	Number	The node index.
result	Array.<Edge>	The result array.

Returns:

Array.<Edge> -

The result array.

getNode(index) → {Node}

graph/core/Graph.js, line 85

Returns a node for the given node index. If no node is found, null is returned.

Parameters:

Name	Type	Description
index	Number	The index of the node.

Returns:

Node -

The requested node.

getNodeCount() → {number}

graph/core/Graph.js, line 166

Returns the node count of the graph.

Returns:

number -

The amount of nodes.

getNodes(result) → {Array.<Node>}

graph/core/Graph.js, line 129

Gathers all nodes of the graph and stores them into the given array.

Parameters:

Name	Type	Description
result	Array.<Node>	The result array.

Returns:

Array.<Node> -

The result array.

hasEdge(from, to) → {Boolean}

graph/core/Graph.js, line 326

Return true if the graph has an edge connecting the given from and to node indices.

Parameters:

Name	Type	Description
from	Number	The index of the from node.
to	Number	The index of the to node.

Returns:

Boolean -

Whether this graph has the edge or not.

hasNode(index) → {Boolean}

graph/core/Graph.js, line 312

Return true if the graph has the given node index.

Parameters:

Name	Type	Description
index	Number	The node index to test.

Returns:

Boolean -

Whether this graph has the node or not.

removeEdge(edge) → {Graph}

graph/core/Graph.js, line 267

Removes the given edge from the graph. If the graph is undirected, the method also removes the opponent edge.

Parameters:

Name	Type	Description
edge	Edge	The edge to remove.

Returns:

Graph -

A reference to this graph.

removeNode(node) → {Graph}

graph/core/Graph.js, line 198

Removes the given node from the graph and all edges which are connected with this node.

Parameters:

Name	Type	Description
node	Node	The node to remove.

Returns:

Graph -

A reference to this graph.

toJSON() → {Object}

graph/core/Graph.js, line 373

Transforms this instance into a JSON object.

Returns:

Object -

The JSON object.