ssy/lan-manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
pve-enhance
lan-manager/web/node_modules/@antv/graphlib/docs/classes/Graph.md
openclaw 0a5f6a8047 Initial commit: Lan-manager project code 
- Go backend (server/)
- Frontend (web/, server/static/)
- Database and deployment files
- Scripts and docs

Co-Authored-By: 狸花猫/Claude-Qwen3.6-Plus 🐾
2026-04-20 00:52:58 +08:00

28 KiB
Raw Permalink Blame History

@antv/graphlib / Exports / Graph

Class: Graph<NodeIDType, NodeType, EdgeType, GraphType>

Type parameters

Name Type
NodeIDType string
NodeType Record<string, any>
EdgeType Record<string, any>
GraphType string

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new Graph<NodeIDType, NodeType, EdgeType, GraphType>(options?)

Type parameters

Name Type
NodeIDType string
NodeType Record<string, any>
EdgeType Record<string, any>
GraphType string

Parameters

Name Type
options GraphOption

Defined in

Graph/index.ts:112

Properties

GRAPH_NODE

• Private GRAPH_NODE: NodeIDType

Defined in

Graph/index.ts:73

childrenMap

• Private Optional childrenMap: Map<NodeIDType, Map<NodeIDType, boolean>>

description Map for children relationship

description.zh-cn 子孙关系的映射

Defined in

Graph/index.ts:139

compound

• Private compound: boolean = false

Defined in

Graph/index.ts:71

defaultEdgeLabelFn

• Private defaultEdgeLabelFn: (v: NodeIDType, w: NodeIDType, name?: string) => undefined | EdgeType

Type declaration

▸ (v, w, name?): undefined | EdgeType

description return edge label with its id

description.zh-cn 返回边的默认的标签

Parameters
Name Type
v NodeIDType
w NodeIDType
name? string
Returns

undefined | EdgeType

Defined in

Graph/index.ts:106

defaultNodeLabelFn

• Private defaultNodeLabelFn: (v: NodeIDType) => undefined | NodeType

Type declaration

▸ (v): undefined | NodeType

description return node label with its id

description.zh-cn 返回节点的默认的标签

Parameters
Name Type
v NodeIDType
Returns

undefined | NodeType

Defined in

Graph/index.ts:100

directed

• Private directed: boolean = true

Defined in

Graph/index.ts:67

edgeCountNum

• Private edgeCountNum: number = 0

description Number of edges in the graph

description.zh-cn 节点的数量

default 0

Defined in

Graph/index.ts:94

edgesLabelsMap

• Private edgesLabelsMap: Map<string, undefined | EdgeType>

description Map for edge label

description.zh-cn 边的标签的映射

Defined in

Graph/index.ts:173

edgesMap

• Private edgesMap: Map<string, DefaultEdgeType<NodeIDType, EdgeType>>

description Map for edge object

description.zh-cn 边的映射

Defined in

Graph/index.ts:167

inEdgesMap

• Private inEdgesMap: Map<NodeIDType, Map<string, DefaultEdgeType<NodeIDType, EdgeType>>>

description Map for edges

description.zh-cn 边的映射

Defined in

Graph/index.ts:147

label

• Optional label: GraphType

description Label for this graph itself

description.zh-cn 图本身的标签（label）

default undefined

Defined in

Graph/index.ts:80

multigraph

• Private multigraph: boolean = false

Defined in

Graph/index.ts:69

nodeCountNum

• Private nodeCountNum: number = 0

description Number of nodes in the graph

description.zh-cn 节点的数量

default 0

Defined in

Graph/index.ts:87

nodesLabelMap

• Private nodesLabelMap: Map<NodeIDType, undefined | NodeType>

Defined in

Graph/index.ts:141

outEdgesMap

• Private outEdgesMap: Map<NodeIDType, Map<string, DefaultEdgeType<NodeIDType, EdgeType>>>

Defined in

Graph/index.ts:149

parentMap

• Private Optional parentMap: Map<NodeIDType, NodeIDType>

description Map for parent relationship

description.zh-cn 父子关系的映射

Defined in

Graph/index.ts:133

predecessorsMap

• Private predecessorsMap: Map<NodeIDType, Map<NodeIDType, number>>

description Map for predecessors

description.zh-cn 前驱节点的映射

Defined in

Graph/index.ts:155

successorsMap

• Private successorsMap: Map<NodeIDType, Map<NodeIDType, number>>

description Map for successors

description.zh-cn 后继节点的映射

Defined in

Graph/index.ts:161

fromJSON

