JSDoc: Class: Path

new Path(nodes, edges)

Parameters:

Name	Type	Description
`nodes`	Array.<Node>	path's node list.
`edges`	Array.<Edge>	path's edge list.

Source:

path.js, line 16

Members

edgeCount

Returns the amount of edges in the path.

Source:

path.js, line 83

Edges

Returns the path's edges as list.

Source:

path.js, line 33

firstNode

Returns the path's first node.

Source:

path.js, line 59

lastNode

Returns the last node of the path.

Source:

path.js, line 67

nodeCount

Returns the amount of nodes in th path.

Source:

path.js, line 75

Nodes

Returns the path's nodes as list.

Source:

path.js, line 25

Methods

getEdge(index) → {Edge}

Returns an edge in a given index.

Parameters:

Name	Type	Description
`index`	number	(integer)

Source:

path.js, line 51

Returns:

edge in a given index.

Type: Edge

getNode(index) → {Node}

Returns a node in a given index.

Parameters:

Name	Type	Description
`index`	number	(integer)

Source:

path.js, line 42

Returns:

node in the given index.

Type: Node

toString() → {string}

Returns the path string representation.

Source:

path.js, line 91

Returns:

path string representation.

Type: string