g6/packages/site/docs/manual/introduction.zh.md
Aaron e08c299a69
docs: update v5 site docs (#5162)
* docs: remove readme and navigation in site

* docs: remove v4 core concept docs

* docs: update history and lod plugin docs

* chore: update dumirc config

* docs: add api shape overview doc

* docs: update manual docs

* docs: update manual and tutorial docs

* chore: update dumirc

* docs: remove design sector

* docs: update docs meta data

* docs: update api docs
2023-11-20 09:50:36 +08:00

3.7 KiB

title order
简介 0

travis-ci codecov typescript MIT npm package NPM downloads Percentage of issues still open

English README

G6 是一个图可视化引擎。它提供了图的绘制、布局、分析、交互、动画等图可视化能力。旨在为开发者提供一套简单易用、专业可靠、可高度定制的图可视化开发工具。

🎉 全新 G6 5.0

G6 作为一款专业的图可视化引擎,具有以下特性:

  • 易于扩展,支持自定义元素、交互、布局、渲染器等

    • 丰富的元素:内置丰富的节点与边元素,自由配置,支持自定义
    • 便捷的组件:优化内置组件功能及性能
    • 支持 TreeShaking 减少包体积
  • 全新样式和动画设计规范,支持信息分层显示

动画规范与信息分层 查看原图

  • 提供内置的亮色和暗色主题,主题可定制,动画配置简便

内置主题与自定义主题

  • 高性能布局,内置 10+ 常用的图布局,支持 GPU、Rust 并行计算,并可自定义布局
  • 可定制交互,内置 10+ 交互行为,支持自定义交互
  • 开发者友好,提供完整 TypeScript 类型支持
  • 运行时渲染器切换,支持 Canvas、SVG、WebGL 多种渲染方式
  • 支持 3D 大图显示

3D 大图 查看原图

除了默认好用、配置自由的内置功能,元素、交互、布局均具有高可扩展的自定义机制。

参与贡献

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

# 安装依赖

$ pnpm install

# 从项目根目录进入到 g6 包文件目录下
$ cd packages/g6

# 构建
$ npm run build

# 启动集成测试 demo
$ npm run dev

# 测试 lint
$ npm run lint

# 修复 lint
$ npm run fix

# 运行所有单元测试
$ npm run test:integration

# 运行单个单元测试:修改 package.json 中 test:integration_one 命令指定的测试文件目录,然后执行:
$ npm run test:integration_one

赏金猎人计划

参见 Issue Hunt 计划文档

License

MIT license.