【vue2 & G6】快速上手

封面.jpg

G6 是一个图可视化引擎。它提供了图的绘制、布局、分析、交互、动画等图可视化的基础能力。旨在让关系变得透明,简单。让用户获得关系数据的 Insight。

翻译成白话: G6可以实现 拓扑图、流程图、脑图 等各种奇奇怪怪的图表的开发,并在浏览器呈现出来。

01.png



开发环境

  • chrome ^88.0.4324.104(正式版本)
  • vue ^2.6.11
  • g6 ^4.1.11


请认清本文所使用的开发环境。本例使用 Vue2 进行开发!!!

如果在练习中所使用到的库或浏览器版本与文本不一致,可能会出现某些功能无法实现。


本文的运行环境是 chrome 浏览器,如果在其他浏览器出现兼容问题,可以留言一起探讨一起解决。



学前准备

  1. 有一定的 htmlcss 基础,本文不讲解这方面的基础知识。
  2. 有一定的 vue 2 开发经验,本文不会讲解 vue 基础用法。
  3. 建议有 canvas 基础(没有也没关系)。


本文使用 vue-cli 进行开发,所以会使用 npm 的方式安装 G6



快速上手

快速上手 - 官方文档


1、安装

CDN 的方式很简单,可以自行看文档

本文使用 vue-cli 进行开发,所以会使用 npm 的方式安装 G6

这里默认读者已经使用 vue-cli 创建好一个 vue 2 的项目了。


进入创建好的 vue 项目,在终端输入以下命令进行安装:

$ npm install --save @antv/g6

$ 号不需要输入, $ 号代表命令。


安装成功后可以在 node_modules 目录查看到:在@antv 目录下找到 g6 目录,证明安装成功了。

02.png


2、代码+注释

根据官方文档提示,要快速创建图表只需5大步骤。

  1. 创建容器
  2. 引入G6
  3. 准备数据
  4. 创建关系图
  5. 匹配数据源并渲染


以上步骤,会在代码中以“【步骤xxx】”的注释方式一一对应。

<template>
  <div class="page-x">
    <!-- 【步骤1】 创建容器 -->
    <div class="g6-x" id="containerG6" ref="containerG6"></div>
  </div>
</template>

<script>
// 【步骤2】 引入G6
import G6 from '@antv/g6'

export default {
  name: "Started",
  data() {
    return {
      graph: null,
      // 【步骤3】 准备数据
      graphData: {
        // 点集
        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
          },
        ]
      }
    }
  },
  methods: {
    // 初始化关系图,并渲染数据
    initGraph() {
      // 【步骤4】 创建关系图
      const containerG6  = this.$refs.containerG6 // 获取容器(DOM元素)
      this.graph = new G6.Graph({
        container: containerG6, // String | HTMLElement,必须,在 Step 1 中创建的容器 id 或容器本身
        width: containerG6.offsetWidth, // Number,必须,图的宽度
        height: containerG6.offsetHeight // Number,必须,图的高度
      })

      // 【步骤5】 匹配数据源并渲染
      this.graph.data(this.graphData) // 读取 Step 2 中的数据源到图上
      this.graph.render() // 渲染图
    }
  },
  mounted() {
    this.initGraph()
  }
};
</script>

<style scoped>
.g6-x {
  width: 800px;
  height: 500px;
  box-sizing: border-box;
  border: 1px solid #ccc;
  margin-left: 20px;
}
</style>

效果如下图所示

03.png


这个案例参考了官方的起步案例


步骤3 的数据中,主要用到 nodesedges

nodes 是所有点的集合,是数据类型。每个点都需要有一个 id 属性,且 id 是唯一的。

nodes 里的 xy 代表该点在画布中的位置。

本例的 edges 是依赖于 nodes 的。

edges 是所有边的集合,是数组类型。需要画多少条边就有多少个对象元素。

每条边需要一个 source 和 一个 target

source 是指 起始点,值是 起始点id

target 是指 目标点,值是 目标点id


步骤4 使用 new G6.Graph 创建关系图。

其中 containerwidthheight 是必填项。如果没填这几项会报错。

container 是容器的 id 或者容器实例。本例使用 vue 2 开发,所以使用了 $refs 获取容器实例(本例中容器实例为 containerG6)。

width 是图的宽度,本例使用了 containerG6.offsetWidth ,让容器的宽度作为图的宽度。

height 是图的高度,本例使用了 `containerG6.offsetHeight,让容器的高度作为图的高度。


步骤5

使用 graph.data() 来初始化图数据。传入的参数就是 步骤2 中准备的数据。

使用 graph.render() 方法把数据渲染出来。

graph.data() 官方文档

graph.render() 官网文档



3、源码地址

本例源码地址

这个项目里还是用了 vue-router 进行开发,但 vue-router 部分不会影响 G6 的使用。


本例所参考的文献


延伸阅读

G6 国内官网

G6官方快速上手文档

本例源码地址(欢迎Star,长期维护)

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

推荐阅读更多精彩内容