接口导航

提示

GraphVis组件库，提供了大量的数据操作和交互处理接口，可供业务系统进行产品功能的组装和交互逻辑的整合。

一、数据添加或查询类型接口

序号	接口	说明
1	addGraph	批量添加图数据
2	activeAddData	动态扩展节点扩展数据
3	addNode	添加单个节点
4	addNodes	添加多个节点
5	addEdge	添加单个关系连线
6	addEdges	添加多个关系连线
7	getNodes	获取图中所有点
8	getEdges	获取图中所有边
9	getGraphData	获取可视化图数据
10	getVisibleData	获取显示状态的图数据
11	getNodeById	据节点ID获取节点对象
12	getEdgeById	根据连线ID获取连线对象
13	getSelectedNodes	获取所有已选中的节点

二、删除数据类操作接口

序号	接口	说明
1	clearAll	清空所有数据
2	deleteNodes	删除指定的多个节点
3	deleteNode	删除单个指定的节点
4	deleteLinks	删除指定的多条连线
5	deleteLink	删除指定的单条连线
6	destory	销毁图客户的对象和数据,一般用于视图页面关闭时，释放内存数据
7	removeSelectNodes	删除已选中的节点

三、快捷操作类接口

序号	接口	说明
1	moveCenter	将视图缩放到指定大小后居中显示，默认原始大小居中
2	moveNodeToCenter	将节点移动到画布中心位置
3	onlyShowSelectedNode	只显示已选中节点
4	refreshView	刷新可视化视图
5	reverseSelectNodes	节点反选，对选中的取消选中，对未选中的设置为选中状态
6	selectedAllNodes	将图中所有节点设置为选中状态
7	selectedEdge	选中连线及其两个端点节点
8	selectedNeighbers	选中指定节点的邻居节点
9	showAllLink	显示所有连线
10	showAllNode	显示所有节点
11	zoomFit	场景视图大小自适应缩放
12	zoomIn	场景视图缩小
13	zoomOut	场景视图放大
14	zoomOriginal	场景视图恢复原始1:1大小
15	hideAllLink	隐藏所有连线
16	hideIsolatedNodes	隐藏孤立节点
17	removeAllGroup	清除所有的分组
18	removeCurrentLink	删除当前选中的连线
19	scaleGraph	缩放图数据节点坐标
20	rotateGraph	旋转视图数据节点坐标

四、功能类接口

序号	接口	说明
1	addNodesInGroup	将多个节点加入一个分组内
2	addToSelectedElements	将指定的可视化元素加入场景选中对象中
3	applyLinkWeight	按权重缩放连线的宽度
4	applyNodeSize	按度缩放节点大小
5	beginAddLine	以当前节点为起点开始拖动连线
6	convertScenePosition	将页面事件位置转换为可视化场景中的坐标位置
7	covertPagePosition	将场景中的指定坐标转换为页面上的位置
8	detecyCycles	检测图中是否存在环路
10	exportJsonFile	导出图数据JSON文件
11	getConnectLinkOfNodes	获取多个节点之间存在的关系连线
12	getMouseDownPosition	获取鼠标按下的位置
13	getSnapshotImage	获取当前窗口的快照图片base64数据，可保存至服务端或直接显示
14	getViewCenter	获取视图的中心坐标
15	getZoomRatio	获取场景的缩放系数
16	showLoadProcess	显示loading进度条
17	hideLoadProcess	隐藏loading进度条
18	mergeNodes	合并多个节点为一个整体节点
19	parsePathFromNodes	通过路径中的节点数组解析出路径(有向的路径)
20	saveImage	根据配置保存指定大小、文件类型和名称，并可带有水印信息的图片到本地
21	serialized	获取序列化的图数据对象，可以保存为JSON字符串，下次重新绘图
22	removeGroup	删除指定的分组对象
23	removeEventListener	给指定类型的元素绑定对应操作事件，类型有 场景：scene 节点：node, 连线：link
24	removeAllEventListener	移除图中节点或连线对应的所有事件
25	addNodeForDrag	拖拽外部数据到画布上添加节点

五、功能配置类接口

序号	接口	说明
1	resetConfig	重新定义可视化全局配置
2	resetEdgeAttributes	重新设置可视化连线对象属性
3	resetNodeAttributes	重新设置节点的属性
4	setDragHideLine	用于开启或关闭拖动画布或元素时，隐藏连线，提升交互性能
5	setShowDetailScale	用于控制缩放到该系数时，隐藏文字等信息，大于该系数时，完全显示信息
6	setSmoothWheelMode	开启或关闭鼠标顺滑模式，开启时滚动鼠标会隐藏连线（大量数据时提升交互性能）
7	setStaticMode	设置为静态模式时，只有鼠标点击相关的操作才能触发交互事件，鼠标移动不产生交互（大量数据时提升交互性能）
8	setZoomRange	设置画布的缩放区间
10	setMouseModel	设置鼠标模式
11	setSceneDragAble	设置画布场景是否可拖动
12	reConfigNodeCluster	统一配置节点的分类展示样式
11	reConfigLinkCluster	统一配置连线的分类展示样式
13	registEventListener	给指定类型的元素绑定对应操作事件，类型有 场景：scene 节点：node, 连线：link
14	registRightMenu	给指定类型的元素注册右键菜单实现，类型有 场景：scene 节点：node, 连线：link
15	definedLinkPaintFunc	注册连线自定义实现方法，如果业务需要定制化连线样式，则需要自定义开发连线绘制过程，实现任意可视化效果
16	definedNodePaintFunc	注册节点自定义实现方法，如果业务需要定制化节点样式效果，则需要自定义开发节点绘制过程，实现任意可视化效果

六、图分析类接口

序号	接口	说明
1	centrality	图的节点中心性指标计算, degree 度中心性(in、out、both) betweennes 中介中心性 closeness 紧密中心性
2	community	图的聚类分析计算 louvain
3	findAllPath	查找两点间的所有路径
4	findCycles	查找节点在图中的存在的环路
5	findNLevelRelations	查找节点的指定层级关联节点
6	findShortestPath	查找两点间的最短路径
7	findCommonNeighbors	查找多个节点的共同邻居节点
8	getConnectedComponents	计算图的连通组件，识别图中有几个独立的组
9	miniSpanningTree	计算最小生成树的路径

七、图布局计算接口

序号	接口	说明
1	excuteLocalLayout	执行本地可视化布局计算，有动画过程，适用于小规模数据
2	excuteWorkerLayout	执行异步布局计算过程，异步线程计算，可避免大量数据计算时页面阻塞导致卡顿

八、工具类接口

序号	接口	说明
1	randomColor	随机生成一个rgb颜色值
2	numScale	数值按照值域区间进行线性比例缩放
3	preResetNodeCoords	预计算节点的坐标
4	customStyle	自定义canvas绘图样式，设置给节点或连线
5	switchAnimate	视图动画开关，当只是动画时，可开启动画模式，性能消耗较高，使用完后需关闭
6	createBaseAnimate	创建基础动画
7	createTimelineAnimate	创建时序动画过程