Typed API (TypeDoc)

---

Typed API (TypeDoc) / Vertex

Class: Vertex<T>

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

Type Parameters

T

T = Record<string, any>

Implements

• IVertex<T>

Constructors

Constructor

new Vertex<T>(options): Vertex<T>

Defined in: graph/src/vertex.ts:41

Parameters

options

VertexProperties<T> = ...

Returns

Vertex<T>

Properties

data?

optional data: T

Defined in: graph/src/vertex.ts:39

Implementation of

IVertex.data

---

incomingEdges

incomingEdges: Set<IEdge<T>>

Defined in: graph/src/vertex.ts:36

Implementation of

IVertex.incomingEdges

---

outgoingEdges

outgoingEdges: Set<IEdge<T>>

Defined in: graph/src/vertex.ts:35

Implementation of

IVertex.outgoingEdges

---

point

point: Point

Defined in: graph/src/vertex.ts:37

Implementation of

IVertex.point

---

title

title: string

Defined in: graph/src/vertex.ts:33

Implementation of

IVertex.title

---

type?

optional type: string

Defined in: graph/src/vertex.ts:38

Implementation of

IVertex.type

---

uuid

uuid: string

Defined in: graph/src/vertex.ts:34

Implementation of

IVertex.uuid

Methods

addIncomingEdge()

addIncomingEdge(incoming): boolean

Defined in: graph/src/vertex.ts:91

Parameters

incoming

IEdge<T>

Returns

boolean

Implementation of

IVertex.addIncomingEdge

---

addOutgoingEdge()

addOutgoingEdge(outgoing): boolean

Defined in: graph/src/vertex.ts:101

Parameters

outgoing

IEdge<T>

Returns

boolean

Implementation of

IVertex.addOutgoingEdge

---

deg()

deg(): number

Defined in: graph/src/vertex.ts:111

Returns

number

Implementation of

IVertex.deg

---

getAllEdges()

getAllEdges(): Set<IEdge<T>>

Defined in: graph/src/vertex.ts:64

Returns

Set<IEdge<T>>

Implementation of

IVertex.getAllEdges

---

getEdgeTo()

getEdgeTo(to): IEdge<T> | undefined

Defined in: graph/src/vertex.ts:87

Parameters

to

IVertex<T>

Returns

IEdge<T> | undefined

Implementation of

IVertex.getEdgeTo

---

getNeighbours()

getNeighbours(): Set<IVertex<T>>

Defined in: graph/src/vertex.ts:68

Returns

Set<IVertex<T>>

Implementation of

IVertex.getNeighbours

---

getReachableNeighbours()

getReachableNeighbours(): Set<IVertex<T>>

Defined in: graph/src/vertex.ts:79

Returns

Set<IVertex<T>>

Implementation of

IVertex.getReachableNeighbours

---

hasPosition()

hasPosition(): boolean

Defined in: graph/src/vertex.ts:60

Returns

boolean

Implementation of

IVertex.hasPosition

---

indeg()

indeg(): number

Defined in: graph/src/vertex.ts:115

Returns

number

Implementation of

IVertex.indeg

---

outdeg()

outdeg(): number

Defined in: graph/src/vertex.ts:119

Returns

number

Implementation of

IVertex.outdeg

---

removeIncomingEdge()

removeIncomingEdge(e): boolean

Defined in: graph/src/vertex.ts:97

Parameters

e

IEdge<T>

Returns

boolean

Implementation of

IVertex.removeIncomingEdge

---

removeOutgoingEdge()

removeOutgoingEdge(e): boolean

Defined in: graph/src/vertex.ts:107

Parameters

e

IEdge<T>

Returns

boolean

Implementation of

IVertex.removeOutgoingEdge