UNPKG

create-gojs-kit

Version:

A CLI for downloading GoJS samples, extensions, and docs

167 lines 62.9 kB
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><link rel="stylesheet" href="../../assets/css/style.css"/><link rel="preconnect" href="https://rsms.me/"/><link rel="stylesheet" href="https://rsms.me/inter/inter.css"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LayoutNetwork | GoJS API</title><meta name="description" content="Documentation for GoJS API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script type="text/javascript">// formerly in api.js
  var hash = null;
  function changeHash() {
      var panels = document.getElementsByClassName("tsd-panel");
      for (let i = 0; i < panels.length; i++) {
          var p = panels[i];
          p.classList.remove("targeted");
      }
      hash = window.location.hash.slice(1);
      if (hash) {
          var elt = document.getElementById(hash);
          if (elt) elt.parentNode.classList.add("targeted");
      }
  }
  document.addEventListener("DOMContentLoaded", changeHash);
  window.addEventListener("hashchange", changeHash);</script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header><nav id="navTop" class="w-full h-[var(--topnav-h)] z-30 bg-[var(--color-background-secondary)] border-b border-b-[var(--color-accent)]"><div class="max-w-screen-xl mx-auto flex flex-wrap items-start justify-between px-4"><a class="!text-white bg-nwoods-primary font-bold !leading-[calc(var(--topnav-h)_-_1px)] my-0 px-2 text-4xl lg:text-5xl logo" href="../../index.html">GoJS</a><div class="relative"><button id="topnavButton" class="h-[calc(var(--topnav-h)_-_1px)] px-2 m-0 text-[var(--color-text)] bg-inherit shadow-none md:hidden hover:!bg-inherit hover:!text-nwoods-accent hover:!shadow-none" aria-label="Navigation"><svg class="h-7 w-7 block" aria-hidden="true" fill="none" stroke="currentColor" stroke-width="2" viewBox="0 0 24 24"><path d="M3.75 6.75h16.5M3.75 12h16.5m-16.5 5.25h16.5" stroke-linecap="round" stroke-linejoin="round"></path></svg></button><div id="topnavList" class="hidden md:block"><div class="absolute right-0 z-30 flex flex-col items-end rounded border border-[var(--color-accent)] p-4 pl-12 shadow bg-[var(--color-background-secondary)] text-[var(--color-text)] font-semibold
                        md:flex-row md:space-x-4 md:items-start md:border-0 md:p-0 md:shadow-none md:!bg-inherit"><a href="../../learn/index.html">Learn</a><a href="../../samples/index.html">Samples</a><a href="../../intro/index.html">Intro</a><a class="active" href="../../api/index.html">API</a><a href="../../download.html">Download</a><a href="https://forum.nwoods.com/c/gojs/11" target="_blank" rel="noopener">Forum</a><a href="https://nwoods.com/contact.html" target="_blank" rel="noopener" id="contactBtn">Contact</a><a href="https://nwoods.com/sales/index.html" target="_blank" rel="noopener" id="buyBtn">Buy</a></div></div></div></div></nav><script>window.addEventListener("DOMContentLoaded", function () {
    // topnav
    var topButton = document.getElementById("topnavButton");
    var topnavList = document.getElementById("topnavList");
    if (topButton && topnavList) {
      topButton.addEventListener("click", function (e) {
        topnavList
          .classList
          .toggle("hidden");
        e.stopPropagation();
      });
      document.addEventListener("click", function (e) {
        // if the clicked element isn't the list, close the list
        if (!topnavList.classList.contains("hidden") && !e.target.closest("#topnavList")) {
          topButton.click();
        }
      });

      // set active <a> element
      // done via active tag below, always API
    }
  });</script><div class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><div id="tsd-search-help"><code class="!text-lg">/</code> to search</div><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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">GoJS API</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><div class="flex w-full max-w-screen-xl mx-auto px-2 items-center justify-between"><div><ul class="tsd-breadcrumb"><li><a href="../index.html">GoJS API</a></li><li><a href="LayoutNetwork.html">LayoutNetwork</a></li></ul><h1 class="flex items-center">Class LayoutNetwork</h1></div><div class="text-xs"><b>GoJS</b>® Diagramming Components<br/>version 3.1.0<br/>by <a href="https://nwoods.com/">Northwoods Software®</a></div></div></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#LayoutNetwork">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">LayoutNetwork</span><ul class="tsd-hierarchy"><li><a href="CircularNetwork.html" class="tsd-signature-type tsd-kind-class">CircularNetwork</a></li><li><a href="ForceDirectedNetwork.html" class="tsd-signature-type tsd-kind-class">ForceDirectedNetwork</a></li><li><a href="LayeredDigraphNetwork.html" class="tsd-signature-type tsd-kind-class">LayeredDigraphNetwork</a></li><li><a href="TreeNetwork.html" class="tsd-signature-type tsd-kind-class">TreeNetwork</a></li></ul></li></ul></section><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This provides an abstract view of a diagram as a
