g6/packages/site/docs/apis

title
README

Overview / Modules

G6 API Core Modules

• behaviors
• graph
• item
• layout
• plugins
• types
• util

import { Graph, Util } from '@antv/g6';
const data = Util.mock(6).circle();

const graph = new Graph({
  container: 'container',
  width: 500,
  height: 500,
  data,
  layout: {
    type: 'grid',
  },
  plugins: [
    {
      key: 'minimap',
      type: 'minimap',
      size: [300, 200],
      mode: 'delegate',
      delegateStyle: {
        fill: 'red',
      },
      className: 'g6-minimap-2',
      viewportClassName: 'g6-minimap-viewport-2',
    },
  ],
});

const nodes = graph.getAllNodesData();
const nodes = graph.getAllNodesData();

graph.on('node:click', (e) => {});

Introduce

In the above code snippet, we may want to know more about what G6 has to offer, in which case we will need the G6 API documentation

What types, methods and classes are exported in the '@antv/g6' package?

• Graph
• Util

What is Specification which in new Graph(Specification)？

• Specification

What are the detailed parameters of the plugins ?

• Plugins