Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SimpleEdge

Basic information about an edge used to initially create a Graph. Once a graph is constructed, all of its methods will return Edges instead, which contain additional useful information.

An edge is specified by which nodes are its "start" and "end." The direction of an edge is arbitrary, but once set will be handled consistently by the Graph methods.

The edge may also specify internal locations which it passes through on its way between its endpoints. That is, an edge may curve and does not necessarily represent a physical straight line.

Hierarchy

Index

Properties

endNodeId

endNodeId: NodeId

ID of the Node at the end of the edge.

id

id: EdgeId

An identifier, unique across all edges in a given Graph.

Optional innerLocations

innerLocations: Location[]

Additional locations that the edge passes through which are not represented by Nodes.

startNodeId

startNodeId: NodeId

ID of the Node at the start of this edge.

Generated using TypeDoc