Class Edge

An edge connects two vertices.

Hierarchy (view full)

Base
- Edge

Index

Methods

getAttribute getCost getId inspect isDirected setAttribute setCost setDirected

Properties

cost data directed graph id source target type

Methods

getAttribute

getAttribute(key): string
Sets some attribute on the object.
Parameters
- key: string
Returns string
Inherited from Base.getAttribute

getCost

getCost(): number
Gets the cost for this edge. Defaults to 1.

Returns number
Edge cost.

getId

getId(): string
Gets the id for this Edge. *

Returns string
Edge id.

inspect

inspect(): string
Returns a string representation of the Edge. *

Returns string
Edge dumped to a string.

isDirected

isDirected(): boolean
Gets whether or not the Edge is directed.

Returns boolean
True if the Edge is directed (unidirectional), false otherwise.

setAttribute

setAttribute(key, value): void
Gets some attribute from the object.
Parameters
- key: string
- value: string
Returns void
Inherited from Base.setAttribute

setCost

setCost(c): void
Sets the cost for this edge.
Parameters
- c: number
  Edge cost.
Returns void

setDirected

setDirected(directed): void
Sets whether or not the Edge is directed.
Parameters
- directed: boolean
Returns void

Properties

cost

cost: number

Edge cost. Defaults to 1.

data

data: ObjectData

Underlying data for the object.

directed

directed: boolean

Whether or not the edge is directed. Defaults to true.

`Readonly`graph

graph: Graph

The underlying graph.

id

id: string

ID of the edge. Your code should never change this value.

source

source: Vertex

Source of the Edge.

target

target: Vertex

Target of the Edge.

type

type: string

Type of the object

Version :