▪ Static fromJSON: <NodeIDType, NodeType, EdgeType, GraphType>(json: JSONGraph<NodeIDType, NodeType, EdgeType, GraphType>) => Graph<NodeIDType, NodeType, EdgeType, GraphType> = read

Type declaration

▸ <NodeIDType, NodeType, EdgeType, GraphType>(json): Graph<NodeIDType, NodeType, EdgeType, GraphType>

description read a graph from JSON.

description.zh-cn 从 JSON 读取图。

Type parameters
Name Type
NodeIDType string
NodeType Record<string, any>
EdgeType Record<string, any>
GraphType string
Parameters
Name Type
json JSONGraph<NodeIDType, NodeType, EdgeType, GraphType>
Returns

Graph<NodeIDType, NodeType, EdgeType, GraphType>

Defined in

Graph/index.ts:762

Methods

checkCompound

▸ Private checkCompound(): void

description if graph is not compound then throw error

description.zh-cn 如果图不是复合图就报错

Returns

void

Defined in

Graph/index.ts:335

children

▸ children(node?): undefined | NodeIDType[]

description get graph's or node's children

description.zh-cn 获取图或者节点的字节点

Parameters

Name Type
node? NodeIDType

Returns

undefined | NodeIDType[]

Defined in

Graph/index.ts:408

edge

▸ edge(edgeObj): undefined | EdgeType

description Get edge between two nodes by edge object

description.zh-cn 从edgeObj获得两个节点中的一条边

Parameters

Name Type
edgeObj Object
edgeObj.name? any
edgeObj.v NodeIDType
edgeObj.w NodeIDType

Returns

undefined | EdgeType

Defined in

Graph/index.ts:660

edgeCount

▸ edgeCount(): number

description Count the edge in graph

description.zh-cn 返回图中边的数量

Returns

number

number

Defined in

Graph/index.ts:579

edgeFromArgs

▸ edgeFromArgs(v, w, name?): undefined | EdgeType

description Get edge between two nodes

description.zh-cn 获得两个节点中的一条边

Parameters

Name Type
v NodeIDType
w NodeIDType
name? any

Returns

undefined | EdgeType

Defined in

Graph/index.ts:650

edges

▸ edges(): DefaultEdgeType<NodeIDType, EdgeType>[]

description get all edges object in graph

description.zh-cn 获得图中所有的边对象

Returns

DefaultEdgeType<NodeIDType, EdgeType>[]

Defined in

Graph/index.ts:716

filterNodes

▸ filterNodes(filter): Graph<NodeIDType, NodeType, EdgeType, GraphType>

description Using node filter to create a new graph;

description.zh-cn 过滤节点并创建一个新图

Parameters

Name Type
filter (node: NodeIDType) => boolean

Returns

Graph<NodeIDType, NodeType, EdgeType, GraphType>

Defined in

Graph/index.ts:480

graph

▸ graph(): GraphType

description Get Graph label (Identity for graph)

description.zh-cn 获取图的标识符

Returns

GraphType

stirng | undefined

Defined in

Graph/index.ts:212

hasEdge

▸ hasEdge(v, w, name?): boolean

description Does two nodes has a specific edge

description.zh-cn 两个节点之间是否存在确定的一条边

Parameters

Name Type
v NodeIDType
w NodeIDType
name? any

Returns

boolean

Defined in

Graph/index.ts:672

hasNode

▸ hasNode(node): boolean

description Is the node in graph

description.zh-cn 判断节点是否在图中

Parameters

Name Type
node NodeIDType

Returns

boolean

Defined in

Graph/index.ts:329

inEdges

▸ inEdges(v, u?): undefined | DefaultEdgeType<NodeIDType, EdgeType>[]

description get edges that target at the node (could be from certain node)

description.zh-cn 获取所有指向节点的边，可以指定来源节点

Parameters

Name Type
v NodeIDType
u? NodeIDType

Returns

undefined | DefaultEdgeType<NodeIDType, EdgeType>[]

Defined in

Graph/index.ts:725

isCompound

▸ isCompound(): boolean

description Is this graph a compound graph;

description.zh-cn 这个图是否是复合图（包含嵌套节点的图）

default false

Returns

boolean

Defined in

Graph/index.ts:194

isDirected

▸ isDirected(): boolean

description Is the graph directed or not

description.zh-cn 这个图是否是有向图

default true

Returns

boolean

Defined in

Graph/index.ts:180

isLeaf

▸ isLeaf(node): boolean

description Is the node a leaf node

description.zh-cn 判断节点是否为叶子节点

Parameters

Name Type
node NodeIDType

Returns

boolean

Defined in

Graph/index.ts:467

