中文简介

What is G6

G6 is a graph visualization engine, which provides a set of basic mechanisms, including rendering, layout, analysis, interaction, animation, and other auxiliary tools. G6 aims to simplify the complex relationships, and help people to obtain the insight of relational data.

Developers are able to build graph visualization analysis applications or graph visualization modeling applications easily.

Powerful Layouts

Powerful Animation and Interactions

Features

• Abundant Built-in Items: Nodes and edges with free configurations;
• Steerable Interactions: More than 10 basic interaction behaviors ;
• Powerful Layouts: More than 10 layout algorithms;
• Convenient Components: Outstanding abilities and performance;
• Friendly User Experience: Complete documents for different levels of requirements. TypeScript supported.

G6 concentrates on the principle of 'good by default'. In addition, the custom mechanism of the item, interation behavior, and layout satisfies the customization requirements.

Abundant Built-in Items

Installation

$ npm install @antv/g6

Usage

// The source data
const data = {
  // The array of nodes
  nodes: [
    {
      id: 'node1',
      x: 100,
      y: 200,
    },
    {
      id: 'node2',
      x: 300,
      y: 200,
    },
  ],
  // The array of edges
  edges: [
    // An edge links from node1 to node2
    {
      source: 'node1',
      target: 'node2',
    },
  ],
};

// Instantiate the Graph
const graph = new G6.Graph({
  container: 'mountNode', // The container id or HTML node of the graph canvas.
  // The width and the height of graph canvas
  width: 800,
  height: 500,
});
// Load the data
graph.data(data);
// Render the graph
graph.render();

For more information about the usage, please refer to Getting Started.

Documents

• Tutorial
• Key Concepts
• Advanced Guides
• API Reference

Links

Some implementations combined with front-end libraries from the third party:

• Flow visualization editor powered by G6 and React - Workflow Designer;
• Visualization editor powered by G6 and Vue;
• Visualization and graphics editor powered by G6 and Vue - A visual graph editor based on G6 and Vue.

G6 Communication Group

Users are welcome to join the G6 Communication Group (It is a DingTalk group). We are also welcome the github issues.

How to Contribute

Please let us know what you are you going to help. Do check out issues for bug reports or suggestions first.

To become a contributor, please follow our Contributing Guide.

License

MIT license.