1.4 KiB
1.4 KiB
sidebar_position |
---|
1 |
Introduction
maxGraph
is a TypeScript library which can display and allow interaction with vector diagrams. At a high level, it provides:
- Nodes, also known as vertices which are typically represented by shapes like rectangles.
- Edges which can be lines and arrows which normally point between one node and another.
It provides many of the diagramming features which would be expected by a piece of presentation software like Microsoft® PowerPoint™ or LibreOffice® Impress such as being able to resize, move or rotate nodes, but has a stronger focus on automatic layout algorithms and applications of Graph Theory. It is suited towards software which requires finer-grained customization of functionality than off-the-shelf packages.
About this documentation
:::warning
This documentation is a work in progress. Please be patient, the content will be updated progressively.
:::
Getting Started
Please check the maxGraph repository README:
Usage
Let's continue with the Usage documentation.