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

useGraphStore

上一篇
useGraphInstance
下一篇
useGraphEvent

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...

获取当前画布 store 以及改变 store 的 Hook

基础用法

const nodes = useGraphStore((state) => state.nodes);

使用 useGraphStore 可以方便的对画布的数据进行增删改查 下面是使用 useGraphStore 添加节点和删除节点的简单示例

API

useGraphStore<T, U>(selector: (state: U) => T): U

返回值

参数描述类型默认值
U画布store的actionOptions-

参数

参数描述类型默认值
selector获取store的action的函数(state: Options) => Options-

Options 参数如下

参数描述类型默认值
nodes画布所有节点NodeOptions[]-
edges画布所有边EdgeOptions[]-
changeListstore操作记录(init | addNodes | removeNodes | updateNode | addEdges | removeEdges | updateEdge )[]-
initData初始化数据(data: {nodes: NodeOptions[], edges: EdgeOptions[] }, options?: {silent?: boolean}) => void-
addNodes添加节点(ns: NodeOptions[], options?: {silent?: boolean}) => void-
removeNodes移除节点(ids: string[], options?: {silent?: boolean}) => void-
updateNode更新节点(id: string, data: UpdateNodeDataOrFn, options?: {silent?: boolean}) => void-
addEdges添加边(es: EdgeOptions[], options?: {silent?: boolean}) => void-
removeEdges移除边(ids: string[], options?: {silent?: boolean}) => void-
updateEdge更新边(id: string, data: UpdateEdgeDataOrFn, options?: {silent?: boolean}) => void-
clearChangeList情况操作记录() => void-