g6/docs/manual/introduction.zh.md

134 lines
6.0 KiB
Markdown
Raw Normal View History

2019-11-04 19:36:02 +08:00
---
title: 简介
order: 0
redirect_from:
- /zh/docs/manual
---
<img src="https://user-images.githubusercontent.com/6113694/45008751-ea465300-b036-11e8-8e2a-166cbb338ce2.png" height="250" alt="g6 banner" />
2019-11-04 19:36:02 +08:00
2020-02-14 10:10:54 +08:00
[![](https://img.shields.io/travis/antvis/g6.svg)](https://travis-ci.org/antvis/g6) [![Coverage Status](https://coveralls.io/repos/github/antvis/G6/badge.svg)](https://coveralls.io/github/antvis/G6) ![](https://img.shields.io/badge/language-javascript-red.svg) ![](https://img.shields.io/badge/license-MIT-000000.svg) [![npm package](https://img.shields.io/npm/v/@antv/g6.svg)](https://www.npmjs.com/package/@antv/g6) [![NPM downloads](https://img.shields.io/npm/dm/@antv/g6.svg)](https://npmjs.org/package/@antv/g6) [![Percentage of issues still open](https://isitmaintained.com/badge/open/antvis/g6.svg)](https://isitmaintained.com/project/antvis/g6 'Percentage of issues still open')
2019-11-04 19:36:02 +08:00
2019-12-02 19:58:02 +08:00
[English Introduction](/en/docs/manual/introduction/)
2019-11-04 19:36:02 +08:00
2019-11-16 15:04:13 +08:00
## 什么是 G6
2020-02-14 10:10:54 +08:00
<a href='https://github.com/antvis/g6' target='_blank'>G6</a> 是一个图可视化引擎。它提供了图的绘制、布局、分析、交互、动画等图可视化的基础能力。旨在让关系变得透明,简单。让用户获得关系数据的 Insight。
2019-11-16 15:04:13 +08:00
<img src='https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*zTjwQaXokeQAAAAAAAAAAABkARQnAQ' width=550 alt='img'/>
2019-11-16 15:04:13 +08:00
基于 G6用户可以快速搭建自己的 **图分析****图编辑** 应用。
2020-02-07 17:02:07 +08:00
如果您还没有使用过 G6 建议通过 [快速上手](/zh/docs/manual/getting-started) 抢先体验 G6 的魅力。
2019-11-16 15:04:13 +08:00
<img src="https://user-images.githubusercontent.com/6113694/44995293-02858600-afd5-11e8-840c-349e4730d63d.gif" height=150 alt='img' /><img src="https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*I9OdTbXJIi0AAAAAAAAAAABkARQnAQ" height=150 alt='img' /><img src="https://user-images.githubusercontent.com/6113694/44995332-2ba61680-afd5-11e8-8cab-db0e9d08ceb7.gif" height=150 alt='img' />
2019-11-16 15:04:13 +08:00
<img src="https://gw.alipayobjects.com/zos/rmsportal/HQxYguinFOMIXrGQOABY.gif" height=150 alt='img' /><img src="https://gw.alipayobjects.com/zos/rmsportal/nAugyFgrbrUWPmDIDiQm.gif" height=150 alt='img' /><img src="https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*xoufSYcjK2AAAAAAAAAAAABkARQnAQ" height=150 alt='img' />
2019-11-16 15:04:13 +08:00
> 强大的布局
<img src='https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*dJT3SIVta6QAAAAAAAAAAABkARQnAQ' width=800 alt='img'/>
> 强大的动画及交互
2019-11-16 15:04:13 +08:00
## G6 的特性
2020-02-14 10:10:54 +08:00
2019-11-16 15:04:13 +08:00
G6 作为一款专业的图可视化引擎,具有以下特性:
2020-02-14 10:10:54 +08:00
2020-02-07 17:02:07 +08:00
- 优秀的性能:支持大规模图数据的交互与探索;
2019-11-16 15:04:13 +08:00
- 丰富的元素:内置丰富的节点与边元素,自由配置,支持自定义;
- 可控的交互:内置 10+ 交互行为,支持自定义交互;
- 强大的布局:内置了 10+ 常用的图布局,支持自定义布局;
- 便捷的组件:优化内置组件功能及性能;
- 友好的体验:根据用户需求分层梳理文档,支持 TypeScript 类型推断。
除了默认好用、配置自由的内置功能,元素、交互、布局均具有高可扩展的自定义机制。
<img src='https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*Y0c6S7cxjVkAAAAAAAAAAABkARQnAQ' width=800 alt='img'/>
2019-11-16 15:04:13 +08:00
2020-02-14 10:10:54 +08:00
> 丰富的图元素
2019-12-02 19:58:02 +08:00
2019-11-16 15:04:13 +08:00
## G6 文档
2020-02-14 10:10:54 +08:00
2019-11-16 15:04:13 +08:00
- [G6 入门教程](/zh/docs/manual/tutorial/preface)
- [G6 核心概念](/zh/docs/manual/middle/graph)
2020-09-01 18:43:11 +08:00
- [G6 扩展阅读](/zh/docs/manual/advanced/coordinate-system)
2019-12-02 19:58:02 +08:00
- [API](/zh/docs/api/Graph)
2020-03-20 13:57:00 +08:00
- [G6 Blog](https://www.yuque.com/antv/g6-blog)
2019-11-16 15:04:13 +08:00
## 快速上手
<img src='https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*srtDT5slbN8AAAAAAAAAAABkARQnAQ' width=400 alt='img' />
2019-11-16 15:04:13 +08:00
```javascript
2020-02-14 10:10:54 +08:00
// 定义数据源
const data = {
// 点集
nodes: [
{
2019-11-16 15:04:13 +08:00
id: 'node1',
x: 100,
2020-02-14 10:10:54 +08:00
y: 200,
},
{
2019-11-16 15:04:13 +08:00
id: 'node2',
x: 300,
2020-02-14 10:10:54 +08:00
y: 200,
},
],
// 边集
edges: [
// 表示一条从 node1 节点连接到 node2 节点的边
{
source: 'node1',
target: 'node2',
},
],
};
// 创建 G6 图实例
const graph = new G6.Graph({
container: 'mountNode', // 指定图画布的容器 id
// 画布宽高
width: 800,
height: 500,
});
// 读取数据
graph.data(data);
// 渲染图
graph.render();
2019-11-04 19:36:02 +08:00
```
更详细的内容请参考 [快速上手](/zh/docs/manual/getting-started) 文档。
2019-11-04 19:36:02 +08:00
2019-11-16 15:04:13 +08:00
## 友情链接
2020-02-14 10:10:54 +08:00
2019-11-16 15:04:13 +08:00
结合前端库的第三方实现:
2019-11-04 19:36:02 +08:00
- <a href='https://github.com/guozhaolong/wfd' target='_blank'>基于 G6 和 React 的可视化流程编辑器 - Workflow Designer</a>
- <a href='https://github.com/caoyu48/vue-g6-editor' target='_blank'>基于 G6 和 Vue 的可视化编辑器</a>[]()
2020-03-20 13:57:00 +08:00
- <a href='https://github.com/OXOYO/X-Flowchart-Vue' target='_blank'>基于 G6 和 Vue 的可视化图形编辑器 - A visual graph editor based on G6 and Vue</a>
- <a href='https://github.com/lusess123/web-pdm' target='_blank'>基于 G6 和 React 实现的 ER 图编辑器</a>
2019-11-04 19:36:02 +08:00
2019-11-16 15:04:13 +08:00
## G6 图可视化交流群
2020-02-14 10:10:54 +08:00
2020-03-20 13:57:00 +08:00
欢迎各界 G6 使用者、图可视化爱好者加入 **G6 图可视化交流群****G6 图可视化交流二群**(钉钉群,使用钉钉扫一扫加入)讨论与交流。
2019-11-16 15:04:13 +08:00
2020-03-20 13:57:00 +08:00
> **G6 图可视化交流群** 已满员,该群会不定期移除不活跃的成员。
> 由于值班同学的时间和精力有限,**G6 图可视化交流二群** 中的问题我们会不定期回复。欢迎对 G6 感兴趣的同学加入到答疑中来,非常感谢!交流群-1 已满,请加交流群-2。
2020-03-20 13:57:00 +08:00
<img src='https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*LFppR6_BfdYAAAAAAAAAAABkARQnAQ' width=400 alt="">
2020-03-20 13:57:00 +08:00
<img src='https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*hzfaSrAj0jkAAAAAAAAAAABkARQnAQ' width=400 alt="">
2019-11-04 19:36:02 +08:00
## 如何贡献
请让我们知道您要解决或贡献什么,所以在贡献之前请先提交 <a href='https://github.com/antvis/g6/issues' target='_blank'>issues</a> 描述 bug 或建议。
2019-11-04 19:36:02 +08:00
成为一个贡献者前请阅读 <a href='https://github.com/antvis/g6/blob/master/CONTRIBUTING.zh-CN.md' target='_blank'>代码贡献规范</a>
2019-11-04 19:36:02 +08:00
## License
<a href='https://github.com/antvis/g6/blob/master/LICENSE' target='_blank'>MIT license</a>