ironpillar-sheng / x6

🚀 JavaScript diagramming library that uses SVG and HTML for rendering.

X6

JavaScript diagramming library that uses SVG and HTML for rendering.

Features

• 🌱　easy-to-customize: based on well known SVG/HTML/CSS or React to custom nodes and edges
• 🚀　out-of-the-box: built-in 10+ plugins, such as selection, dnd, redo/undo, snapline, minimap, etc.
• 🧲　data-driven: base on MVC architecture, you can focus on data logic and business logic
• 💯　highly-event-driven: you can react on any event that happens inside the graph

Installation

NPM/Yarn

# npm
$ npm install @antv/x6 --save

# yarn
$ yarn add @antv/x6

CDNs

For learning purposes, you can use the latest version with one of the CDN:

• https://unpkg.com/@antv/x6/dist/x6.js
• https://cdn.jsdelivr.net/npm/@antv/x6/dist/x6.js
• https://cdnjs.com/libraries/antv-x6

<script src="https://unpkg.com/@antv/x6/dist/x6.js"></script>

For production, we recommend linking to a specific version number to avoid unexpected breakage from newer versions:

• https://unpkg.com/@antv/[email protected]/dist/x6.js
• https://cdn.jsdelivr.net/npm/@antv/[email protected]/dist/x6.js
• https://cdnjs.com/libraries/antv-x6

<script src="https://unpkg.com/@antv/[email protected]/dist/x6.js"></script>

Usage

Step 1: specify a container the render the diagram.

<div id="container" style="width: 600px; height: 400px"></div>

Step 2: render nodes and edges.

import { Graph } from '@antv/x6'

// Create an instance of Graph.
const graph = new Graph({
  container: document.getElementById('container'),
  grid: true
})

// Render source node.
const source = graph.addNode({
  x: 300,
  y: 40,
  width: 80,
  height: 40,
  label: 'Hello',
})

// Render target node.
const target = graph.addNode({
  x: 420,
  y: 180,
  width: 80,
  height: 40,
  label: 'World',
})

// Render edge from source to target.
graph.addEdge({
  source,
  target,
})

Documentation

• About
• Getting started
• Basic usage
• Advanced practice
• Senior guidance

App Demos Build with X6

Flowchart

A flowchart is a type of diagram that represents a workflow or process. A flowchart can also be defined as a diagrammatic representation of an algorithm, a step-by-step approach to solving a task.

• Online Demo: https://x6.antv.vision/apps/draw
• Source Code: https://github.com/antvis/x6/tree/master/examples/x6-app-draw

DAG

DAG is short for Directed Acyclic Graph, which is a directed graph with no directed cycles. It was originally a common data structure in the computer field. Due to the excellent characteristics brought by the unique topology structure, it is often used to deal with dynamic programming, searching for the shortest path in navigation, data compression and other algorithms.

• Online Demo: https://x6.antv.vision/apps/dag
• Source Code: https://github.com/antvis/x6/tree/master/examples/x6-app-dag

ERD

An entity relationship diagram (ERD) shows the relationships of entity sets stored in a database. An entity in this context is an object, a component of data. An entity set is a collection of similar entities. These entities can have attributes that define its properties. By defining the entities, their attributes, and showing the relationships between them, an ER diagram illustrates the logical structure of databases.

• Online Demo: https://x6.antv.vision/apps/er
• Source Code: https://github.com/antvis/x6/tree/master/examples/x6-app-er

Experience Improvement Program Description

In order to serve the users better, X6 will send the URL and version information back to the AntV server:

https://kcart.alipay.com/web/bi.do

Except for URL and X6 version information, no other information will be collected. You can also turn it off with the following code:

import { Config } from '@antv/x6'

Config.track(false)

Communication

Welcome to join the X6 Communication Group (Scan the QR Code to Join us). We also welcome the github issues.

Development

# install yarn and lerna
$ npm install yarn -g
$ npm install lerna -g

# install deps and build
$ yarn bootstrap

# run tests
$ yarn test

# build
$ yarn build

Contributing

Please let us know how can we help. Do check out issues for bug reports or suggestions first.

To become a contributor, please follow our contributing guide.

Contributors

License

The scripts and documentation in this project are released under the MIT License.