Edge(from, to, cost)

Base class for graph edges.

new Edge(from, to, cost)
graph/core/Edge.js, line 15

Constructs a new edge.

Parameters:
Name Type Default Description
from Number

The index of the from node.
to Number

The index of the to node.
cost Number 0

The cost of this edge.
Author:

Members

cost :Number
graph/core/Edge.js, line 36

The cost of this edge. This could be for example a distance or time value.

Default Value:
  • 0

from :Number
graph/core/Edge.js, line 22

The index of the from node.

Default Value:
  • -1

to :Number
graph/core/Edge.js, line 29

The index of the to node.

Default Value:
  • -1

Methods

clone() → {Edge}
graph/core/Edge.js, line 61

Creates a new edge and copies all values from this edge.

Returns:
Edge -

A new edge.

copy(edge) → {Edge}
graph/core/Edge.js, line 46

Copies all values from the given edge to this edge.

Parameters:
Name Type Description
edge Edge

The edge to copy.
Returns:
Edge -

A reference to this edge.

fromJSON(json) → {Edge}
graph/core/Edge.js, line 89

Restores this instance from the given JSON object.

Parameters:
Name Type Description
json Object

The JSON object.
Returns:
Edge -

A reference to this edge.

toJSON() → {Object}
graph/core/Edge.js, line 72

Transforms this instance into a JSON object.

Returns:
Object -

The JSON object.