g6/README.md

83 lines
2.7 KiB
Markdown
Raw Normal View History

2018-09-28 14:58:26 +08:00
# G6: A Graph Visualization Framework in JavaScript.
2018-09-04 11:37:53 +08:00
![](https://user-images.githubusercontent.com/6113694/45008751-ea465300-b036-11e8-8e2a-166cbb338ce2.png)
2018-06-05 23:58:10 +08:00
2018-09-04 00:03:06 +08:00
[![](https://img.shields.io/travis/antvis/g6.svg)](https://travis-ci.org/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](http://img.shields.io/npm/dm/@antv/g6.svg)](https://npmjs.org/package/@antv/g6)
[![Percentage of issues still open](http://isitmaintained.com/badge/open/antvis/g6.svg)](http://isitmaintained.com/project/antvis/g6 "Percentage of issues still open")
2018-06-05 23:58:10 +08:00
[中文 README](README-zh_CN.md)
2018-09-28 14:56:56 +08:00
G6 is a graph visualization framework. It provides a set of basic mechanisms, helps developers build their own graph visualization **analysis** application or graph visualization **edit** application.
2018-06-05 23:58:10 +08:00
2018-09-03 19:10:44 +08:00
[Full documentation](https://www.yuque.com/antv/g6-en)
2018-06-05 23:58:10 +08:00
2018-09-03 23:17:22 +08:00
2018-09-03 23:58:21 +08:00
<img src="https://user-images.githubusercontent.com/6113694/44995293-02858600-afd5-11e8-840c-349e4730d63d.gif" height=150><img src="https://cdn.nlark.com/yuque/0/2018/gif/93506/1535955277773-840190f8-836a-4bd6-875a-b3a18e6cebf1.gif" height=150><img src="https://user-images.githubusercontent.com/6113694/44995332-2ba61680-afd5-11e8-8cab-db0e9d08ceb7.gif" height=150>
2018-09-03 23:17:22 +08:00
<img src="https://gw.alipayobjects.com/zos/rmsportal/HQxYguinFOMIXrGQOABY.gif" height=150><img src="https://gw.alipayobjects.com/zos/rmsportal/nAugyFgrbrUWPmDIDiQm.gif" height=150>
2018-06-06 09:56:44 +08:00
## [G6-Editor](https://yuque.com/antv/g6-editor)
2018-06-06 10:16:24 +08:00
<img src="https://gw.alipayobjects.com/zos/rmsportal/nzmycBewjfxKDbepTDlT.gif" width=560>
<img src="https://gw.alipayobjects.com/zos/rmsportal/WVqnbgJmamdahbAuDpBL.gif" width=560>
2018-06-06 09:56:44 +08:00
2018-06-05 23:58:10 +08:00
## Installation
```bash
$ npm install @antv/g6
```
<img src="https://gw.alipayobjects.com/zos/rmsportal/qSUOQUhnRrHCLvEjhZGP.png" />
## Usage
```js
import G6 from '@antv/g6';
const data = {
nodes: [{
id: 'node1',
x: 100,
y: 200
},{
id: 'node2',
x: 300,
y: 200
}],
edges: [{
target: 'node2',
source: 'node1'
}]
};
const graph = new G6.Graph({
container: 'mountNode',
width: 500,
height: 500
});
graph.read(data);
```
## Development
```bash
$ npm install
# run test case
$ npm run test-live
# build watching file changes and run demos
$ npm run dev
```
## How to Contribute
Please let us know how can we help. Do check out [issues](https://github.com/antvis/g6/issues) for bug reports or suggestions first.
2018-06-06 10:05:37 +08:00
To become a contributor, please follow our [contributing guide](https://github.com/antvis/g6/blob/master/CONTRIBUTING.md).
2018-09-04 00:03:06 +08:00
## License
[MIT license](./LICENSE).