UNPKG

create-gojs-kit

Version:

A CLI for downloading GoJS samples, extensions, and docs

gojs.net

NorthwoodsSoftware/GoJS

253 lines • 64.5 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>TreeVertex | 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="TreeVertex.html">TreeVertex</a></li></ul><h1 class="flex items-center">Class TreeVertex<code class="tsd-tag ts-flagUnindexed">Unindexed</code> </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#TreeVertex">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="LayoutVertex.html" class="tsd-signature-type tsd-kind-class">LayoutVertex</a><ul class="tsd-hierarchy"><li><span class="target">TreeVertex</span></li></ul></li></ul></section><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This holds <a href="TreeLayout.html" class="tsd-kind-class">TreeLayout</a>-specific information about <a href="Node.html" class="tsd-kind-class">Node</a>s.</p>
<p>This class inherits from <a href="LayoutVertex.html" class="tsd-kind-class">LayoutVertex</a>.</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="TreeVertex.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="TreeVertex.html#alignment" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>alignment</span></a>
<a href="TreeVertex.html#angle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>angle</span></a>
<a href="TreeVertex.html#breadthLimit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>breadth<wbr/>Limit</span></a>
<a href="TreeVertex.html#childPortSpot" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>child<wbr/>Port<wbr/>Spot</span></a>
<a href="TreeVertex.html#children" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>children</span></a>
<a href="TreeVertex.html#childrenCount" 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>children<wbr/>Count</span></a>
<a href="TreeVertex.html#commentMargin" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>comment<wbr/>Margin</span></a>
<a href="TreeVertex.html#commentSpacing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>comment<wbr/>Spacing</span></a>
<a href="TreeVertex.html#comments" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>comments</span></a>
<a href="TreeVertex.html#compaction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>compaction</span></a>
<a href="TreeVertex.html#comparer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>comparer</span></a>
<a href="TreeVertex.html#descendantCount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>descendant<wbr/>Count</span></a>
<a href="TreeVertex.html#initialized" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>initialized</span></a>
<a href="TreeVertex.html#layerSpacing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>layer<wbr/>Spacing</span></a>
<a href="TreeVertex.html#layerSpacingParentOverlap" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>layer<wbr/>Spacing<wbr/>Parent<wbr/>Overlap</span></a>
<a href="TreeVertex.html#level" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>level</span></a>
<a href="TreeVertex.html#maxChildrenCount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>max<wbr/>Children<wbr/>Count</span></a>
<a href="TreeVertex.html#maxGenerationCount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>max<wbr/>Generation<wbr/>Count</span></a>
<a href="TreeVertex.html#nodeIndent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>node<wbr/>Indent</span></a>
<a href="TreeVertex.html#nodeIndentPastParent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>node<wbr/>Indent<wbr/>Past<wbr/>Parent</span></a>
<a href="TreeVertex.html#nodeSpacing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>node<wbr/>Spacing</span></a>
<a href="TreeVertex.html#parent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>parent</span></a>
<a href="TreeVertex.html#portSpot" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>port<wbr/>Spot</span></a>
<a href="TreeVertex.html#relativePosition" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>relative<wbr/>Position</span></a>
<a href="TreeVertex.html#rowIndent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>row<wbr/>Indent</span></a>
<a href="TreeVertex.html#rowSpacing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>row<wbr/>Spacing</span></a>
<a href="TreeVertex.html#setsChildPortSpot" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sets<wbr/>Child<wbr/>Port<wbr/>Spot</span></a>
<a href="TreeVertex.html#setsPortSpot" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sets<wbr/>Port<wbr/>Spot</span></a>
<a href="TreeVertex.html#sorting" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sorting</span></a>
<a href="TreeVertex.html#subtreeOffset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>subtree<wbr/>Offset</span></a>
<a href="TreeVertex.html#subtreeSize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>subtree<wbr/>Size</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="TreeVertex.html#copyInheritedPropertiesFrom" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>copy<wbr/>Inherited<wbr/>Properties<wbr/>From</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-index-group tsd-is-inherited"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion"><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Inherited Index</h5></summary><div class="tsd-accordion-details"><div class="tsd-index-content"><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="LayoutVertex.html#bounds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Layout<wbr/>Vertex.bounds</span></a>
<a href="LayoutVertex.html#centerX" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Layout<wbr/>Vertex.centerX</span></a>
<a href="LayoutVertex.html#centerY" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Layout<wbr/>Vertex.centerY</span></a>
<a href="LayoutVertex.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Layout<wbr/>Vertex.data</span></a>
<a href="LayoutVertex.html#destinationEdges" 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<wbr/>Vertex.destination<wbr/>Edges</span></a>
<a href="LayoutVertex.html#destinationVertexes" 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<wbr/>Vertex.destination<wbr/>Vertexes</span></a>
<a href="LayoutVertex.html#edges" 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<wbr/>Vertex.edges</span></a>
<a href="LayoutVertex.html#edgesCount" 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<wbr/>Vertex.edges<wbr/>Count</span></a>
<a href="LayoutVertex.html#focus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Layout<wbr/>Vertex.focus</span></a>
<a href="LayoutVertex.html#focusX" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Layout<wbr/>Vertex.focusX</span></a>
<a href="LayoutVertex.html#focusY" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Layout<wbr/>Vertex.focusY</span></a>
<a href="LayoutVertex.html#height" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Layout<wbr/>Vertex.height</span></a>
<a href="LayoutVertex.html#network" 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<wbr/>Vertex.network</span></a>
<a href="LayoutVertex.html#node" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Layout<wbr/>Vertex.node</span></a>
<a href="LayoutVertex.html#sourceEdges" 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<wbr/>Vertex.source<wbr/>Edges</span></a>
<a href="LayoutVertex.html#sourceVertexes" 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<wbr/>Vertex.source<wbr/>Vertexes</span></a>
<a href="LayoutVertex.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>Layout<wbr/>Vertex.vertexes</span></a>
<a href="LayoutVertex.html#width" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Layout<wbr/>Vertex.width</span></a>
<a href="LayoutVertex.html#x" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Layout<wbr/>Vertex.x</span></a>
<a href="LayoutVertex.html#y" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Layout<wbr/>Vertex.y</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="LayoutVertex.html#addDestinationEdge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Layout<wbr/>Vertex.add<wbr/>Destination<wbr/>Edge</span></a>
<a href="LayoutVertex.html#addSourceEdge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Layout<wbr/>Vertex.add<wbr/>Source<wbr/>Edge</span></a>
<a href="LayoutVertex.html#commit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Layout<wbr/>Vertex.commit</span></a>
<a href="LayoutVertex.html#deleteDestinationEdge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Layout<wbr/>Vertex.delete<wbr/>Destination<wbr/>Edge</span></a>
<a href="LayoutVertex.html#deleteSourceEdge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Layout<wbr/>Vertex.delete<wbr/>Source<wbr/>Edge</span></a>
</div></section></div></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_TreeVertex" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Tree<wbr/>Vertex</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">network</span><span class="tsd-signature-symbol">: </span><a href="TreeNetwork.html" class="tsd-signature-type tsd-kind-class">TreeNetwork</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type tsd-kind-class">TreeVertex</a><a href="#constructor.new_TreeVertex" 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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">network</span>: <a href="TreeNetwork.html" class="tsd-signature-type tsd-kind-class">TreeNetwork</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="TreeVertex.html" class="tsd-signature-type tsd-kind-class">TreeVertex</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="alignment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>alignment</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="TreeAlignment.html" class="tsd-signature-type tsd-kind-enum">TreeAlignment</a></div><a href="#alignment" 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 or sets how this parent node should be aligned relative to its children.</p>
<p>The default value is <a href="TreeAlignment.html#CenterChildren" class="tsd-kind-enum-member">TreeAlignment.CenterChildren</a>.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="angle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>angle</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#angle" 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 or sets the absolute angle at which this subtree should grow from this vertex.</p>
<p>The default value is zero, meaning that general tree growth should proceed rightwards along the X axis.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.
By default this is the same as the Angle of the parent <a href="TreeVertex.html" class="tsd-kind-class">TreeVertex</a>.
However, after the initial propagation of property values, perhaps in
an override of <a href="TreeLayout.html#assignTreeVertexValues" class="tsd-kind-method">TreeLayout.assignTreeVertexValues</a>,
you could just set this property to specify the angle at which this node grows its subtrees.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="breadthLimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>breadth<wbr/>Limit</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#breadthLimit" 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 or sets how broad a node and its descendants should be.</p>
<p>By default this is zero.  A value of zero imposes no limit;
a positive value will specify a limit for the total width of this subtree.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="childPortSpot" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>child<wbr/>Port<wbr/>Spot</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type tsd-kind-class">Spot</a></div><a href="#childPortSpot" 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 or sets the spot that children nodes&#39; ports get as their ToSpot,
if <a href="TreeVertex.html#setsChildPortSpot" class="tsd-kind-accessor">setsChildPortSpot</a> is true and the node has only a single port.</p>
<p>The default value is <a href="Spot.html#Default" class="tsd-kind-property">Spot.Default</a>.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.
A value of <a href="Spot.html#Default" class="tsd-kind-property">Spot.Default</a> will cause the TreeLayout
to assign a ToSpot based on the parent node&#39;s <a href="TreeVertex.html#angle" class="tsd-kind-accessor">TreeVertex.angle</a>.
If the value is other than NoSpot, it is just assigned.
When <a href="TreeLayout.html#path" class="tsd-kind-accessor">TreeLayout.path</a> is <a href="TreePath.html#Source" class="tsd-kind-enum-member">TreePath.Source</a>, the port&#39;s FromSpot is set instead of the ToSpot.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="children" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>children</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type tsd-kind-class">TreeVertex</a><span class="tsd-signature-symbol">[]</span></div><a href="#children" 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 or sets the logical children for this node.</p>
<p>The default value is an empty array.</p>
<p>This structural property is computed in <a href="TreeLayout.html#doLayout" class="tsd-kind-method">TreeLayout.doLayout</a> when building the tree structures.
You should probably not be setting this property.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="childrenCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadOnly">Readonly</code><span>children<wbr/>Count</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#childrenCount" 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>This read-only property returns the number of immediate children this node has.</p>
<p>The default value is zero.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="commentMargin" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>comment<wbr/>Margin</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#commentMargin" 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 or sets the space to leave between the node and the comments.</p>
<p>The default value is 20.</p>
<p>Negative values may cause comments to overlap with the node.
This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="commentSpacing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>comment<wbr/>Spacing</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#commentSpacing" 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 or sets the space to leave between consecutive comments.</p>
<p>The default value is 10.</p>
<p>Negative values may cause comments to overlap.
This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="comments" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>comments</span><div class="membertype"><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></div><a href="#comments" 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 or sets an array of <a href="Node.html" class="tsd-kind-class">Node</a>s that will be positioned near this node.</p>
<p>The default value is null.</p>
<p>These objects should not have their own <a href="TreeVertex.html" class="tsd-kind-class">TreeVertex</a>es to be laid out.
Typically these will be <a href="Node.html" class="tsd-kind-class">Node</a>s whose Category is &quot;Comment&quot;.
This array should be allocated and initialized in <a href="TreeLayout.html#addComments" class="tsd-kind-method">TreeLayout.addComments</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="compaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>compaction</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="TreeCompaction.html" class="tsd-signature-type tsd-kind-enum">TreeCompaction</a></div><a href="#compaction" 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 or sets how the children of this node should be packed together.</p>
<p>The default value is <a href="TreeCompaction.html#Block" class="tsd-kind-enum-member">TreeCompaction.Block</a>.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="comparer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>comparer</span><div class="membertype"><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="TreeVertex.html" class="tsd-signature-type tsd-kind-class">TreeVertex</a>, <span class="tsd-kind-parameter">b</span><span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type tsd-kind-class">TreeVertex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></div><a href="#comparer" 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 or sets how the children should be sorted.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="descendantCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>descendant<wbr/>Count</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#descendantCount" 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 or sets the number of descendants this node has.</p>
<p>For a leaf node, this will be zero.</p>
<p>This informational property is computed as part of the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.
You should probably not be setting this property.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="initialized" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>initialized</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></div><a href="#initialized" 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 or sets whether this node has been initialized as part of <a href="TreeLayout.html#doLayout" class="tsd-kind-method">TreeLayout.doLayout</a> when building the tree structures.</p>
<p>The default value is false.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="layerSpacing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>layer<wbr/>Spacing</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#layerSpacing" 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 or sets the distance between this node and its children.</p>
<p>The default value is 50.</p>
<p>Negative values may cause children to overlap with the parent.
This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="layerSpacingParentOverlap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>layer<wbr/>Spacing<wbr/>Parent<wbr/>Overlap</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#layerSpacingParentOverlap" 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 or sets the fraction of this node&#39;s depth that may overlap with the children&#39;s layer.</p>
<p>The default value is 0.0 -- there is overlap only if <a href="TreeVertex.html#layerSpacing" class="tsd-kind-accessor">layerSpacing</a> is negative.
Values must range from 0.0 to 1.0, where 1.0 means the full depth of this node.</p>
<p>When this value is greater than 0.0, there might not be overlap if <a href="TreeVertex.html#layerSpacing" class="tsd-kind-accessor">layerSpacing</a>
is larger than the depth of this node times this fraction.
Even when this value is 0.0, there may be overlap when <a href="TreeVertex.html#layerSpacing" class="tsd-kind-accessor">layerSpacing</a> is negative.
This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="level" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>level</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#level" 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 or sets the number of single-parent ancestors this node has.</p>
<p>This could also be interpreted as which layer this node is in.
A root node will have a value of zero.</p>
<p>This informational property is computed in <a href="TreeLayout.html#doLayout" class="tsd-kind-method">TreeLayout.doLayout</a> when building the tree structures.
You should probably not be setting this property.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="maxChildrenCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>max<wbr/>Children<wbr/>Count</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#maxChildrenCount" 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 or sets the maximum number of children of any descendant of this node.</p>
<p>For a leaf node, this will be zero.</p>
<p>This informational property is computed as part of the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.
You should probably not be setting this property.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="maxGenerationCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>max<wbr/>Generation<wbr/>Count</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#maxGenerationCount" 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 or sets the maximum depth of the subtrees below this node.</p>
<p>For a leaf node, this will be zero.</p>
<p>This informational property is computed as part of the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.
You should probably not be setting this value.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="nodeIndent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>node<wbr/>Indent</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#nodeIndent" 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 or sets the distance the first child should be indented.</p>
<p>The default value is zero. The value should be non-negative.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.
This property is only sensible when the <a href="TreeVertex.html#alignment" class="tsd-kind-accessor">alignment</a> is
<a href="TreeAlignment.html#Start" class="tsd-kind-enum-member">TreeAlignment.Start</a> or <a href="TreeAlignment.html#End" class="tsd-kind-enum-member">TreeAlignment.End</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="nodeIndentPastParent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>node<wbr/>Indent<wbr/>Past<wbr/>Parent</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#nodeIndentPastParent" 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 or sets whether the first child should be indented past the parent node&#39;s breadth.</p>
<p>The default value is 0.0 -- the only start or end spacing is provided by <a href="TreeVertex.html#nodeIndent" class="tsd-kind-accessor">nodeIndent</a>.
Values must range from 0.0 to 1.0, where 1.0 means the full breadth of this node.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.
This property is only sensible when the <a href="TreeVertex.html#alignment" class="tsd-kind-accessor">alignment</a> is
<a href="TreeAlignment.html#Start" class="tsd-kind-enum-member">TreeAlignment.Start</a> or <a href="TreeAlignment.html#End" class="tsd-kind-enum-member">TreeAlignment.End</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="nodeSpacing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>node<wbr/>Spacing</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#nodeSpacing" 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 or sets the distance between child nodes.</p>
<p>The default value is 20.</p>
<p>A negative value will cause sibling nodes to overlap.
This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="parent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>parent</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type tsd-kind-class">TreeVertex</a></div><a href="#parent" 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 or sets the logical parent for this node.</p>
<p>The default value is null.</p>
<p>This structural property is computed in <a href="TreeLayout.html#doLayout" class="tsd-kind-method">TreeLayout.doLayout</a> when building the tree structures.
You should probably not be setting this property.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="portSpot" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>port<wbr/>Spot</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type tsd-kind-class">Spot</a></div><a href="#portSpot" 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 or sets the spot that this node&#39;s port gets as its FromSpot,
if <a href="TreeVertex.html#setsPortSpot" class="tsd-kind-accessor">setsPortSpot</a> is true and the node has only a single port.</p>
<p>The default value is <a href="Spot.html#Default" class="tsd-kind-property">Spot.Default</a>.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.
A value of <a href="Spot.html#Default" class="tsd-kind-property">Spot.Default</a> will cause the TreeLayout
to assign a FromSpot based on the parent node&#39;s <a href="TreeVertex.html#angle" class="tsd-kind-accessor">TreeVertex.angle</a>.
If the value is other than NoSpot, it is just assigned.
When <a href="TreeLayout.html#path" class="tsd-kind-accessor">TreeLayout.path</a> is <a href="TreePath.html#Source" class="tsd-kind-enum-member">TreePath.Source</a>, the port&#39;s ToSpot is set instead of the FromSpot.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="relativePosition" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>relative<wbr/>Position</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type tsd-kind-class">Point</a></div><a href="#relativePosition" 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 or sets the position of this node relative to its parent node.</p>
<p>This informational property is computed during <a href="TreeLayout.html#doLayout" class="tsd-kind-method">TreeLayout.doLayout</a>.
You should probably not be setting this property.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="rowIndent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>row<wbr/>Indent</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#rowIndent" 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 or sets the distance the first child of each row should be indented.</p>
<p>The default value is 10.  The value should be non-negative.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.
This property is only used when the <a href="TreeVertex.html#breadthLimit" class="tsd-kind-accessor">breadthLimit</a> is positive,
and some initial space needs to be reserved in each row of nodes for the links
that are routed around those rows.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="rowSpacing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>row<wbr/>Spacing</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#rowSpacing" 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 or sets the distance between rows within one layer, all sharing the same parent.</p>
<p>The default value is 25.</p>
<p>Negative values may cause nodes to overlap.
This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="setsChildPortSpot" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sets<wbr/>Child<wbr/>Port<wbr/>Spot</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></div><a href="#setsChildPortSpot" 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 or sets whether the TreeLayout should set the ToSpot for each child node port.</p>
<p>The default value is true -- this may modify the spots of the ports of the children nodes,
if the node has only a single port.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.
The spot used depends on the value of <a href="TreeVertex.html#childPortSpot" class="tsd-kind-accessor">childPortSpot</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="setsPortSpot" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sets<wbr/>Port<wbr/>Spot</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></div><a href="#setsPortSpot" 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 or sets whether the TreeLayout should set the FromSpot for this parent node port.</p>
<p>The default value is true -- this may modify the spot of the port of this node, the parent,
if the node has only a single port.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.
The spot used depends on the value of <a href="TreeVertex.html#portSpot" class="tsd-kind-accessor">portSpot</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="sorting" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sorting</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="TreeSorting.html" class="tsd-signature-type tsd-kind-enum">TreeSorting</a></div><a href="#sorting" 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 or sets whether and in what order the children should be sorted.</p>
<p>The default value is <a href="TreeSorting.html#Forwards" class="tsd-kind-enum-member">TreeSorting.Forwards</a>.</p>
<p>This inherited property is initialized in the <a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-method">TreeLayout.initializeTreeVertexValues</a> pass.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="subtreeOffset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subtree<wbr/>Offset</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type tsd-kind-class">Point</a></div><a href="#subtreeOffset" 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 or sets the offset of this parent node relative to its whole subtree.</p>
<p>This informational property is computed during <a href="TreeLayout.html#doLayout" class="tsd-kind-method">TreeLayout.doLayout</a>.
Of course if there are no children, this is just (0, 0).
You should probably not be setting this property.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="subtreeSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subtree<wbr/>Size</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Size.html" class="tsd-signature-type tsd-kind-class">Size</a></div><a href="#subtreeSize" 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 or sets the size of the subtree (including all descendants) parented by this node.</p>
<p>This informational property is computed during <a href="TreeLayout.html#doLayout" class="tsd-kind-method">TreeLayout.doLayout</a>.
Of course if there are no children, this is just the same as Size.
You should probably not be setting this property.</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="copyInheritedPropertiesFrom" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagVirtual">Virtual</code><span>copy<wbr/>Inherited<wbr/>Properties<wbr/>From</span><a href="#copyInheritedPropertiesFrom" 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="copyInheritedPropertiesFrom.copyInheritedPropertiesFrom-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">copy<wbr/>Inherited<wbr/>Properties<wbr/>From</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">copy</span><span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type tsd-kind-class">TreeVertex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#copyInheritedPropertiesFrom.copyInheritedPropertiesFrom-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>Copy inherited properties from another TreeVertex to this one.</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">copy</span>: <a href="TreeVertex.html" class="tsd-signature-type tsd-kind-class">TreeVertex</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></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="#alignment"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>alignment</span></a></li><li><a href="#angle"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>angle</span></a></li><li><a href="#breadthLimit"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>breadth<wbr/>Limit</span></a></li><li><a href="#childPortSpot"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>child<wbr/>Port<wbr/>Spot</span></a></li><li><a href="#children"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>children</span></a></li><li><a href="#childrenCount"><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>children<wbr/>Count</span></a></li><li><a href="#commentMargin"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>comment<wbr/>Margin</span></a></li><li><a href="#commentSpacing"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>comment<wbr/>Spacing</span></a></li><li><a href="#comments"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>comments</span></a></li><li><a href="#compaction"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>compaction</span></a></li><li><a href="#comparer"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>comparer</span></a></li><li><a href="#descendantCount"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>descendant<wbr/>Count</span></a></li><li><a href="#initialized"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>initialized</span></a></li><li><a href="#layerSpacing"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>layer<wbr/>Spacing</span></a></li><li><a href="#layerSpacingParentOverlap"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>layer<wbr/>Spacing<wbr/>Parent<wbr/>Overlap</span></a></li><li><a href="#level"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>level</span></a></li><li><a href="#maxChildrenCount"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>max<wbr/>Children<wbr/>Count</span></a></li><li><a href="#maxGenerationCount"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>max<wbr/>Generation<wbr/>Count</span></a></li><li><a href="#nodeIndent"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>node<wbr/>Indent</span></a></li><li><a href="#nodeIndentPastParent"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>node<wbr/>Indent<wbr/>Past<wbr/>Parent</span></a></li><li><a href="#nodeSpacing"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>node<wbr/>Spacing</span></a></li><li><a href="#parent"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>parent</span></a></li><li><a href="#portSpot"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>port<wbr/>Spot</span></a></li><li><a href="#relativePosition"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>relative<wbr/>Position</span></a></li><li><a href="#rowIndent"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>row<wbr/>Indent</span></a></li><li><a href="#rowSpacing"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>row<wbr/>Spacing</span></a></li><li><a href="#setsChildPortSpot"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sets<wbr/>Child<wbr/>Port<wbr/>Spot</span></a></li><li><a href="#setsPortSpot"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sets<wbr/>Port<wbr/>Spot</span></a></li><li><a href="#sorting"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sorting</span></a></li><li><a href="#subtreeOffset"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>subtree<wbr/>Offset</span></a></li><li><a href="#subtreeSize"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>subtree<wbr/>Size</span></a></li><li><a href="#copyInheritedPropertiesFrom"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>copy<wbr/>Inherited<wbr/>Properties<wbr/>From</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>