sigma
Version:
A JavaScript library dedicated to graph drawing.
123 lines • 5.91 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>sigma</title>
<meta name="description" content="Documentation for sigma">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">sigma</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<h1>sigma</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#sigma-v2" id="sigma-v2" style="color: inherit; text-decoration: none;">
<h1>Sigma v2</h1>
</a>
<p>Sigma is a JavaScript library dedicated to graph drawing, mainly developed by <a href="https://github.com/jacomyal">@jacomyal</a> and <a href="https://github.com/Yomguithereal">@Yomguithereal</a>.</p>
<a href="#overview" id="overview" style="color: inherit; text-decoration: none;">
<h2>Overview</h2>
</a>
<p><a href="http://sigmajs.org">sigmajs.org website</a> provides a global overview of sigma.js v1.</p>
<p>As of version <code>v2</code>, <code>sigma</code> focuses on the management of graph display: layout, rendering, interaction... The graph model is managed in a separate library called <a href="https://github.com/graphology/graphology"><code>graphology</code></a>, which is packed with convenience methods to manage graph data structures.</p>
<p>A set of demo examples contain various use-cases that might help you understand how to use sigma v2 (read further below).</p>
<a href="#status" id="status" style="color: inherit; text-decoration: none;">
<h3>Status</h3>
</a>
<p>Sigma.js v2 is a major refactoring and is currently in version alpha. The stable version is <code>v1.2.x</code>. Although not yet finalized and official, v2 is already in use in production in some organizations.</p>
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h2>Installation</h2>
</a>
<p>Sigma is a javascript library, it is available in <code>npm</code> package manager.</p>
<pre><code><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">install</span><span style="color: #000000"> </span><span style="color: #001080">sigma</span>
</code></pre>
<a href="#examples" id="examples" style="color: inherit; text-decoration: none;">
<h2>Examples</h2>
</a>
<p>A development server can be spawned locally to view the examples. Visit <code>localhost:8000</code> after executing the following commands:</p>
<pre><code><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">install</span>
<span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">run</span><span style="color: #000000"> </span><span style="color: #001080">examples</span>
</code></pre>
<p>You can play around with the files in directory <code>examples</code>, the web pages are live-reloaded whenever the code gets changed.</p>
<a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
<h2>Contributing</h2>
</a>
<p>You can contribute by submitting <a href="http://github.com/jacomyal/sigma.js/issues">issues tickets</a> and proposing <a href="http://github.com/jacomyal/sigma.js/pulls">pull requests</a>. Make sure that tests and linting pass before submitting any pull request.</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>