network (graph) of vertexes and directed edges.
The network contains vertexes and edges corresponding to <a href="Node.html" class="tsd-kind-class">Node</a>s and <a href="Link.html" class="tsd-kind-class">Link</a>s.</p>
<p>This class provides a framework for manipulating the
state of nodes and links without modifying the structure of the diagram.
Having a separate representation also permits adding or removing vertexes or edges
from the network so that the graph that is laid out is not isomorphic to the diagram&#39;s graph.</p>
<p>For each kind of layout that uses a LayoutNetwork there is a subclass of <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a> and a subclass of <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a>:</p>
<ul>
<li><a href="CircularLayout.html" class="tsd-kind-class">CircularLayout</a>: <a href="CircularVertex.html" class="tsd-kind-class">CircularVertex</a> and <a href="CircularEdge.html" class="tsd-kind-class">CircularEdge</a></li>
<li><a href="ForceDirectedLayout.html" class="tsd-kind-class">ForceDirectedLayout</a>: <a href="ForceDirectedVertex.html" class="tsd-kind-class">ForceDirectedVertex</a> and <a href="ForceDirectedEdge.html" class="tsd-kind-class">ForceDirectedEdge</a></li>
<li><a href="LayeredDigraphLayout.html" class="tsd-kind-class">LayeredDigraphLayout</a>: <a href="LayeredDigraphVertex.html" class="tsd-kind-class">LayeredDigraphVertex</a> and <a href="LayeredDigraphEdge.html" class="tsd-kind-class">LayeredDigraphEdge</a></li>
<li><a href="TreeLayout.html" class="tsd-kind-class">TreeLayout</a>: <a href="TreeVertex.html" class="tsd-kind-class">TreeVertex</a> and <a href="TreeEdge.html" class="tsd-kind-class">TreeEdge</a></li>
</ul>
<p>Modifying a <a href="LayoutNetwork.html" class="tsd-kind-class">LayoutNetwork</a> or a <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a> or a <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a> does not
invalidate the <a href="Layout.html" class="tsd-kind-class">Layout</a> or raise any changed events.</p>
</div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="true" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="LayoutNetwork.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="LayoutNetwork.html#edges" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><g id="subicon-R,#FF4D4D"><rect fill="var(--color-icon-background)" width="28" height="28" rx="14"></rect><path transform="translate(2, 2)" fill="none" stroke-width="1.5" stroke="var(--color-text)" d="M16.5 10.5V6.75a4.5 4.5 0 1 0-9 0v3.75m-.75 11.25h10.5a2.25 2.25 0 0 0 2.25-2.25v-6.75a2.25 2.25 0 0 0-2.25-2.25H6.75a2.25 2.25 0 0 0-2.25 2.25v6.75a2.25 2.25 0 0 0 2.25 2.25Z" stroke-linecap="round" stroke-linejoin="round"></path></g></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>edges</span></a>
<a href="LayoutNetwork.html#layout" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>layout</span></a>
<a href="LayoutNetwork.html#vertexes" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>vertexes</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="LayoutNetwork.html#addEdge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Edge</span></a>
<a href="LayoutNetwork.html#addLink" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Link</span></a>
<a href="LayoutNetwork.html#addNode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Node</span></a>
<a href="LayoutNetwork.html#addParts" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Parts</span></a>
<a href="LayoutNetwork.html#addVertex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Vertex</span></a>
<a href="LayoutNetwork.html#createEdge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Edge</span></a>
<a href="LayoutNetwork.html#createVertex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Vertex</span></a>
<a href="LayoutNetwork.html#deleteArtificialVertexes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Artificial<wbr/>Vertexes</span></a>
<a href="LayoutNetwork.html#deleteEdge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Edge</span></a>
<a href="LayoutNetwork.html#deleteLink" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Link</span></a>
<a href="LayoutNetwork.html#deleteNode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Node</span></a>
<a href="LayoutNetwork.html#deleteSelfEdges" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Self<wbr/>Edges</span></a>
<a href="LayoutNetwork.html#deleteVertex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Vertex</span></a>
<a href="LayoutNetwork.html#findAllParts" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>All<wbr/>Parts</span></a>
<a href="LayoutNetwork.html#findEdge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Edge</span></a>
<a href="LayoutNetwork.html#findVertex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Vertex</span></a>
<a href="LayoutNetwork.html#linkVertexes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>link<wbr/>Vertexes</span></a>
<a href="LayoutNetwork.html#reverseEdge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reverse<wbr/>Edge</span></a>
<a href="LayoutNetwork.html#splitIntoSubNetworks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>split<wbr/>Into<wbr/>Sub<wbr/>Networks</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_LayoutNetwork" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Layout<wbr/>Network</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">layout</span><span class="tsd-signature-symbol">: </span><a href="Layout.html" class="tsd-signature-type tsd-kind-class">Layout</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LayoutNetwork.html" class="tsd-signature-type tsd-kind-class">LayoutNetwork</a><a href="#constructor.new_LayoutNetwork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This constructs an empty network.
It is commonplace to call <a href="LayoutNetwork.html#addParts" class="tsd-kind-method">addParts</a> to build up the network
to have the same structure as a <a href="Diagram.html" class="tsd-kind-class">Diagram</a>&#39;s or <a href="Group.html" class="tsd-kind-class">Group</a>&#39;s nodes and links.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">layout</span>: <a href="Layout.html" class="tsd-signature-type tsd-kind-class">Layout</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="LayoutNetwork.html" class="tsd-signature-type tsd-kind-class">LayoutNetwork</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="edges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadOnly">Readonly</code><span>edges</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Set.html" class="tsd-signature-type tsd-kind-class">Set</a><span class="tsd-signature-symbol">&lt;</span><a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a><span class="tsd-signature-symbol">&gt;</span></div><a href="#edges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets a collection of all of the <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a>s in this network.
Do not modify this collection directly.
Instead, call <a href="LayoutNetwork.html#addEdge" class="tsd-kind-method">addEdge</a>, <a href="LayoutNetwork.html#deleteEdge" class="tsd-kind-method">deleteEdge</a>, <a href="LayoutNetwork.html#addLink" class="tsd-kind-method">addLink</a>, or <a href="LayoutNetwork.html#deleteLink" class="tsd-kind-method">deleteLink</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="layout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadOnly">Readonly</code><span>layout</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Layout.html" class="tsd-signature-type tsd-kind-class">Layout</a></div><a href="#layout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the <a href="Layout.html" class="tsd-kind-class">Layout</a> that uses this network
of <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a>es and <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a>s.
The default value is null.
It is set automatically for you when this setting <a href="Layout.html#network" class="tsd-kind-accessor">Layout.network</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="vertexes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadOnly">Readonly</code><span>vertexes</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Set.html" class="tsd-signature-type tsd-kind-class">Set</a><span class="tsd-signature-symbol">&lt;</span><a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a><span class="tsd-signature-symbol">&gt;</span></div><a href="#vertexes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets a collection of all of the <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a>es in this network.
Do not modify this collection directly.
Instead, call <a href="LayoutNetwork.html#addVertex" class="tsd-kind-method">addVertex</a>, <a href="LayoutNetwork.html#deleteVertex" class="tsd-kind-method">deleteVertex</a>, <a href="LayoutNetwork.html#addNode" class="tsd-kind-method">addNode</a>, or <a href="LayoutNetwork.html#deleteNode" class="tsd-kind-method">deleteNode</a>.</p>
</div></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="addEdge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Edge</span><a href="#addEdge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addEdge.addEdge-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Edge</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">edge</span><span class="tsd-signature-symbol">: </span><a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addEdge.addEdge-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a> to the network.
Although this method is provided for completeness,
<a href="LayoutNetwork.html#linkVertexes" class="tsd-kind-method">linkVertexes</a> provides a more efficient manner of linking
vertexes already in the network.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">edge</span>: <a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="addLink" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Link</span><a href="#addLink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addLink.addLink-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Link</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">link</span><span class="tsd-signature-symbol">: </span><a href="Link.html" class="tsd-signature-type tsd-kind-class">Link</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a><a href="#addLink.addLink-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This convenience method makes sure there is a <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a>
in this network corresponding to a <a href="Link.html" class="tsd-kind-class">Link</a>.
If <a href="LayoutNetwork.html#findEdge" class="tsd-kind-method">findEdge</a> returns null, this method creates a new <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a>,
makes sure the <a href="Link.html#fromNode" class="tsd-kind-accessor">Link.fromNode</a> and <a href="Link.html#toNode" class="tsd-kind-accessor">Link.toNode</a> have
corresponding <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a>es in the network, and adds the edge itself
to the network.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">link</span>: <a href="Link.html" class="tsd-signature-type tsd-kind-class">Link</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a></h4><p>an edge in this network.</p>
</li></ul></section><section class="tsd-panel tsd-member"><a id="addNode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Node</span><a href="#addNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addNode.addNode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">node</span><span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type tsd-kind-class">Node</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a><a href="#addNode.addNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This convenience method makes sure there is a <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a>
in this network corresponding to a <a href="Node.html" class="tsd-kind-class">Node</a>.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">node</span>: <a href="Node.html" class="tsd-signature-type tsd-kind-class">Node</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a></h4><p>a vertex in this network.</p>
</li></ul></section><section class="tsd-panel tsd-member"><a id="addParts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Parts</span><a href="#addParts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addParts.addParts-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Parts</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">parts</span><span class="tsd-signature-symbol">: </span><a href="Iterable.html" class="tsd-signature-type tsd-kind-interface">Iterable</a><span class="tsd-signature-symbol">&lt;</span><a href="Part.html" class="tsd-signature-type tsd-kind-class">Part</a><span class="tsd-signature-symbol">&gt;</span>, <span class="tsd-kind-parameter">toplevelonly</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">pred</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">a</span><span class="tsd-signature-symbol">: </span><a href="Part.html" class="tsd-signature-type tsd-kind-class">Part</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addParts.addParts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a network of <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a>es and <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a>s
corresponding to the given <a href="Node.html" class="tsd-kind-class">Node</a>s and <a href="Link.html" class="tsd-kind-class">Link</a>s.
This is usually more convenient than repeatedly calling <a href="LayoutNetwork.html#addNode" class="tsd-kind-method">addNode</a> and <a href="LayoutNetwork.html#addLink" class="tsd-kind-method">addLink</a>.
This method ignores all instances of <a href="Part.html" class="tsd-kind-class">Part</a>s that are not Nodes or Links.
This will recurse through <a href="Group.html" class="tsd-kind-class">Group</a>s that have no <a href="Group.html#layout" class="tsd-kind-accessor">Group.layout</a>.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">parts</span>: <a href="Iterable.html" class="tsd-signature-type tsd-kind-interface">Iterable</a><span class="tsd-signature-symbol">&lt;</span><a href="Part.html" class="tsd-signature-type tsd-kind-class">Part</a><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><p>A collection of <a href="Node.html" class="tsd-kind-class">Node</a>s or <a href="Link.html" class="tsd-kind-class">Link</a>s.</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">toplevelonly</span>: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>whether to skip Parts in the given collection that are contained by Groups; default is false</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">pred</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">a</span><span class="tsd-signature-symbol">: </span><a href="Part.html" class="tsd-signature-type tsd-kind-class">Part</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>optional predicate to apply to each Part --
       if it returns false do not include Vertex or Edge in the network;
       default ignores link label nodes or links connecting with them</p>
