跳到主要内容

Diagram API 概述

Diagram 方法​

名称描述
addShape()创建自定义形状
autoPlace()按层级结构自动排列已连接的图表形状
collapseItem()隐藏目标形状的所有子项,或折叠组/泳道
destructor()移除图表实例并释放已占用的资源
expandItem()显示目标形状的所有子项,或展开分组/泳道
getScrollState()返回 diagram 内部滚动的位置
locate()从指定的 HTML 事件或标签中获取项目的 ID
paint()重绘 Diagram
scrollTo()将 Diagram 的内部滚动位置设置为指定位置
showItem()调整滚动位置以使目标项可见

Diagram 事件​

名称描述
afterCollapse在某个项目折叠后触发
afterExpand在某个项目展开后触发
afterSubmenuOpen在子表头的菜单打开后触发
beforeCollapse在折叠项之前触发
beforeExpand在展开项之前触发
beforeSubmenuOpen在子表头菜单打开之前触发
emptyAreaClick在当前 Diagram 区域的空白处点击时触发
emptyAreaDblClick在当前 Diagram 区域的空白处双击时触发
emptyAreaMouseDown当指针位于当前 Diagram 区域的空白处并按下指针设备按钮时触发
groupClick在单击组时触发
groupDblClick在双击组时触发
groupHeaderClick在单击组的表头时触发
groupHeaderDblClick在双击组的表头时触发
groupMouseDown当指针悬停在组上方且按下指针设备按钮时触发
itemClick在单击某个项目时触发
itemDblClick在双击某个项目时触发
itemMouseDown当指针悬停在项目上方且按下指针设备按钮时触发
itemMouseOut当指针设备移出某个项目时触发
itemMouseOver当指针设备位于某个项目上方时触发
lineClick在点击连接线时触发
lineDblClick在双击线条时触发
lineMouseDown当指针位于连接线上方并按下指针设备按钮时触发
lineTitleClick在点击线条的文本元素时触发
lineTitleDblClick在双击线条的文本元素时触发
lineTitleMouseDown当指针悬停在线条的文本元素上方并按下指点设备按钮时触发
scroll当 Diagram 被滚动时触发
shapeClick点击形状时触发
shapeDblClick双击形状时触发
shapeIconClick点击形状工具栏图标时触发
shapeMouseDown当指针位于形状上方且按下指点设备按钮时触发

Diagram 属性​

名称描述
autoplacement可选。一个用于形状自动布局配置设置的对象
defaults可选。用于设置形状或连线默认配置的对象
defaultShapeType可选。形状的默认类型
exportStyles可选。定义导出 Diagram 时发送给导出服务的样式
lineConfig可选。包含连接线默认配置的对象
margin可选。一个对象,包含用于定位图表中项目的边距设置
scale可选。定义 Diagram 的缩放比例
select可选。在 Diagram 中启用选择功能
toolbar可选。用于为项目设置带按钮的工具栏的图标对象数组
type必需。定义 Diagram 初始化的模式
typeConfig可选。为处于 mindmap 和 PERT 模式的 Diagram 提供配置设置的对象