HTMLGraph logo HTMLGraph

Getting Started

First, include the library in your project and create a canvas. You have several options:

    
npm i @html-graph/html-graph

  

Then use it:

    
<div id="canvas"></div>

  
    
import { CanvasBuilder } from "@html-graph/html-graph";

const element = document.getElementById('canvas');
const canvas = new CanvasBuilder(element).build();

  

2. Use script from CDN as ES module

    
<div id="canvas"></div>
<script type="module">
  import { CanvasBuilder } from "https://unpkg.com/@html-graph/html-graph@3.7.0";

  const element = document.getElementById('canvas');
  const canvas = new CanvasBuilder(element).build();
</script>

  

3. Use local file as ES module

Download html-graph.js from releases and use:

    
<div id="canvas"></div>
<script type="module">
  import { CanvasBuilder } from "/html-graph.js";

  const element = document.getElementById('canvas');
  const canvas = new CanvasBuilder(element).build();
</script>

  

4. Use local file as UMD

Download html-graph.umd.cjs from releases and use:

    
<div id="canvas"></div>
<script src="/html-graph.umd.cjs"></script>
<script>
  const element = document.getElementById('canvas');
  const canvas = new HtmlGraph.CanvasBuilder(element).build();
</script>

  

Now you can visualize your graph by adapting the implementation of this basic example. Refer to canvas section for base API and modules section for all available advanced features.

Basic example