logo

X6

  • 文档
  • API
  • 图表示例
  • 常见问题
  • 更新日志
  • XFlow
  • 所有产品antv logo arrow
  • 2.x
  • 开始
    • 简介
    • 快速上手
  • 组件
    • XFlowGraph 画布
    • Background 背景
    • Grid 网格
    • Clipboard 复制粘贴
    • History 撤销重做
    • Minimap 小地图
    • Snapline 对齐线
    • Transform 图形变换
    • Control 控制器
  • Hook
    • useGraphInstance
    • useGraphStore
    • useGraphEvent
    • useDnd
    • useClipboard
    • useExport
    • useHistory
    • useKeyboard
  • Store

Store

上一篇
useKeyboard

Resources

Ant Design
Galacea Effects
Umi-React 应用开发框架
Dumi-组件/文档研发工具
ahooks-React Hooks 库

社区

体验科技专栏
seeconfSEE Conf-蚂蚁体验科技大会

帮助

GitHub
StackOverflow

more products更多产品

Ant DesignAnt Design-企业级 UI 设计语言
yuque语雀-知识创作与分享工具
EggEgg-企业级 Node 开发框架
kitchenKitchen-Sketch 工具集
GalaceanGalacean-互动图形解决方案
xtech蚂蚁体验科技
© Copyright 2025 Ant Group Co., Ltd..备案号:京ICP备15032932号-38

Loading...

xflow 对画布的数据进行了统一的管理,整个画布的数据存在一个 store 中,这让开发变得非常容易

你可以使用 useGraphStore 方便快捷的操作 store , 从而更新画布数据, 实现更新画布

初始化状态

initData(data, options)

这个函数用于初始化状态管理器,设置初始的节点和边。

参数:

  • data:一个对象,包含nodes和edges两个数组,分别存储节点和边的数据。
  • options:一个可选的对象,当设置为{ silent: true }时,初始化的操作不会被记录在变动列表changeList中。

节点操作

addNodes(ns, options)

添加新的节点到状态管理器中。

参数:

  • ns:一个节点对象数组。
  • options:一个可选的对象。当{ silent: true }时,添加操作不会被记录在变动列表中。

removeNodes(ids, options)

通过ID数组移除节点。

参数:

  • ids:一个包含节点ID的数组。
  • options:一个可选的对象。当{ silent: true }时,移除操作不会被记录在变动列表中。

updateNode(id, data, options)

通过ID更新某个节点。不允许修改节点的id或shape属性。

参数:

  • id:要更新的节点的ID。
  • data:一个对象或者一个函数,包含要更新的数据。
  • options:一个可选的对象。当{ silent: true }时,更新操作不会被记录在变动列表中。

边操作

addEdges(es, options)

添加新的边到状态管理器中。

参数:

  • es:一个边对象数组。
  • options:一个可选的对象。当{ silent: true }时,添加操作不会被记录在变动列表中。

removeEdges(ids, options)

通过ID数组移除边。

参数:

  • ids:一个包含边ID的数组。
  • options:一个可选的对象。当{ silent: true }时,移除操作不会被记录在变动列表中。

updateEdge(id, data, options)

通过ID更新某个边。不允许修改边的id或shape属性。

参数:

  • id:要更新的边的ID。
  • data:一个对象或者一个函数,包含要更新的数据。
  • options:一个可选的对象。当{ silent: true }时,更新操作不会被记录在变动列表中。