modules.md

@antv/graphlib / Exports

@antv/graphlib

Table of contents

Classes

• Graph
• GraphView

Interfaces

• Edge
• GraphChangedEvent
• GraphOptions
• GraphViewOptions
• Node
• TreeData

Type Aliases

• EdgeAdded
• EdgeDataUpdated
• EdgeRemoved
• EdgeUpdated
• GraphChange
• ID
• NodeAdded
• NodeDataUpdated
• NodeRemoved
• PlainObject
• TreeIndices
• TreeStructureAttached
• TreeStructureChanged
• TreeStructureDetached

Type Aliases

EdgeAdded

Ƭ EdgeAdded<D>: Object

Type parameters

Name	Type
D	extends PlainObject

Type declaration

Name	Type
type	"EdgeAdded"
value	Edge<D>

Defined in

src/types.ts:162

---

EdgeDataUpdated

Ƭ EdgeDataUpdated<D>: Object

Type parameters

Name	Type
D	extends PlainObject

Type declaration

Name	Type
id	ID
newValue	any
oldValue	any
propertyName?	PropertyKey
type	"EdgeDataUpdated"

Defined in

src/types.ts:180

---

EdgeRemoved

Ƭ EdgeRemoved<D>: Object

Type parameters

Name	Type
D	extends PlainObject

Type declaration

Name	Type
type	"EdgeRemoved"
value	Edge<D>

Defined in

src/types.ts:167

---

EdgeUpdated

Ƭ EdgeUpdated<D>: Object

Type parameters

Name	Type
D	extends PlainObject

Type declaration

Name	Type
id	ID
newValue	ID
oldValue	ID
propertyName	"source" | "target"
type	"EdgeUpdated"

Defined in

src/types.ts:172

---

GraphChange

Ƭ GraphChange<N, E>: NodeAdded<N> | NodeRemoved<N> | NodeDataUpdated<N> | EdgeAdded<E> | EdgeRemoved<E> | EdgeUpdated<E> | EdgeDataUpdated<E> | TreeStructureAttached | TreeStructureDetached | TreeStructureChanged

Type parameters

Name	Type
N	extends PlainObject
E	extends PlainObject

Defined in

src/types.ts:132

---

ID

Ƭ ID: string | number

Supported node/edge ID type.

"1" and 1 are treated as different IDs.

Defined in

src/types.ts:8

---

NodeAdded

Ƭ NodeAdded<D>: Object

Type parameters

Name	Type
D	extends PlainObject

Type declaration

Name	Type
type	"NodeAdded"
value	Node<D>

Defined in

src/types.ts:144

---

NodeDataUpdated

Ƭ NodeDataUpdated<D>: Object

Type parameters

Name	Type
D	extends PlainObject

Type declaration

Name	Type
id	ID
newValue	any
oldValue	any
propertyName?	PropertyKey
type	"NodeDataUpdated"

Defined in

src/types.ts:154

---

NodeRemoved

Ƭ NodeRemoved<D>: Object

Type parameters

Name	Type
D	extends PlainObject

Type declaration

Name	Type
type	"NodeRemoved"
value	Node<D>

Defined in

src/types.ts:149

---

PlainObject

Ƭ PlainObject: Record<string, unknown>

Defined in

src/types.ts:10

---

TreeIndices

Ƭ TreeIndices<N>: Map<string | undefined, { childrenMap: Map<ID, Set<N>> ; parentMap: Map<ID, N> }>

Type parameters

Name
N

Defined in

src/types.ts:103

---

TreeStructureAttached

Ƭ TreeStructureAttached: Object

Type declaration

Name	Type
treeKey	string | undefined
type	"TreeStructureAttached"

Defined in

src/types.ts:188

---

TreeStructureChanged

Ƭ TreeStructureChanged: Object

Type declaration

Name	Type
newParentId	ID
nodeId	ID
oldParentId?	ID
treeKey	string | undefined
type	"TreeStructureChanged"

Defined in

src/types.ts:198

---

TreeStructureDetached

Ƭ TreeStructureDetached: Object

Type declaration

Name	Type
treeKey	string | undefined
type	"TreeStructureDetached"

Defined in

src/types.ts:193