combo 实例方法

阅读时间约 2 分钟

Combo 继承自 Node,具有 Node 的所有特性。本文仅介绍 Combo 类的通用方法,内置节点见 内置 Combo 文档demo,自定义节点见 自定义 Combo 文档demo

combo.getChildren()

获取 Combo 中所有的子元素,包括 Combo 和 Node。

返回值

  • 返回值为子 node 和 combo 的集合:{ nodes: INode[], combos: ICombo[] }

用法

const elements = combo.getChildren();

combo. getNodes()

获取 Combo 中所有子节点。

返回值

  • 返回值类型为 INode[]

combo. getCombos()

获取 Combo 中所有子 combo。

返回值

  • 返回值类型为 ICombo[]

combo. addChild(item: INode | ICombo)

向 Combo 中添加子 Node 或子 Combo。

参数

名称类型是否必选描述
itemINode / ICombo节点或 Combo 的实例

返回值

  • 类型: boolean
  • 含义:返回 true 表示添加成功。

用法

const node = graph.findById('node1');

// 如果返回结果为 true,则说明添加成功
const result = combo.addChild(node);

combo. addNode(node: string | INode)

向 combo 中添加节点。

参数

名称类型是否必选描述
nodestring / INode节点 ID 或节点实例

返回值

  • 类型: boolean
  • 含义:返回 true 表示添加成功。

combo. addCombo(combo: ICombo)

向 combo 中添加 combo。

参数

名称类型是否必选描述
comboICombocombo 实例

返回值

  • 类型: boolean
  • 含义:返回 true 表示添加成功。

combo. removeChild(item: ICombo | INode)

移除子元素(子节点或子 combo)。

参数

名称类型是否必选描述
itemINode / ICombo节点或 Combo 的实例

返回值

  • 类型: boolean
  • 含义:返回 true 表示移除成功。

combo. removeCombo(combo: ICombo)

移除指定的子 combo。注意:移除后 combo 不再属于该父 Combo,但没有被删除。需要删除 combo 请调用 graph.removeItem

参数

名称类型是否必选描述
comboIComboCombo 的实例

返回值

  • 类型: boolean
  • 含义:返回 true 表示移除成功。

combo. removeNode(node: INode)

移除指定的子 Node。注意:移除后该节点不再属于该 Combo,但没有被删除。需要删除节点请调用 graph.removeItem

参数

名称类型是否必选描述
nodeINode节点 ID 或节点实例

返回值

  • 类型: boolean
  • 含义:返回 true 表示移除成功。