g6/packages/site/docs/manual/introduction.en.md
hustcc dbfa80675d
chore: remove unused files (#5274)
* chore: remove rfc template

* chore: remove issue hunt

* chore: remove pnpm lock file

* chore: rename action file

* chore: remove pnpm-workspace.yaml from .gitignore

* chore: remove issue hunt action
2023-12-14 21:16:50 +08:00

3.9 KiB

title order
Introduction 0

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

中文 README

G6 is a graph visualization engine. It provides a set of basic mechanisms, help developers to build your own graph visualization analysis application or graph visualization modeling application.

🎉 New G6 5.0

G6 is a professional graph visualization engine with the following features:

  • Easy to extend, support custom elements, interactions, layouts, renderers, etc.

    • Rich elements: built-in rich node and edge elements, free configuration, support custom
    • Convenient components: optimize the built-in component functions and performance
    • Support TreeShaking to reduce package size
  • New style and animation design specifications, support information layer display

Animation specification and information layer display View original image

  • Provide built-in light and dark themes, themes can be customized, and animation configuration is simple

Built-in theme and custom theme

  • High-performance layout, built-in 10+ commonly used graph layouts, support GPU, Rust parallel computing, and customizable layout
  • Customizable interaction, built-in 10+ interactive behaviors, support custom interaction
  • Developer friendly, providing complete TypeScript type support
  • Runtime renderer switching, support Canvas, SVG, WebGL multiple rendering methods
  • Support 3D large graph display

3D large graph View original image

Furthermore, elements, interactions, and layouts all have a highly scalable custom mechanism.

Contributing

Please let us know what is your contribution and what problem you want to solve. Before submitting a PR, please make sure that you have submitted an issue and describe the bug or feature request.

# Install dependencies

$ pnpm install

# Enter the g6 package directory from the project root directory
$ cd packages/g6

# Build
$ npm run build

# Start the integration test demo
$ npm run dev

# Lint
$ npm run lint

# Lint fix
$ npm run fix

# Run all unit tests
$ npm run test:integration

# Run a single unit test: Modify the test file directory specified by the test:integration_one command in package.json, and then execute:
$ npm run test:integration_one

License

MIT license.