</div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">a</span><span class="tsd-signature-symbol">: </span><a href="Part.html" class="tsd-signature-type tsd-kind-class">Part</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">a</span>: <a href="Part.html" class="tsd-signature-type tsd-kind-class">Part</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="addVertex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Vertex</span><a href="#addVertex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addVertex.addVertex-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Vertex</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vertex</span><span class="tsd-signature-symbol">: </span><a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addVertex.addVertex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a> to the network.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">vertex</span>: <a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="createEdge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagVirtual">Virtual</code><span>create<wbr/>Edge</span><a href="#createEdge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createEdge.createEdge-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Edge</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a><a href="#createEdge.createEdge-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Allocate a new instance of <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a>.
This is overridden in LayoutNetwork subclasses to create instances of subclasses of <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a>.
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call this base method.</p>
</div><h4 class="tsd-returns-title">Returns <a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="createVertex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagVirtual">Virtual</code><span>create<wbr/>Vertex</span><a href="#createVertex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createVertex.createVertex-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Vertex</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a><a href="#createVertex.createVertex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Allocate a new instance of <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a>.
This is overridden in LayoutNetwork subclasses to create instances of subclasses of <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a>.
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call this base method.</p>
</div><h4 class="tsd-returns-title">Returns <a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteArtificialVertexes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagVirtual">Virtual</code><span>delete<wbr/>Artificial<wbr/>Vertexes</span><a href="#deleteArtificialVertexes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteArtificialVertexes.deleteArtificialVertexes-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Artificial<wbr/>Vertexes</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#deleteArtificialVertexes.deleteArtificialVertexes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes all vertexes and edges that have no <a href="Part.html" class="tsd-kind-class">Part</a> associated with them.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteEdge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Edge</span><a href="#deleteEdge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteEdge.deleteEdge-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Edge</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">edge</span><span class="tsd-signature-symbol">: </span><a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#deleteEdge.deleteEdge-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes a <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a> from the network.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">edge</span>: <a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteLink" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Link</span><a href="#deleteLink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteLink.deleteLink-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Link</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">link</span><span class="tsd-signature-symbol">: </span><a href="Link.html" class="tsd-signature-type tsd-kind-class">Link</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#deleteLink.deleteLink-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This convenience method deletes from this network any <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a>
corresponding to a <a href="Link.html" class="tsd-kind-class">Link</a>.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">link</span>: <a href="Link.html" class="tsd-signature-type tsd-kind-class">Link</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteNode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Node</span><a href="#deleteNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteNode.deleteNode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">node</span><span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type tsd-kind-class">Node</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#deleteNode.deleteNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This convenience method deletes any <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a>
corresponding to a <a href="Node.html" class="tsd-kind-class">Node</a>.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">node</span>: <a href="Node.html" class="tsd-signature-type tsd-kind-class">Node</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteSelfEdges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Self<wbr/>Edges</span><a href="#deleteSelfEdges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteSelfEdges.deleteSelfEdges-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Self<wbr/>Edges</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#deleteSelfEdges.deleteSelfEdges-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes all <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a>s whose &quot;to vertex&quot; and &quot;from vertex&quot; are the same vertex.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteVertex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Vertex</span><a href="#deleteVertex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deleteVertex.deleteVertex-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Vertex</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vertex</span><span class="tsd-signature-symbol">: </span><a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#deleteVertex.deleteVertex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes a <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a> from the network.
This function also deletes all edges to or from the vertex.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">vertex</span>: <a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="findAllParts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>All<wbr/>Parts</span><a href="#findAllParts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="findAllParts.findAllParts-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>All<wbr/>Parts</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Set.html" class="tsd-signature-type tsd-kind-class">Set</a><span class="tsd-signature-symbol">&lt;</span><a href="Part.html" class="tsd-signature-type tsd-kind-class">Part</a><span class="tsd-signature-symbol">&gt;</span><a href="#findAllParts.findAllParts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve all of the <a href="Node.html" class="tsd-kind-class">Node</a>s and <a href="Link.html" class="tsd-kind-class">Link</a>s from the
<a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a>es and <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a>s that are in this network.</p>
</div><h4 class="tsd-returns-title">Returns <a href="Set.html" class="tsd-signature-type tsd-kind-class">Set</a><span class="tsd-signature-symbol">&lt;</span><a href="Part.html" class="tsd-signature-type tsd-kind-class">Part</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A collection of <a href="Part.html" class="tsd-kind-class">Part</a>s.</p>
</li></ul></section><section class="tsd-panel tsd-member"><a id="findEdge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>Edge</span><a href="#findEdge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="findEdge.findEdge-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>Edge</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">link</span><span class="tsd-signature-symbol">: </span><a href="Link.html" class="tsd-signature-type tsd-kind-class">Link</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a><a href="#findEdge.findEdge-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a> that was constructed for the <a href="Link.html" class="tsd-kind-class">Link</a>.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">link</span>: <a href="Link.html" class="tsd-signature-type tsd-kind-class">Link</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a></h4><p>an edge in this network, or null if no such edge exists.</p>
</li></ul></section><section class="tsd-panel tsd-member"><a id="findVertex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>Vertex</span><a href="#findVertex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="findVertex.findVertex-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>Vertex</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">node</span><span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type tsd-kind-class">Node</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a><a href="#findVertex.findVertex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a> that was constructed for the <a href="Node.html" class="tsd-kind-class">Node</a>.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">node</span>: <a href="Node.html" class="tsd-signature-type tsd-kind-class">Node</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a></h4><p>a vertex in this network, or null if no such vertex exists.</p>
</li></ul></section><section class="tsd-panel tsd-member"><a id="linkVertexes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>link<wbr/>Vertexes</span><a href="#linkVertexes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="linkVertexes.linkVertexes-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">link<wbr/>Vertexes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fromVertex</span><span class="tsd-signature-symbol">: </span><a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a>, <span class="tsd-kind-parameter">toVertex</span><span class="tsd-signature-symbol">: </span><a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a>, <span class="tsd-kind-parameter">link</span><span class="tsd-signature-symbol">: </span><a href="Link.html" class="tsd-signature-type tsd-kind-class">Link</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a><a href="#linkVertexes.linkVertexes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Links two vertexes already in the network and returns the created <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a>.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">fromVertex</span>: <a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a></h5></li><li><h5><span class="tsd-kind-parameter">toVertex</span>: <a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a></h5></li><li><h5><span class="tsd-kind-parameter">link</span>: <a href="Link.html" class="tsd-signature-type tsd-kind-class">Link</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a></h4><p>an edge in this network, or null if both vertexes don&#39;t exist.</p>
</li></ul></section><section class="tsd-panel tsd-member"><a id="reverseEdge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reverse<wbr/>Edge</span><a href="#reverseEdge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="reverseEdge.reverseEdge-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reverse<wbr/>Edge</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">edge</span><span class="tsd-signature-symbol">: </span><a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#reverseEdge.reverseEdge-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reverses the direction of a <a href="LayoutEdge.html" class="tsd-kind-class">LayoutEdge</a> in the network.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">edge</span>: <a href="LayoutEdge.html" class="tsd-signature-type tsd-kind-class">LayoutEdge</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="splitIntoSubNetworks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>split<wbr/>Into<wbr/>Sub<wbr/>Networks</span><a href="#splitIntoSubNetworks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="splitIntoSubNetworks.splitIntoSubNetworks-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">split<wbr/>Into<wbr/>Sub<wbr/>Networks</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clean</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="List.html" class="tsd-signature-type tsd-kind-class">List</a><span class="tsd-signature-symbol">&lt;</span><a href="LayoutNetwork.html" class="tsd-signature-type tsd-kind-class">LayoutNetwork</a><span class="tsd-signature-symbol">&gt;</span><a href="#splitIntoSubNetworks.splitIntoSubNetworks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Modify this network by splitting it up into separate subnetworks,
each of which has all of its vertexes connected to each other, but not
to any vertexes in any other subnetworks.</p>
<p>This method will first delete from this network all artificial vertexes and
all edges that do not connect two different vertexes.
Afterwards, this original network may be empty or may contain all of the
singleton vertexes, each of which had no edges connecting it to any other vertexes.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">clean</span>: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>whether to delete artificial vertexes and edges, disconnected edges, and reflexive edges; default is true</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="List.html" class="tsd-signature-type tsd-kind-class">List</a><span class="tsd-signature-symbol">&lt;</span><a href="LayoutNetwork.html" class="tsd-signature-type tsd-kind-class">LayoutNetwork</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a collection of <a href="LayoutNetwork.html" class="tsd-kind-class">LayoutNetwork</a>s,
sorted in order of decreasing vertex count.</p>
</li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><ul><li><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></li><li><a href="#edges"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>edges</span></a></li><li><a href="#layout"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>layout</span></a></li><li><a href="#vertexes"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>vertexes</span></a></li><li><a href="#addEdge"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Edge</span></a></li><li><a href="#addLink"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Link</span></a></li><li><a href="#addNode"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Node</span></a></li><li><a href="#addParts"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Parts</span></a></li><li><a href="#addVertex"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Vertex</span></a></li><li><a href="#createEdge"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Edge</span></a></li><li><a href="#createVertex"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Vertex</span></a></li><li><a href="#deleteArtificialVertexes"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Artificial<wbr/>Vertexes</span></a></li><li><a href="#deleteEdge"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Edge</span></a></li><li><a href="#deleteLink"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Link</span></a></li><li><a href="#deleteNode"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Node</span></a></li><li><a href="#deleteSelfEdges"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Self<wbr/>Edges</span></a></li><li><a href="#deleteVertex"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Vertex</span></a></li><li><a href="#findAllParts"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>All<wbr/>Parts</span></a></li><li><a href="#findEdge"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Edge</span></a></li><li><a href="#findVertex"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Vertex</span></a></li><li><a href="#linkVertexes"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>link<wbr/>Vertexes</span></a></li><li><a href="#reverseEdge"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reverse<wbr/>Edge</span></a></li><li><a href="#splitIntoSubNetworks"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>split<wbr/>Into<wbr/>Sub<wbr/>Networks</span></a></li></ul></div></details><div class="tsd-navigation settings"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">System</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>GoJS API</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd w-full max-w-screen-xl mx-auto px-2"><div class="bottom-copyright">Copyright © 1998-2025 by Northwoods Software Corporation.</div></div><div class="overlay"></div><script async src="https://www.googletagmanager.com/gtag/js?id=G-S5QK8VSK84"></script><script>window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-S5QK8VSK84');
var getOutboundLink = function(url, label) {
  gtag('event', 'click', {
  'event_category': 'outbound',
  'event_label': label,
  'transport_type': 'beacon'
  });
}

document.getElementById("contactBtn").addEventListener("click", function() {
  getOutboundLink('https://nwoods.com/contact.html', 'contact');
});
document.getElementById("buyBtn").addEventListener("click", function() {
  getOutboundLink('https://nwoods.com/sales/index.html', 'buy');
});</script></body></html>