isMultigraph

▸ isMultigraph(): boolean

description Is this graph contains more than one graph data

description.zh-cn 这个图是否包含多个图

default false

Returns

boolean

Defined in

Graph/index.ts:187

neighbors

▸ neighbors(node): undefined | NodeIDType[]

description get node's neighbors

description.zh-cn 获取节点的所有邻居节点

Parameters

Name Type
node NodeIDType

Returns

undefined | NodeIDType[]

Defined in

Graph/index.ts:454

node

▸ node(n): undefined | NodeType

description get node label

description.zh-cn 获取节点的标签

Parameters

Name Type
n NodeIDType

Returns

undefined | NodeType

Defined in

Graph/index.ts:240

nodeCount

▸ nodeCount(): number

description Count the nodes in graph

description.zh-cn 计算图中所有节点的数量

Returns

number

number

Defined in

Graph/index.ts:234

nodeDegree

▸ nodeDegree(node): number

description Count the total edges of node

description.zh-cn 计算节点的所有边的数量

Parameters

Name Type
node NodeIDType

Returns

number

Defined in

Graph/index.ts:796

nodeEdges

▸ nodeEdges(v, w?): undefined | DefaultEdgeType<NodeIDType, EdgeType>[]

description get edges between two nodes

description.zh-cn 获取两个节点间所有的节点

Parameters

Name Type
v NodeIDType
w? NodeIDType

Returns

undefined | DefaultEdgeType<NodeIDType, EdgeType>[]

Defined in

Graph/index.ts:755

nodeInDegree

▸ nodeInDegree(node): number

description Count the in edges of node

description.zh-cn 计算节点的入边的数量

Parameters

Name Type
node NodeIDType

Returns

number

Defined in

Graph/index.ts:772

nodeOutDegree

▸ nodeOutDegree(node): number

description Count the out edges of node

description.zh-cn 计算节点的出边的数量

Parameters

Name Type
node NodeIDType

Returns

number

Defined in

Graph/index.ts:784

nodes

▸ nodes(): NodeIDType[]

description Return all nodes in graph

description 返回图中所有节点

Returns

NodeIDType[]

Defined in

Graph/index.ts:247

outEdges

▸ outEdges(w, u?): undefined | DefaultEdgeType<NodeIDType, EdgeType>[]

description get edges that from the node (could target at certain node)

description.zh-cn 获取所有来源于节点的边，可以指定目标节点

Parameters

Name Type
w NodeIDType
u? NodeIDType

Returns

undefined | DefaultEdgeType<NodeIDType, EdgeType>[]

Defined in

Graph/index.ts:740

parent

▸ parent(node): undefined | NodeIDType

description Find node's parent (compond graph only)

description.zh-cn 寻找节点的父节点 (只有复合图可以使用)

Parameters

Name Type
node NodeIDType

Returns

undefined | NodeIDType

Defined in

Graph/index.ts:347

predecessors

▸ predecessors(node): undefined | NodeIDType[]

description get node's predecessors

description.zh-cn 获取节点的所有上游节点

Parameters

Name Type
node NodeIDType

Returns

undefined | NodeIDType[]

Defined in

Graph/index.ts:432

removeEdge

▸ removeEdge(v_, w_, name?): Graph<NodeIDType, NodeType, EdgeType, GraphType>

description remove a specific edge

description.zh-cn 删除一条边

Parameters

Name Type
v_ NodeIDType
w_ NodeIDType
name? any

Returns

Graph<NodeIDType, NodeType, EdgeType, GraphType>

Defined in

Graph/index.ts:684

removeEdgeObj

▸ removeEdgeObj(__namedParameters): this

description remove a specific edge by edge object

description.zh-cn 删除一条边

Parameters

Name Type
__namedParameters Object
__namedParameters.name? any
__namedParameters.v NodeIDType
__namedParameters.w NodeIDType

Returns

this

Defined in

Graph/index.ts:708

removeFromParentsChildList

▸ Private removeFromParentsChildList(node): void

description Remove node from its parent (compond graph only)

description.zh-cn 将节点与其父节点之间的父子关系删除(只有复合图可以使用)

Parameters

Name Type
node NodeIDType

Returns

void

Defined in

Graph/index.ts:361

removeNode

▸ removeNode(node): Graph<NodeIDType, NodeType, EdgeType, GraphType>

description Remove node from graph

description.zh-cn 将节点从图中移除

Parameters

Name Type
node NodeIDType

Returns

Graph<NodeIDType, NodeType, EdgeType, GraphType>

Defined in

Graph/index.ts:527

setDefaultEdgeLabel

