mirror of
https://gitee.com/antv/g6.git
synced 2024-12-14 01:21:33 +08:00
132 lines
5.7 KiB
Markdown
132 lines
5.7 KiB
Markdown
---
|
|
title: Introduction
|
|
order: 0
|
|
redirect_from:
|
|
- /en/docs/manual
|
|
---
|
|
|
|
<img src="https://user-images.githubusercontent.com/6113694/45008751-ea465300-b036-11e8-8e2a-166cbb338ce2.png" height="250" alt="g6 banner" />
|
|
|
|
[](https://travis-ci.org/antvis/g6) [](https://coveralls.io/github/antvis/G6)   [](https://www.npmjs.com/package/@antv/g6) [](https://npmjs.org/package/@antv/g6) [](http://isitmaintained.com/project/antvis/g6 'Percentage of issues still open')
|
|
|
|
[中文简介](/zh/docs/manual/introduction/)
|
|
|
|
## What is G6
|
|
|
|
<a href='https://github.com/antvis/g6' target='_blank'>G6</a> 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.
|
|
|
|
<img src='https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*zTjwQaXokeQAAAAAAAAAAABkARQnAQ' width=550 />
|
|
|
|
Developers are able to build graph visualization **analysis** applications or graph visualization **modeling** applications easily.
|
|
|
|
<img src="https://user-images.githubusercontent.com/6113694/44995293-02858600-afd5-11e8-840c-349e4730d63d.gif" height=150><img src="https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*I9OdTbXJIi0AAAAAAAAAAABkARQnAQ" height=150><img src="https://user-images.githubusercontent.com/6113694/44995332-2ba61680-afd5-11e8-8cab-db0e9d08ceb7.gif" height=150>
|
|
|
|
<img src="https://gw.alipayobjects.com/zos/rmsportal/HQxYguinFOMIXrGQOABY.gif" height=150><img src="https://gw.alipayobjects.com/zos/rmsportal/nAugyFgrbrUWPmDIDiQm.gif" height=150><img src="https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*xoufSYcjK2AAAAAAAAAAAABkARQnAQ" height=150>
|
|
|
|
> Powerful Layouts
|
|
|
|
<img src='https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*dJT3SIVta6QAAAAAAAAAAABkARQnAQ' width=800 />
|
|
|
|
> Powerful Animation and Interactions
|
|
|
|
## Features
|
|
|
|
- Excellent Perforamnce: Supports large graph visualization and interactive exploration;
|
|
- 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.
|
|
|
|
<img src='https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*Y0c6S7cxjVkAAAAAAAAAAABkARQnAQ' width=800 />
|
|
|
|
> Abundant Built-in Items
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
$ npm install @antv/g6
|
|
```
|
|
|
|
## Usage
|
|
|
|
<img src='https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*srtDT5slbN8AAAAAAAAAAABkARQnAQ' width=400>
|
|
|
|
```javascript
|
|
// 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();
|
|
```
|
|
|
|
[](https://codesandbox.io/s/compassionate-lalande-5lxm7?fontsize=14&hidenavigation=1&theme=dark)
|
|
|
|
For more information about the usage, please refer to [Getting Started](/en/docs/manual/getting-started).
|
|
|
|
## Documents
|
|
|
|
- [Tutorial](/en/docs/manual/tutorial/preface)
|
|
- [Key Concepts](/en/docs/manual/middle/graph)
|
|
- [Advanced Guides](/en/docs/manual/advanced/keyconcept/shape-and-properties)
|
|
- [API Reference](/en/docs/api/Graph)
|
|
|
|
## Links
|
|
|
|
Some implementations combined with front-end libraries from the third party:
|
|
|
|
- <a href='https://github.com/guozhaolong/wfd' target='_blank'>Flow visualization editor powered by G6 and React - Workflow Designer</a>;
|
|
- <a href='https://github.com/caoyu48/vue-g6-editor' target='_blank'>Visualization editor powered by G6 and Vue</a>;
|
|
- <a href='https://github.com/OXOYO/X-Flowchart-Vue' target='_blank'>Visualization and graphics editor powered by G6 and Vue - A visual graph editor based on G6 and Vue</a>.
|
|
|
|
## G6 Communication Group
|
|
|
|
Users are welcome to join the **G6 Communication Group** or **G6 Communication Group-2** (They are DingTalk groups). We are also welcome the github issues.
|
|
|
|
<img src='https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*hzfaSrAj0jkAAAAAAAAAAABkARQnAQ' width=400>
|
|
|
|
<img src='https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*7uu-T7kp6uUAAAAAAAAAAABkARQnAQ' width=400>
|
|
|
|
## How to Contribute
|
|
|
|
Please let us know what you are you going to help. Do check out <a href='https://github.com/antvis/g6/issues' target='_blank'>issues</a> for bug reports or suggestions first.
|
|
|
|
To become a contributor, please follow our <a href='https://github.com/antvis/g6/blob/master/CONTRIBUTING.md' target='_blank'>Contributing Guide</a>.
|
|
|
|
## License
|
|
|
|
<a href='https://github.com/antvis/g6/blob/master/LICENSE' target='_blank'>MIT license</a>.
|