JavaScript is required

API 参考

本页对应英文版 API Reference,用于按能力域汇总 relation-graph 图实例的主要公开 API。这里不追求逐项展开每个参数细节,而是建立“这个实例能做什么”的整体索引。

实例访问

  • 业务代码最终围绕 graphInstance 工作。
  • 不同平台拿到实例的方式不同,但实例能力保持高度一致。

API 组织方式

主要可以分成以下几类:

  1. 数据查询
  2. 图分析
  3. 数据修改
  4. 布局管理
  5. 视图与坐标
  6. 缩放与平移
  7. 创建与事件
  8. 编辑状态
  9. 连线渲染
  10. 配置更新
  11. 工具方法

数据查询

  • 节点查询
  • 连线查询
  • 关系对象查询
  • 当前配置查询

图分析

  • 关系遍历
  • 网络分析
  • 空间查询

数据修改

  • 新增节点 / 连线
  • 删除节点 / 连线
  • 更新节点 / 连线
  • 批量操作

布局管理

  • 触发布局
  • 切换布局配置
  • 手动控制是否自动布局

视图与坐标变换

  • 坐标转换
  • 元素命中检测
  • 当前视图矩形相关方法

缩放与平移

  • 缩放
  • 设置缩放比例
  • 平移画布
  • 居中、聚焦、适配内容

创建与事件

  • 交互式创建节点
  • 交互式创建连线
  • 节点展开 / 折叠
  • 注册和移除事件处理器

编辑状态管理

  • 设置编辑中的节点
  • 设置编辑中的连线
  • 控制编辑模式相关状态

连线渲染 API

  • 生成连线路径
  • 读取连线文字样式
  • 使用不同线形与连接点策略

虚拟连线与连接目标

  • 管理虚拟连线
  • 获取或注册连接目标
  • 自定义目标渲染器

配置与选项

  • 读取当前配置
  • 更新配置
  • 动态切换交互或布局行为

工具方法

  • 生成 ID
  • 调试日志
  • 导出图片
  • 全屏切换

阅读建议

如果你准备直接调用 API,建议同时阅读:

  1. 图实例 API
  2. 类型定义
  3. 配置文档
  4. 数据 CRUD