Skip to content

Typed API (TypeDoc)


Typed API (TypeDoc) / IVertex

Interface: IVertex<T>

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

Extends

Type Parameters

T

T

Properties

data?

optional data: T

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

Inherited from

VertexProperties.data


incomingEdges?

optional incomingEdges: Set<IEdge<T>>

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

Inherited from

VertexProperties.incomingEdges


outgoingEdges?

optional outgoingEdges: Set<IEdge<T>>

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

Inherited from

VertexProperties.outgoingEdges


point?

optional point: Point

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

Inherited from

VertexProperties.point


title?

optional title: string

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

Inherited from

VertexProperties.title


type?

optional type: string

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

Inherited from

VertexProperties.type


uuid?

optional uuid: string

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

Inherited from

VertexProperties.uuid

Methods

addIncomingEdge()

addIncomingEdge(incoming): boolean

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

Parameters

incoming

IEdge<T>

Returns

boolean


addOutgoingEdge()

addOutgoingEdge(outgoing): boolean

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

Parameters

outgoing

IEdge<T>

Returns

boolean


deg()

deg(): number

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

Returns

number


getAllEdges()

getAllEdges(): Set<IEdge<T>>

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

Returns

Set<IEdge<T>>


getEdgeTo()

getEdgeTo(to): IEdge<T> | undefined

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

Parameters

to

IVertex<T>

Returns

IEdge<T> | undefined


getNeighbours()

getNeighbours(): Set<IVertex<T>>

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

Returns

Set<IVertex<T>>


getReachableNeighbours()

getReachableNeighbours(): Set<IVertex<T>>

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

Returns

Set<IVertex<T>>


hasPosition()

hasPosition(): boolean

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

Returns

boolean


indeg()

indeg(): number

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

Returns

number


outdeg()

outdeg(): number

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

Returns

number


removeIncomingEdge()

removeIncomingEdge(e): boolean

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

Parameters

e

IEdge<T>

Returns

boolean


removeOutgoingEdge()

removeOutgoingEdge(e): boolean

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

Parameters

e

IEdge<T>

Returns

boolean

Built with VitePress – Released under the MIT License.