Skip to content

Latest commit

 

History

History
112 lines (71 loc) · 3.82 KB

index.md

File metadata and controls

112 lines (71 loc) · 3.82 KB
Raw
layout title nav_order
default
Home
0

Graphology

graphology is a robust & multipurpose Graph object for JavaScript and TypeScript.

It aims at supporting various kinds of graphs with the same unified interface.

A graphology graph can therefore be directed, undirected or mixed, allow self-loops or not, and can be simple or support parallel edges.

Along with this Graph object, one will also find a comprehensive standard library full of graph theory algorithms and common utilities such as graph generators, layouts, traversals etc.

Finally, graphology graphs are able to emit a wide variety of events, which makes them ideal to build interactive renderers for the browser. It is for instance used by sigma.js as its data backend.

Installation

To install graphology using npm, run the following command:

npm install graphology

Legacy bundle

Standalone builds of graphology and its full standard library can be found in the repository's releases if you can only rely on your own script tags to load code.

<!-- To use a Graph object -->
<script src="graphology.min.js"></script>
<!-- This exposes a global variable named "graphology" -->
<script>
  const graph = new graphology.Graph();

  const {UndirectedGraph, DirectedGraph} = graphology;
</script>

<!-- To use the standard library -->
<script src="graphology-library.min.js"></script>
<!-- This exposes a global variable named "graphologyLibrary" -->
<script>
  const density = graphologyLibrary.metrics.graph.density(graph);
</script>

Be warned that the standard library bundle often lags behind and is not always completely up to date.

TypeScript usage

Note that graphology also exports type declaration that are installed along using peer dependencies so it can be used with TypeScript out of the box.

If your version of npm is a bit old, you may need to install graphology-types yourself if the peer dependency resolution is not made for you already:

npm install graphology-types

It can also be useful to pin graphology-types version in your package.json to avoid resolution issues sometimes.

Quick Start

import Graph from 'graphology';

const graph = new Graph();

// Adding some nodes
graph.addNode('John');
graph.addNode('Martha');

// Adding an edge
graph.addEdge('John', 'Martha');

// Displaying useful information about your graph
console.log('Number of nodes', graph.order);
console.log('Number of edges', graph.size);

// Iterating over nodes
graph.forEachNode(node => {
  console.log(node);
});

How to cite

DOI

graphology is published on Zenodo as https://doi.org/10.5281/zenodo.5681257.

You can cite it thusly:

Guillaume Plique. (2021). Graphology, a robust and multipurpose Graph object for JavaScript. Zenodo. https://doi.org/10.5281/zenodo.5681257

Changelog

A complete changelog can be found here.

Implementing graphology

There are many ways to implement a Graph data structure and even if graphology chose to optimize for most common use cases, you might need a more specialized implementation yourself.

In this case, know that graphology can be re-implemented completely without losing the benefit of being able to use its standard library.

For more information, be sure to read this section of the documentation.

Acknowledgments

This documentation has been built with Jekyll using the Just the Docs theme.