Editor API 概览
Editor 方法
| Name | 描述 |
|---|---|
| destructor() | 移除 diagram editor 实例并释放占用的资源 |
| import() | 将数据从现有的 diagram 导入到 editor 中 |
| paint() | 重新绘制 editor |
| parse() | 从本地数据源将数据加载到 editor 中 |
| serialize() | 将编辑器的数据序列化为 JSON 对象数组 |
| zoomIn() | 放大图表 |
| zoomOut() | 缩小图表 |
Editor 事件
| Name | 描述 |
|---|---|
| afterGroupMove | 当组或泳道移动一个网格步长时触发 |
| afterItemCatch | 元素被捕获后触发 |
| afterItemMove | 当某一项目按网格步长移动时触发 |
| afterItemResize | 在项目大小发生变化后触发 |
| afterItemRotate | 在项目旋转后触发 |
| afterLineTitleMove | 当连线的文本元素按网格步长移动时触发 |
| afterShapeIconClick | 在点击项目工具栏中的控件后触发 |
| afterShapeMove | 在形状移动一个网格步长时触发 |
| beforeGroupMove | 在组或泳道被移动之前触发 |
| beforeItemCatch | 在项目被捕获之前触发 |
| beforeItemMove | 在项目被移动之前触发 |
| beforeItemResize | 在项目的大小被更改之前触发 |
| beforeItemRotate | 在项目旋转之前触发 |
| beforeLineTitleMove | 在线条的文本元素移动之前触发 |
| beforeShapeIconClick | 在点击项目专属工具栏中的控件之前触发 |
| beforeShapeMove | 在形状移动之前触发 |
| groupMoveEnd | 在组或泳道移动之后触发 |
| itemMoveEnd | 在元素移动完成后触发 |
| itemResizeEnd | 在元素的调整大小操作完成后（用户释放鼠标按键时）触发 |
| itemRotateEnd | 在元素的旋转操作完成后（用户释放鼠标按键时）触发 |
| itemTarget | 当被移动的元素悬停在目标元素上方时触发 |
| lineTitleMoveEnd | 在线条的文本元素移动完成后触发 |
| shapeMoveEnd | 在形状移动后触发 |
| shapeResize | 在形状调整大小后触发 |
| zoomIn | 在点击“放大”按钮或调用 zoomIn() 方法后触发 |
| zoomOut | 在点击“缩小”按钮或调用 zoomOut() 方法后触发 |
Editor 属性
| Name | 描述 |
|---|---|
| autoplacement | 可选。一个用于配置形状自动布局的对象 |
| connectionPoints | 可选。启用/禁用通过连接控件连接形状的功能 |
| defaults | 可选。用于设置形状或线条默认配置的对象 |
| editMode | 可选。隐藏/显示 editor 的左右面板 |
| grid | 可选。启用/禁用在 Editor 画布上显示的网格 |
| gridStep | 可选。设置网格步长的大小，该步长决定了移动项目时的步进距离 |
| hotkeys | 可选。允许管理 Editor 中各种操作的键盘快捷键（hotkeys） |
| itemsDraggable | 可选。启用/禁用将项目从一个父项目拖动到另一个父项目 |
| lineConfig | 可选。一个包含连接线默认配置的对象 |
| magnetic | 可选。定义在移动形状时是否显示对齐线；如果显示，还可以配置其外观 |
| resizePoints | 可选。启用或禁用通过调整大小控件来调整形状大小的功能 |
| scale | 可选。定义 Diagram Editor 的缩放比例 |
| shapeToolbar | 可选。定义应在图表项的个人工具栏中显示哪些控件 |
| shapeType | 可选。元素的类型 |
| type | 必填。指定 Diagram Editor 的模式 |
| view | 用于配置 Diagram Editor 的 Toolbar、Shapebar 和 Editbar 视图的对象 |