Quick Start
Online Experience with G6
Visit Chart Examples to experience G6 online without any environment setup.
Creating a Simple Graph
In this example, we will create a simple graph using G6 based on an HTML page.
Copy the following code into an HTML file and then open this file in a browser:
<!-- Prepare a container -->
<div id="container" style="width: 500px; height: 500px"></div>
<!-- Import G6's JS file -->
<script src="https://unpkg.com/@antv/g6@5/dist/g6.min.js"></script>
<script>
const { Graph } = G6;
fetch('https://assets.antv.antgroup.com/g6/graph.json')
.then((res) => res.json())
.then((data) => {
const graph = new Graph({
container: 'container',
autoFit: 'view',
data,
node: {
style: {
size: 10,
},
palette: {
field: 'group',
color: 'tableau',
},
},
layout: {
type: 'd3-force',
manyBody: {},
x: {},
y: {},
},
behaviors: ['drag-canvas', 'zoom-canvas', 'drag-element'],
});
graph.render();
});
</script>
You will get a graph as shown below:
import { createGraph } from '/demo-runtime.ts';
fetch('https://assets.antv.antgroup.com/g6/graph.json')
.then((res) => res.json())
.then((data) =>
createGraph(
{
data,
autoFit: 'view',
animation: false,
node: {
style: {
size: 10,
},
palette: {
field: 'group',
color: 'tableau',
},
},
layout: {
type: 'd3-force',
animation: false,
manyBody: {},
x: {},
y: {},
},
behaviors: ['drag-canvas', 'zoom-canvas', 'drag-element'],
},
{ width: 500, height: 500 },
),
);
import { Graph } from '@antv/g6';
import GUI from 'lil-gui';
export function addPanel(renderPanel: (gui: GUI) => void) {
const gui = new GUI({ container: document.body });
gui.title('Control');
Object.assign(gui.domElement.style, { position: 'absolute', top: '0', right: '0', zIndex: '10' });
renderPanel(gui);
addEventListener('pagehide', () => gui.destroy(), { once: true });
}
export async function createGraph(
options: ConstructorParameters<typeof Graph>[0],
size: { width?: number; height?: number } = {},
renderPanel?: (gui: GUI, graph: Graph) => void,
) {
const container = document.createElement('div');
Object.assign(container.style, {
width: '100%',
maxWidth: `${size.width || 600}px`,
height: `${size.height || 400}px`,
});
document.getElementById('container')!.append(container);
const graph = new Graph({ ...size, ...options, width: container.clientWidth, container, autoResize: true });
addEventListener('pagehide', () => graph.destroy(), { once: true });
await graph.render();
if (renderPanel) addPanel((gui) => renderPanel(gui, graph));
return container;
}Let’s analyze the following code snippet:
- First, we create a
divelement to serve as the container for the graph:
<div id="container" style="width: 500px; height: 500px"></div>
- Then, include the G6’s JS file:
<script src="https://unpkg.com/@antv/g6@5/dist/g6.min.js"></script>
- Use the
fetchmethod to obtain the graph’s data:
fetch('https://assets.antv.antgroup.com/g6/graph.json').then((res) => res.json());
- Finally, create an instance of the graph, pass in the configuration object, and call the
rendermethod to render the graph:
const { Graph } = G6;
const graph = new Graph({
container: 'container',
autoFit: 'view',
data,
node: {
style: {
size: 10,
},
palette: {
field: 'group',
color: 'tableau',
},
},
layout: {
type: 'd3-force',
manyBody: {},
x: {},
y: {},
},
behaviors: ['drag-canvas', 'zoom-canvas', 'drag-element'],
});
graph.render();
If you are using frameworks such as React, Vue, Angular, etc., you can refer to: