g6/README-zh_CN.md at dev2.2.0

test/g6

Fork 0

mirror of https://gitee.com/antv/g6.git synced 2024-11-29 18:28:19 +08:00

Elaine1234 467a59758c chore(readme): update README

2019-01-17 13:50:27 +08:00

3.3 KiB

Raw Permalink Blame History

English README

G6 是一个图可视化框架。它提供了一套图可视化的基础设置，能帮助开发者搭建属于自己的图 图分析 应用或是 图编辑器 应用。

注意： G6 3.0 版本带来了重大更新，目前正在beta测试中。欢迎开发者们试用，详情请见 3.x文档。

2.x 完整文档

G6-Editor

G6-Analyzer [coming soon]

安装

$ npm install @antv/g6

Usage

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);

开发

$ npm install

# run test case
$ npm run test-live

# build watching file changes and run demos
$ npm run dev

如何贡献

Please let us know how can we help. Do check out issues for bug reports or suggestions first.

请让我们知道您要解决或贡献什么，所以在贡献之前请先提交 issues 描述 bug 或建议。

成为一个贡献者前请阅读代码贡献规范.

体验改进计划说明

为了更好服务用户，G6 会将 URL 和版本信息发送回 AntV 服务器： https://kcart.alipay.com/web/bi.do 除了 URL 与 G6 版本信息外，不会收集任何其他信息。如有担心，可以通过下面的代码关闭：

// 关闭 G6 的体验改进计划打点请求
G6.track(false)

License

MIT license.

3.3 KiB Raw Permalink Blame History Unescape Escape