Typed API (TypeDoc)

---

Typed API (TypeDoc) / Edge

Class: Edge<T>

Defined in: graph/src/edge.ts:22

Type Parameters

T

T = Record<string, any>

Implements

• IEdge<T>

Constructors

Constructor

new Edge<T>(options?): Edge<T>

Defined in: graph/src/edge.ts:32

Parameters

options?

EdgeProperties<T>

Returns

Edge<T>

Properties

data?

optional data: Record<string, any>

Defined in: graph/src/edge.ts:30

Implementation of

IEdge.data

---

directed

directed: boolean = false

Defined in: graph/src/edge.ts:27

Implementation of

IEdge.directed

---

from

from: IVertex<T>

Defined in: graph/src/edge.ts:25

Implementation of

IEdge.from

---

title

title: string

Defined in: graph/src/edge.ts:24

Implementation of

IEdge.title

---

to

to: IVertex<T>

Defined in: graph/src/edge.ts:26

Implementation of

IEdge.to

---

type?

optional type: string

Defined in: graph/src/edge.ts:29

Implementation of

IEdge.type

---

uuid

uuid: string

Defined in: graph/src/edge.ts:23

Implementation of

IEdge.uuid

---

weight

weight: number

Defined in: graph/src/edge.ts:28

Implementation of

IEdge.weight

Methods

getReverseEdge()

getReverseEdge(): IEdge<T>

Defined in: graph/src/edge.ts:62

Returns

IEdge<T>

the reverse edge, if existing

Implementation of

IEdge.getReverseEdge

---

getVertices()

getVertices(): VerticesPair<T>

Defined in: graph/src/edge.ts:70

Returns

VerticesPair<T>

both ends of the edge [from, to]

Implementation of

IEdge.getVertices

---

isDirected()

isDirected(): boolean

Defined in: graph/src/edge.ts:54

Returns

boolean

Implementation of

IEdge.isDirected