GraphView.md

@antv/graphlib / Exports / GraphView

Class: GraphView<N, E>

Type parameters

Name	Type
N	extends PlainObject
E	extends PlainObject

Table of contents

Constructors

• constructor

Properties

• allEdgesMap
• allNodesMap
• bothEdgesMap
• cacheEnabled
• edgeFilter
• graph
• inEdgesMap
• nodeFilter
• outEdgesMap

Methods

• areNeighbors
• bfs
• checkNodeExistence
• clearCache
• dfs
• getAllEdges
• getAllNodes
• getChildren
• getDegree
• getEdge
• getEdgeDetail
• getNeighbors
• getNode
• getParent
• getPredecessors
• getRelatedEdges
• getRoots
• getSuccessors
• handleGraphChanged
• hasEdge
• hasNode
• hasTreeStructure
• refreshCache
• startAutoCache
• stopAutoCache
• updateCache

Constructors

constructor

• new GraphView<N, E>(options)

Type parameters

Name	Type
N	extends PlainObject
E	extends PlainObject

Parameters

Name	Type
options	GraphViewOptions<N, E>

Defined in

src/graphView.ts:27

Properties

allEdgesMap

• Private allEdgesMap: Map<ID, Edge<E>>

Defined in

src/graphView.ts:25

---

allNodesMap

• Private allNodesMap: Map<ID, Node<N>>

Defined in

src/graphView.ts:24

---

bothEdgesMap

• Private bothEdgesMap: Map<ID, Edge<E>[]>

Defined in

src/graphView.ts:23

---

cacheEnabled

• cacheEnabled: boolean

Defined in

src/graphView.ts:20

---

edgeFilter

• Private edgeFilter: (edge: Edge<E>) => boolean

Type declaration

▸ (edge): boolean

Parameters

Name	Type
edge	Edge<E>

Returns

boolean

Defined in

src/graphView.ts:17

---

graph

• Private graph: Graph<N, E>

Defined in

src/graphView.ts:15

---

inEdgesMap

• Private inEdgesMap: Map<ID, Edge<E>[]>

Defined in

src/graphView.ts:21

---

nodeFilter

• Private nodeFilter: (node: Node<N>) => boolean

Type declaration

▸ (node): boolean

Parameters

Name	Type
node	Node<N>

Returns

boolean

Defined in

src/graphView.ts:16

---

outEdgesMap

• Private outEdgesMap: Map<ID, Edge<E>[]>

Defined in

src/graphView.ts:22

Methods

areNeighbors

▸ areNeighbors(firstNodeId, secondNodeId): boolean

Parameters

Name	Type
firstNodeId	ID
secondNodeId	ID

Returns

boolean

Defined in

src/graphView.ts:191

---

bfs

▸ bfs(id, fn, direction?): void

Parameters

Name	Type	Default value
id	ID	undefined
fn	(node: Node<N>) => void	undefined
direction	"in" | "out" | "both"	'out'

Returns

void

Defined in

src/graphView.ts:307

---

checkNodeExistence

▸ Private checkNodeExistence(id): void

Parameters

Name	Type
id	ID

Returns

void

Defined in

src/graphView.ts:181

---

clearCache

▸ clearCache(): void

Clear all cache data. Therefore getAllNodes() will return []. If you want to disable caching, use graphView.cacheEnabled = false instead.

Returns

void

Defined in

src/graphView.ts:55

---

dfs

▸ dfs(id, fn, direction?): void

Parameters

Name	Type	Default value
id	ID	undefined
fn	(node: Node<N>) => void	undefined
direction	"in" | "out" | "both"	'out'

Returns

void

Defined in

src/graphView.ts:320

---

getAllEdges

▸ getAllEdges(): Edge<E>[]

Returns

Edge<E>[]

Defined in

src/graphView.ts:300

---

getAllNodes

▸ getAllNodes(): Node<N>[]

Returns

Node<N>[]

Defined in

src/graphView.ts:293

---

getChildren

▸ getChildren(id, treeKey?): Node<N>[]

Parameters

Name	Type
id	ID
treeKey?	string

Returns

Node<N>[]

Defined in

src/graphView.ts:280

---

getDegree

▸ getDegree(id, direction?): number

Parameters

Name	Type
id	ID
direction?	"in" | "out" | "both"

Returns

number

Defined in

src/graphView.ts:221

---

getEdge

▸ getEdge(id): Edge<E>

Parameters

Name	Type
id	ID

Returns

Edge<E>

Defined in

src/graphView.ts:250

---

getEdgeDetail

▸ getEdgeDetail(id): Object

Parameters

Name	Type
id	ID

Returns

Object

Name	Type
edge	Edge<E>
source	Node<N>
target	Node<N>

Defined in

src/graphView.ts:258

---

getNeighbors

▸ getNeighbors(id): Node<N>[]

Parameters

Name	Type
id	ID

Returns

Node<N>[]

Defined in

src/graphView.ts:237

---

getNode

▸ getNode(id): Node<N>

Parameters

Name	Type
id	ID

Returns

Node<N>

Defined in

src/graphView.ts:198

---

getParent

▸ getParent(id, treeKey?): null | Node<N>

Parameters

Name	Type
id	ID
treeKey?	string

Returns

null | Node<N>

Defined in

src/graphView.ts:285

---

getPredecessors

▸ getPredecessors(id): Node<N>[]

Parameters

Name	Type
id	ID

Returns

Node<N>[]

Defined in

src/graphView.ts:231

---

getRelatedEdges

▸ getRelatedEdges(id, direction?): Edge<E>[]

Parameters

Name	Type
id	ID
direction?	"in" | "out" | "both"

Returns

Edge<E>[]

Defined in

src/graphView.ts:206

---

getRoots

▸ getRoots(treeKey?): Node<N>[]

Parameters

Name	Type
treeKey?	string

Returns

Node<N>[]

Defined in

src/graphView.ts:276

---

getSuccessors

▸ getSuccessors(id): Node<N>[]

Parameters

Name	Type
id	ID

Returns

Node<N>[]

Defined in

src/graphView.ts:225

---

handleGraphChanged

▸ Private handleGraphChanged(event): void

Parameters

Name	Type
event	GraphChangedEvent<N, E>

Returns

void

Defined in

src/graphView.ts:134

---

hasEdge

▸ hasEdge(id): boolean

Parameters

Name	Type
id	ID

Returns

boolean

Defined in

src/graphView.ts:244

---

hasNode

▸ hasNode(id): boolean

Parameters

Name	Type
id	ID

Returns

boolean

Defined in

src/graphView.ts:185

---

hasTreeStructure

▸ hasTreeStructure(treeKey): boolean

Parameters

Name	Type
treeKey	undefined | string

Returns

boolean

Defined in

src/graphView.ts:272

---

refreshCache

▸ refreshCache(): void

Fully refresh all cache data to the current graph state.

Returns

void

Defined in

src/graphView.ts:66

---

startAutoCache

▸ startAutoCache(): void

Returns

void

Defined in

src/graphView.ts:125

---

stopAutoCache

▸ stopAutoCache(): void

Returns

void

Defined in

src/graphView.ts:130

---

updateCache

▸ updateCache(involvedNodeIds): void

Instead of a fully refreshment, this method partially update the cache data by specifying involved(added, removed, updated) nodes. It's more efficient when handling small changes on a large graph.

Parameters

Name	Type
involvedNodeIds	Set<ID> | ID[]

Returns

void

Defined in

src/graphView.ts:76