React + antv/g6实现流程图功能

前言:由于首次接触到antv的g6流程图这个功能,比较好奇然后就浅浅的用一下,其一给需要用到的小伙伴一个简单的案例,其二特此记录。
官方大大地址
第一步:按照官方大大的示例乖乖下载即可,官方提供了两种引入方式,如下

1. 在项目中使用 NPM 包引入(当前pnpm和yarn也可以)

npm install --save @antv/g6

Step 1: 使用命令行在项目目录下执行以下命令:

npm install --save @antv/g6

Step 2: 在需要用的 G6 的 JS 文件中导入:

import G6 from '@antv/g6';

2. 在 HTML 中使用 CDN 引入

// version <= 3.2
<script src="https://gw.alipayobjects.com/os/antv/pkg/_antv.g6-{$version}/build/g6.js"></script>

// version >= 3.3
<script src="https://gw.alipayobjects.com/os/lib/antv/g6/{$version}/dist/g6.min.js"></script>

// version >= 4.0
<script src="https://gw.alipayobjects.com/os/lib/antv/g6/4.3.11/dist/g6.min.js"></script>

⚠️ 注意:

const data = {
  // 点集
  nodes: [
    {
      id: 'node1', // String,该节点存在则必须,节点的唯一标识
      x: 100, // Number,可选,节点位置的 x 值
      y: 200, // Number,可选,节点位置的 y 值
    },
    {
      id: 'node2', // String,该节点存在则必须,节点的唯一标识
      x: 300, // Number,可选,节点位置的 x 值
      y: 200, // Number,可选,节点位置的 y 值
    },
  ],
  // 边集
  edges: [
    {
      source: 'node1', // String,必须,起始点 id
      target: 'node2', // String,必须,目标点 id
    },
  ],
};

从官方提供的数据之中可以看出每一个节点都需要一个x,y,左边来确定节点在画布上的具体位置,显而易见这个x,y坐标对于后端开发人员根本不需要维护,那我们前端如何计算出x,y坐标而去确定位置呢,那我们肯定期望有一种工具可以自动的去计算每个节点的x,y坐标自动在画布上画出来,答案肯定是有的,接下来介绍我们的关键技术点Plugins,它就是帮助我们自动的计算x,y然后自动的画出来,然后拿出我的代码案例。
第一步:引入 g6的同时还用引入Plugins

import G6 from '@antv/g6';
import Plugins from '@antv/g6-plugins';

第二步:处理从后端拿到的数据修改成我们可以直接使用的数据(仅供参考,这一步需要根据后端返回的数据自行调整)

useEffect(() => {
    // 存储所有节点关系
    const nodes = [];
    // 存储所有节点间的指向关系
    const edges = [];
    tasks?.forEach(item => {
      nodes.push({
        shape: 'square',
        label: item.taskName,
        color: 'black',
        id: item.id,
      });
    });
    if (tasks?.length) {
      // 添加开始节点
      nodes.unshift({
        shape: 'circle',
        label: '开始', // 节点名称
        color: 'red', // 设置节点背景色
        id: 'start', // 本节点id
      });
      // 添加结束节点
      nodes.push({
        shape: 'circle',
        label: '结束', // 节点名称
        color: 'red', // 设置节点背景色
        id: 'end', // 本节点id
      });
      // 将开始节点和节点连接起来
      heads?.forEach(item => {
        edges.push({
          shape: 'arrow',
          source: 'start',
          target: item,
          id: `start-${item}`,
        });
      });
      // 将结束节点和节点连接起来
      tails?.forEach(item => {
        edges.push({
          shape: 'arrow',
          source: item,
          target: 'end',
          id: `${item}-end`,
        });
      });
    }
    // 将中间节点连接起来
    relations?.forEach(item => {
      edges.push({
        shape: 'arrow',
        source: item.preProcessTaskDefinitionId,
        target: item.postProcessTaskDefinitionId,
        id: `${item.id}`,
      });
    });

第三步:配置G6画布

    const dagre = new Plugins['layout.dagre']({
      rankdir: 'TB',
      nodesep: 50,
      ranksep: 50,
    });
    const net = new G6.Net({
      id: 'c1', // 容器ID
      fitView: 'cc',
      mode: 'none',
      plugins: [dagre],
    });
// 重中之重配置plugins就是让x,y坐标自动生成

第四步:载入数据

net.source(nodes, edges);

第五步:渲染关系图

net.render();

优化点:加入如下代码是为了每次绘制前先清除上一次的

flowRef.current.innerHTML = '';

完整代码:

import React, { useEffect, useRef, useMemo } from 'react';
import request from '@/request';
import { useLocation } from 'react-router-dom';
import { useRequest } from 'ahooks';
import qs from 'query-string';
import G6 from '@antv/g6';
import Plugins from '@antv/g6-plugins';

const DagProcessHistory = () => {
  const { search } = useLocation();
  const { id, dagBaseInfoReadOnly } = qs.parse(search);
  const flowRef = useRef(null);

  // 获取详情数据
  const { data } = useRequest(() => request.viewFlowApi(id), {
    refreshDeps: [id],
  });

  const { tasks, relations, heads, tails } = data?.data ?? {};

  useEffect(() => {
    // 存储所有节点关系
    const nodes = [];
    // 存储所有节点间的指向关系
    const edges = [];
    tasks?.forEach(item => {
      nodes.push({
        shape: 'square',
        label: item.taskName,
        color: 'black',
        id: item.id,
      });
    });
    if (tasks?.length) {
      // 添加开始节点
      nodes.unshift({
        shape: 'circle',
        label: '开始', // 节点名称
        color: 'red', // 设置节点背景色
        id: 'start', // 本节点id
      });
      // 添加结束节点
      nodes.push({
        shape: 'circle',
        label: '结束', // 节点名称
        color: 'red', // 设置节点背景色
        id: 'end', // 本节点id
      });
      // 将开始节点和节点连接起来
      heads?.forEach(item => {
        edges.push({
          shape: 'arrow',
          source: 'start',
          target: item,
          id: `start-${item}`,
        });
      });
      // 将结束节点和节点连接起来
      tails?.forEach(item => {
        edges.push({
          shape: 'arrow',
          source: item,
          target: 'end',
          id: `${item}-end`,
        });
      });
    }
    // 将中间节点连接起来
    relations?.forEach(item => {
      edges.push({
        shape: 'arrow',
        source: item.preProcessTaskDefinitionId,
        target: item.postProcessTaskDefinitionId,
        id: `${item.id}`,
      });
    });
    flowRef.current.innerHTML = '';
    // eslint-disable-next-line new-cap
    const dagre = new Plugins['layout.dagre']({
      rankdir: 'TB',
      nodesep: 50,
      ranksep: 50,
    });
    // 配置G6画布
    const net = new G6.Net({
      id: 'c1', // 容器ID
      fitView: 'cc',
      mode: 'none',
      plugins: [dagre],
    });
    // 载入数据
    net.source(nodes, edges);
    // 渲染关系图
    net.render();
  }, [tasks, relations]);

  return (
    <div style={{ marginTop: '20px' }} id="c1" ref={flowRef} />
  );
};

export default DagProcessHistory;

最终效果图


图一

图二

我们的需求是需要开始节点和结束节点的所以手动将节点中加入了开始节点和结束节点,大家可以根据实际需求自行调整,本篇文章仅为简单demo和记录。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,122评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,070评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,491评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,636评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,676评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,541评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,292评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,211评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,655评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,846评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,965评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,684评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,295评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,894评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,012评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,126评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,914评论 2 355

推荐阅读更多精彩内容