▸ setDefaultEdgeLabel(newDefault): this

description Set function that generate default label for edge, if param is non-function value then default label will always be this value;

description.zh-cn 设置默认获取边Label的方法，如果传入不是函数的，那么默认label 的值只会是传入值

Parameters

Name Type
newDefault any

Returns

this

Defined in

Graph/index.ts:565

setDefaultNodeLabel

▸ setDefaultNodeLabel(newDefault): this

description Set function that generate default label for node, if param is non-function value then default label will always be this value;

description.zh-cn 设置默认获取节点Label的方法，如果传入不是函数的，那么默认label 的值只会是传入值

Parameters

Name Type Description
newDefault any (node) => label | label

Returns

this

this

Defined in

Graph/index.ts:220

setEdge

▸ setEdge(v_, w_, value?, name?): Graph<NodeIDType, NodeType, EdgeType, GraphType>

description set edge value, if nodes or edges not exsit then add to graph

description.zh-cn 设置边的属性，如果边或节点不存在，那么将他们加入这个图

Parameters

Name Type
v_ NodeIDType
w_ NodeIDType
value? any
name? string

Returns

Graph<NodeIDType, NodeType, EdgeType, GraphType>

Defined in

Graph/index.ts:590

setEdgeObj

▸ setEdgeObj(edgeObj, value?): this

Parameters

Name Type
edgeObj DefaultEdgeType<NodeIDType, EdgeType>
value? EdgeType

Returns

this

Defined in

Graph/index.ts:623

setGraph

▸ setGraph(label?): this

description Set Graph label (Identity for graph)

description.zh-cn 设置图的标识符

Parameters

Name Type
label? GraphType

Returns

this

Defined in

Graph/index.ts:202

setNode

▸ setNode(node, value?): Graph<NodeIDType, NodeType, EdgeType, GraphType>

description Set Node label in graph if node not in graph then create it

description.zh-cn 设置节点的label，如果这个节点不在图中，则在图中创建这个节点

Parameters

Name Type
node NodeIDType
value? NodeType

Returns

Graph<NodeIDType, NodeType, EdgeType, GraphType>

Defined in

Graph/index.ts:270

setNodes

▸ setNodes(nodes, value?): this

description Set nodes or add nodes in batch

description.zh-cn 批量设置或者创建节点

Parameters

Name Type
nodes NodeIDType[]
value? NodeType

Returns

this

Defined in

Graph/index.ts:318

setParent

▸ setParent(node, parent?): this

description Set node's parent(default is the graph) (compond graph only)

description.zh-cn 设置节点的父节点，如果没有给定，父节点为这个图 (只有复合图可以使用)

Parameters

Name Type
node NodeIDType
parent? NodeIDType

Returns

this

Defined in

Graph/index.ts:373

setPath

▸ setPath(edges, value?): this

description Add edge using a sorted node array ([a,b,c] => a->b b->c c->a)

description.zh-cn 用一系列节点来定义一群边([a,b,c] => a->b b->c c->a)

Parameters

Name Type
edges NodeIDType[]
value? any

Returns

this

Defined in

Graph/index.ts:634

sinks

▸ sinks(): NodeIDType[]

description Return all sink nodes in graph

description 返回图中所有终点节点（出度为0）

Returns

NodeIDType[]

Defined in

Graph/index.ts:261

source

▸ source(edge): NodeIDType

description Get the source of edge

description.zh-cn 获取边的源节点

Parameters

Name Type
edge DefaultEdgeType<NodeIDType, EdgeType>

Returns

NodeIDType

Defined in

Graph/index.ts:804

sources

▸ sources(): NodeIDType[]

description Return all source nodes in graph

description 返回图中所有源头节点（入度为0）

Returns

NodeIDType[]

Defined in

Graph/index.ts:254

successors

▸ successors(node): undefined | NodeIDType[]

description get node's successors

description.zh-cn 获取节点的所有下游节点

Parameters

Name Type
node NodeIDType

Returns

undefined | NodeIDType[]

Defined in

Graph/index.ts:443

target

▸ target(edge): NodeIDType

description Get the target of edge

description.zh-cn 获取边的目标节点

Parameters

Name Type
edge DefaultEdgeType<NodeIDType, EdgeType>

Returns

NodeIDType

Defined in

Graph/index.ts:810

toJSON

▸ toJSON(): JSONGraph<NodeIDType, NodeType, EdgeType, GraphType>

Returns

JSONGraph<NodeIDType, NodeType, EdgeType, GraphType>

Defined in

Graph/index.ts:764

Reference in New Issue View Git Blame Copy Permalink