=========== for English guide , click there
B站视频 https://www.bilibili.com/video/av80288517/
老版本为vue2, node版本16以上强烈建议使用vue3版本. 示例项目安装方法为joao-cli安装 npm install -g joao-cli joao init 根据提示输入新建项目名称 cd project npm i && npm run dev 打开localhost:5173 localhost:5173/dag就是示例页面
- 基础安装
npm install --save dag-board
vue项目的main.js中
import DAGBoard from 'dag-board'
Vue.use(DAGBoard)
具体文件里中
<DAGBoard :DataAll="DataAll" @updateDAG="updateDAG" @editNodeDetails="editNodeDetails"></DAGBoard>
DataAll: 数据源
updateDAG:每次动作行为会抛出最新的数据, 和对应事件名称.
editNodeDetails: 可选内容,右键点击节点会带出节点数据,用此方法接受, 进行二次开发.比如更改节点携带的数据等.
- 高级安装 (动态添加节点的时候模拟用)
<node-bus v-if="nodeBusDragging" // 是否正在添加节点
:value="nodeName" // 模拟的节点名称
:pos_x="nodeBusPositionX" // 动态赋值 鼠标位置的x坐标
:pos_y="nodeBusPositionY" /> // 动态赋值 鼠标位置的y坐标
以上内容均可前往github 下载项目查看使用过程, 熟练使用vue即可无障碍阅读代码.
为了更多同学能友好体验,在github右侧有JSON模拟器.使用如下图.
一份完整的节点包括以下几个内容
{
"id": 1, // 节点id
"in_ports": [ 0 ], // 入口下标
"name": "NODE_PARENT", // 节点名称
"out_ports": [ 0, 1 ], // 出口下标
"pos_x": 157, // 节点坐标 距离左侧
"pos_y": 120, // 节点坐标 距离顶部
"nodeStyle": { /* 非必要 节点样式 */
"border": "2px solid red"
},
"iconStyle": { /* 非必要 节点icon样式 */
"background": "red"
},
"iconClassName": "el-icon-link", /* 非必要 节点icon的类名 */
"nameDescribe": "气泡内容", /* 非必要 气泡内容 */
},
// 一份完整的节点关系包括以下几个内容
"edges": [
{
"dst_input_idx": 0, // 目标节点出口的下标
"dst_node_id": 2, // 目标节点的id
"id": 1, // 节点的id
"src_node_id": 1, // 来源节点的id
"src_output_idx": 0 // 来源节点的入口下标
"style": { } /* 非必要 自定义节点样式 */
}
],
很多内容致敬了阿里PAI的早期样式
如果使用当中有任何问题或者实现不了的需求,
可以qq群艾特我.793841737.
增加了删除按钮的取消范围 增加了path的可选范围 正在做自动布局
增加新示范页, 可以进行节点拖拽添加,及单节点表单信息编辑功能,以帮助新用户快速上手.
增加横版模式 ( demo页点击右上角 change version 体验 )
开启横版模式
缓存放入
GlobalConfig: {
isVertical: Boolean // true是默认模式 false为横版模式
}
拖拽更加顺滑 缩放效率更加合理
节点可以添加
rightClickEvent": [
{
"label": "do some thing1",
"eventName": "eventOfDoSomeThingFirst"
},
{
"label": "do some thing2",
"eventName": "evnetOfDoSomeThingSecond"
}
],
属性来实现私有方法追加, 右键的面板会展示私有方法名.点击可以触发 doSthPersonal方法, 第一个参数为你定义的方法名, 第二个参数可以拿到节点id, 具体看demo即可.
<DAGBoard :DataAll="DataAll" @updateDAG="updateDAG" @editNodeDetails="editNodeDetails" @doSthPersonal="doSthPersonal"></DAGBoard>
节点可以添加
edgesText
textStyle
{
"dst_input_idx": 0,
"dst_node_id": 2,
"id": 1,
"src_node_id": 1,
"src_output_idx": 3,
"edgesText": "example text"
},
{
"dst_input_idx": 1,
"dst_node_id": 3,
"id": 2,
"src_node_id": 1,
"src_output_idx": 1,
"edgesText": "personal style",
"textStyle": {
"fontSize": "12px",
"stroke": "yellow"
}
},
属性来实现文字的展示, edgesText是文字内容, textStyle是文字的私有样式,注意是svg的标签, 字段与普通dom不同