Skip to content

Typed API (TypeDoc)


Typed API (TypeDoc) / IEdge

Interface: IEdge<V> ​

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

Extends ​

Type Parameters ​

V ​

V

Properties ​

data? ​

optional data: Record<string, any>

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

Inherited from ​

EdgeProperties.data


directed? ​

optional directed: boolean

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

Inherited from ​

EdgeProperties.directed


from ​

from: IVertex<V>

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

Inherited from ​

EdgeProperties.from


title? ​

optional title: string

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

Inherited from ​

EdgeProperties.title


to ​

to: IVertex<V>

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

Inherited from ​

EdgeProperties.to


type? ​

optional type: string

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

Inherited from ​

EdgeProperties.type


uuid? ​

optional uuid: string

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

Inherited from ​

EdgeProperties.uuid


weight? ​

optional weight: number

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

Inherited from ​

EdgeProperties.weight

Methods ​

getReverseEdge() ​

getReverseEdge(): IEdge<V>

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

Returns ​

IEdge<V>


getVertices() ​

getVertices(): VerticesPair<V>

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

Returns ​

VerticesPair<V>


isDirected() ​

isDirected(): boolean

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

Returns ​

boolean

Built with VitePress – Released under the MIT License.