You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2264 lines
145 KiB
2264 lines
145 KiB
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>TreeLayout | GoJS API</title>
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../../assets/css/bootstrap.min.css">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<!-- non-fixed navbar -->
|
|
<nav id="non-fixed-nav" class="navbar navbar-inverse navbar-top">
|
|
<div class="container-fluid">
|
|
<div class="navbar-header">
|
|
<div class="navheader-container">
|
|
<div class="navheader-collapse" data-toggle="collapse" data-target="#navbar">
|
|
<a id="toplogo" class="navbar-brand" href="../../index.html">GoJS</a>
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li><a href="../../index.html">Home</a></li>
|
|
<li><a href="../../learn/index.html">Learn</a></li>
|
|
<li><a href="../../samples/index.html">Samples</a></li>
|
|
<li><a href="../../intro/index.html">Intro</a></li>
|
|
<li><a href="../../api/index.html" target="api">API</a></li>
|
|
<li><a href="https://www.nwoods.com/components/evalform.htm">Register</a></li>
|
|
<li><a href="../../download.html">Download</a></li>
|
|
<li><a href="https://forum.nwoods.com/c/gojs">Forum</a></li>
|
|
<li><a href="https://www.nwoods.com/contact.html" onclick="ga('send','event','Outbound Link','click','contact');">Contact</a></li>
|
|
<li class="buy"><a href="https://www.nwoods.com/sales/index.html" onclick="ga('send','event','Outbound Link','click','buy');">Buy</a></li>
|
|
<li class="activate"><a href="https://www.nwoods.com/app/activate.aspx?sku=gojs">Activate</a></li>
|
|
</ul>
|
|
</div><!--/.nav-collapse -->
|
|
</div>
|
|
</nav>
|
|
<div class="tsd-page-header">
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container-fluid plr15">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">GoJS API</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container-fluid plr15">
|
|
<div class="top-copyright">
|
|
<!--<b>GoJS</b>® Diagramming Components<br/>version <br/>version 2.0.17 for TypeScript/HTML<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a>-->
|
|
<b>GoJS</b>® Diagramming Components<br/>version 2.0.17<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a>
|
|
</div>
|
|
<div>
|
|
<h1>Class TreeLayout</h1>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container-fluid container-main plr15">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="Layout.html" class="tsd-signature-type">Layout</a>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">TreeLayout</span>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="FishboneLayout.html" class="tsd-signature-type">FishboneLayout</a>
|
|
</li>
|
|
<li>
|
|
<a href="ParallelLayout.html" class="tsd-signature-type">ParallelLayout</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This layout positions nodes of a tree-structured graph in layers (rows or columns).</p>
|
|
<p class="boxrun">
|
|
For a discussion and examples of the most commonly used properties, see <a href="../../intro/trees.html">Trees</a> page in the Introduction.
|
|
If you want to experiment interactively with most of the properties, try the <a href="../../samples/tLayout.html">Tree Layout</a> sample.
|
|
See samples that make use of TreeLayout in the <a href="../../samples/index.html#treelayout">samples index</a>.
|
|
<p>This layout makes use of a <a href="LayoutNetwork.html">LayoutNetwork</a> of
|
|
<a href="TreeVertex.html">TreeVertex</a>es and <a href="TreeEdge.html">TreeEdge</a>s that normally
|
|
correspond to the <a href="Node.html">Node</a>s and <a href="Link.html">Link</a>s of the <a href="Diagram.html">Diagram</a>.</p>
|
|
<p>The most commonly set properties for controlling the results of a TreeLayout are:</p>
|
|
<ul>
|
|
<li><a href="TreeLayout.html#angle">angle</a>: the direction in which the tree grows, from parent to child;
|
|
the default value of zero means that the tree grows towards the right, with the children of a node arranged in a layer that is a column.
|
|
An angle of 0 or 180 means that children form vertical layers -- breadth is height and depth is width;
|
|
an angle of 90 or 270 means that children form horizontal layers -- breadth is width and depth is height.</li>
|
|
<li><a href="TreeLayout.html#layerSpacing">layerSpacing</a>: the distance between layers -- between a parent node and its child nodes.</li>
|
|
<li><a href="TreeLayout.html#nodeSpacing">nodeSpacing</a>: the distance between nodes within a layer -- between siblings.</li>
|
|
<li><a href="TreeLayout.html#alignment">alignment</a>: the relative position of a parent node with its children.</li>
|
|
<li><a href="TreeLayout.html#sorting">sorting</a> and <a href="TreeLayout.html#comparer">comparer</a>: specify the order of the immediate children of a parent node.</li>
|
|
<li><a href="TreeLayout.html#compaction">compaction</a>: whether subtrees should be packed closer together if there is room.</li>
|
|
<li><a href="TreeLayout.html#layerStyle">layerStyle</a>: whether the children of one node are aligned with the children of a sibling node.</li>
|
|
<li><a href="TreeLayout.html#setsPortSpot">setsPortSpot</a>, <a href="TreeLayout.html#portSpot">portSpot</a>, <a href="TreeLayout.html#setsChildPortSpot">setsChildPortSpot</a>, and <a href="TreeLayout.html#childPortSpot">childPortSpot</a>: this controls whether to set the <a href="Link.html#fromSpot">Link.fromSpot</a> and
|
|
<a href="Link.html#toSpot">Link.toSpot</a> to be sensible for the <a href="TreeLayout.html#angle">angle</a>.</li>
|
|
<li><a href="TreeLayout.html#nodeIndent">nodeIndent</a> and <a href="TreeLayout.html#nodeIndentPastParent">nodeIndentPastParent</a>: if the <a href="TreeLayout.html#alignment">alignment</a> is <a href="TreeLayout.html#static-AlignmentStart">TreeLayout.AlignmentStart</a> or <a href="TreeLayout.html#static-AlignmentEnd">TreeLayout.AlignmentEnd</a>,
|
|
control how much extra space the first child is given when positioned.</li>
|
|
<li><a href="TreeLayout.html#breadthLimit">breadthLimit</a>, <a href="TreeLayout.html#rowSpacing">rowSpacing</a>: try to limit the total breadth of a subtree to a certain distance;
|
|
when there are too many children or when they are too broad, this puts children into additional rows (or columns, depending on the angle)
|
|
thereby limiting the breadth while increasing the depth of the tree.</li>
|
|
</ul>
|
|
<p>When you set one of the TreeLayout properties listed above, that property normally applies to all of the nodes in the tree.
|
|
What if you want <a href="TreeLayout.html#alignment">alignment</a> to be <a href="TreeLayout.html#static-AlignmentCenterChildren">TreeLayout.AlignmentCenterChildren</a> for the root node but <a href="TreeLayout.html#static-AlignmentBus">TreeLayout.AlignmentBus</a> for the other nodes in the tree?
|
|
Or what if you want want <a href="TreeLayout.html#layerSpacing">layerSpacing</a> to be 50 for all layers except for the layer separating "leaf" nodes from their parent?</p>
|
|
<p>One common solution is to set <a href="TreeLayout.html#treeStyle">treeStyle</a>.
|
|
For the former scenario, you could set <a href="TreeLayout.html#treeStyle">treeStyle</a> to <a href="TreeLayout.html#static-StyleRootOnly">TreeLayout.StyleRootOnly</a>; the value of <a href="TreeLayout.html#alignment">alignment</a> would only apply to the root node.
|
|
For the latter scenario, you could set it to <a href="TreeLayout.html#static-StyleLastParents">TreeLayout.StyleLastParents</a>;
|
|
the value of <a href="TreeLayout.html#layerSpacing">layerSpacing</a> would apply to all nodes except those that have children but that do not have grandchildren.
|
|
How do you then set the alignment or layerSpacing for the other nodes?
|
|
By setting the TreeLayout properties whose names start with "alternate...".
|
|
In these cases that would mean setting <a href="TreeLayout.html#alternateAlignment">alternateAlignment</a> or <a href="TreeLayout.html#alternateLayerSpacing">alternateLayerSpacing</a>.</p>
|
|
<p>These TreeLayout properties actually apply to the <a href="TreeVertex.html">TreeVertex</a> that the TreeLayout uses to represent a <a href="Node.html">Node</a> within the <a href="LayoutNetwork.html">LayoutNetwork</a>.
|
|
All of those TreeLayout properties are actually stored in <a href="TreeLayout.html#rootDefaults">rootDefaults</a>; all of the "alternate..." properties are stored in <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>.
|
|
Depending on the value of <a href="TreeLayout.html#treeStyle">treeStyle</a>, the actual TreeVertex properties for each Node are copied appropriately from either rootDefaults or alternateDefaults.
|
|
In the default case where treeStyle is <a href="TreeLayout.html#static-StyleLayered">TreeLayout.StyleLayered</a>, the alternateDefaults are ignored.
|
|
(Note that treeStyle, and a few other properties such as <a href="TreeLayout.html#path">path</a> and <a href="TreeLayout.html#arrangement">arrangement</a>, apply to the whole layout, not to an individual node/vertex.)</p>
|
|
<p>The use of <a href="TreeLayout.html#treeStyle">treeStyle</a> and "alternate..." TreeLayout properties will cover a lot of common needs for tree layout customization.
|
|
However, there may be times when that is not enough.
|
|
Imagine a situation where you want a special <a href="TreeVertex.html">TreeVertex</a> property value for a particular <a href="Node.html">Node</a>.
|
|
The solution is to override <a href="TreeLayout.html#assignTreeVertexValues">assignTreeVertexValues</a>, where you can examine the given <a href="TreeVertex.html">TreeVertex</a>,
|
|
including its corresponding <a href="LayoutVertex.html#node">LayoutVertex.node</a>, to decide what TreeVertex property values should apply.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="TreeLayout.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alignment" class="tsd-kind-icon">alignment</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateAlignment" class="tsd-kind-icon">alternate<wbr>Alignment</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateAngle" class="tsd-kind-icon">alternate<wbr>Angle</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateBreadthLimit" class="tsd-kind-icon">alternate<wbr>Breadth<wbr>Limit</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateChildPortSpot" class="tsd-kind-icon">alternate<wbr>Child<wbr>Port<wbr>Spot</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateCommentMargin" class="tsd-kind-icon">alternate<wbr>Comment<wbr>Margin</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateCommentSpacing" class="tsd-kind-icon">alternate<wbr>Comment<wbr>Spacing</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateCompaction" class="tsd-kind-icon">alternate<wbr>Compaction</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateComparer" class="tsd-kind-icon">alternate<wbr>Comparer</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateDefaults" class="tsd-kind-icon">alternate<wbr>Defaults</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateLayerSpacing" class="tsd-kind-icon">alternate<wbr>Layer<wbr>Spacing</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateLayerSpacingParentOverlap" class="tsd-kind-icon">alternate<wbr>Layer<wbr>Spacing<wbr>Parent<wbr>Overlap</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateNodeIndent" class="tsd-kind-icon">alternate<wbr>Node<wbr>Indent</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateNodeIndentPastParent" class="tsd-kind-icon">alternate<wbr>Node<wbr>Indent<wbr>Past<wbr>Parent</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateNodeSpacing" class="tsd-kind-icon">alternate<wbr>Node<wbr>Spacing</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternatePortSpot" class="tsd-kind-icon">alternate<wbr>Port<wbr>Spot</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateRowIndent" class="tsd-kind-icon">alternate<wbr>Row<wbr>Indent</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateRowSpacing" class="tsd-kind-icon">alternate<wbr>Row<wbr>Spacing</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateSetsChildPortSpot" class="tsd-kind-icon">alternate<wbr>Sets<wbr>Child<wbr>Port<wbr>Spot</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateSetsPortSpot" class="tsd-kind-icon">alternate<wbr>Sets<wbr>Port<wbr>Spot</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#alternateSorting" class="tsd-kind-icon">alternate<wbr>Sorting</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#angle" class="tsd-kind-icon">angle</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#arrangement" class="tsd-kind-icon">arrangement</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#arrangementSpacing" class="tsd-kind-icon">arrangement<wbr>Spacing</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#breadthLimit" class="tsd-kind-icon">breadth<wbr>Limit</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#childPortSpot" class="tsd-kind-icon">child<wbr>Port<wbr>Spot</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#commentMargin" class="tsd-kind-icon">comment<wbr>Margin</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#commentSpacing" class="tsd-kind-icon">comment<wbr>Spacing</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#comments" class="tsd-kind-icon">comments</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#compaction" class="tsd-kind-icon">compaction</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#comparer" class="tsd-kind-icon">comparer</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#layerSpacing" class="tsd-kind-icon">layer<wbr>Spacing</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#layerSpacingParentOverlap" class="tsd-kind-icon">layer<wbr>Spacing<wbr>Parent<wbr>Overlap</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#layerStyle" class="tsd-kind-icon">layer<wbr>Style</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#nodeIndent" class="tsd-kind-icon">node<wbr>Indent</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#nodeIndentPastParent" class="tsd-kind-icon">node<wbr>Indent<wbr>Past<wbr>Parent</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#nodeSpacing" class="tsd-kind-icon">node<wbr>Spacing</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#path" class="tsd-kind-icon">path</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#portSpot" class="tsd-kind-icon">port<wbr>Spot</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#rootDefaults" class="tsd-kind-icon">root<wbr>Defaults</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#roots" class="tsd-kind-icon">roots</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#rowIndent" class="tsd-kind-icon">row<wbr>Indent</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#rowSpacing" class="tsd-kind-icon">row<wbr>Spacing</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#setsChildPortSpot" class="tsd-kind-icon">sets<wbr>Child<wbr>Port<wbr>Spot</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#setsPortSpot" class="tsd-kind-icon">sets<wbr>Port<wbr>Spot</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#sorting" class="tsd-kind-icon">sorting</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="TreeLayout.html#treeStyle" class="tsd-kind-icon">tree<wbr>Style</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeLayout.html#addComments" class="tsd-kind-icon">add<wbr>Comments</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeLayout.html#arrangeTrees" class="tsd-kind-icon">arrange<wbr>Trees</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeLayout.html#assignTreeVertexValues" class="tsd-kind-icon">assign<wbr>Tree<wbr>Vertex<wbr>Values</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="TreeLayout.html#commitLayers" class="tsd-kind-icon">commit<wbr>Layers</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="TreeLayout.html#commitLayout" class="tsd-kind-icon">commit<wbr>Layout</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="TreeLayout.html#commitLinks" class="tsd-kind-icon">commit<wbr>Links</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="TreeLayout.html#commitNodes" class="tsd-kind-icon">commit<wbr>Nodes</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeLayout.html#createNetwork" class="tsd-kind-icon">create<wbr>Network</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeLayout.html#doLayout" class="tsd-kind-icon">do<wbr>Layout</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-icon">initialize<wbr>Tree<wbr>Vertex<wbr>Values</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeLayout.html#layoutComments" class="tsd-kind-icon">layout<wbr>Comments</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="TreeLayout.html#makeNetwork" class="tsd-kind-icon">make<wbr>Network</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Constants</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-AlignmentBottomRightBus" class="tsd-kind-icon">Alignment<wbr>Bottom<wbr>Right<wbr>Bus</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-AlignmentBus" class="tsd-kind-icon">Alignment<wbr>Bus</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-AlignmentBusBranching" class="tsd-kind-icon">Alignment<wbr>Bus<wbr>Branching</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-AlignmentCenterChildren" class="tsd-kind-icon">Alignment<wbr>Center<wbr>Children</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-AlignmentCenterSubtrees" class="tsd-kind-icon">Alignment<wbr>Center<wbr>Subtrees</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-AlignmentEnd" class="tsd-kind-icon">Alignment<wbr>End</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-AlignmentStart" class="tsd-kind-icon">Alignment<wbr>Start</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-AlignmentTopLeftBus" class="tsd-kind-icon">Alignment<wbr>Top<wbr>Left<wbr>Bus</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-ArrangementFixedRoots" class="tsd-kind-icon">Arrangement<wbr>Fixed<wbr>Roots</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-ArrangementHorizontal" class="tsd-kind-icon">Arrangement<wbr>Horizontal</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-ArrangementVertical" class="tsd-kind-icon">Arrangement<wbr>Vertical</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-CompactionBlock" class="tsd-kind-icon">Compaction<wbr>Block</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-CompactionNone" class="tsd-kind-icon">Compaction<wbr>None</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-LayerIndividual" class="tsd-kind-icon">Layer<wbr>Individual</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-LayerSiblings" class="tsd-kind-icon">Layer<wbr>Siblings</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-LayerUniform" class="tsd-kind-icon">Layer<wbr>Uniform</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-PathDefault" class="tsd-kind-icon">Path<wbr>Default</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-PathDestination" class="tsd-kind-icon">Path<wbr>Destination</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-PathSource" class="tsd-kind-icon">Path<wbr>Source</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-SortingAscending" class="tsd-kind-icon">Sorting<wbr>Ascending</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-SortingDescending" class="tsd-kind-icon">Sorting<wbr>Descending</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-SortingForwards" class="tsd-kind-icon">Sorting<wbr>Forwards</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-SortingReverse" class="tsd-kind-icon">Sorting<wbr>Reverse</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-StyleAlternating" class="tsd-kind-icon">Style<wbr>Alternating</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-StyleLastParents" class="tsd-kind-icon">Style<wbr>Last<wbr>Parents</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-StyleLayered" class="tsd-kind-icon">Style<wbr>Layered</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="TreeLayout.html#static-StyleRootOnly" class="tsd-kind-icon">Style<wbr>Root<wbr>Only</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>
|
|
constructor
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Tree<wbr>Layout<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TreeLayout.html" class="tsd-signature-type">TreeLayout</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Constructs a <a href="TreeLayout.html">TreeLayout</a> with no <a href="Layout.html#network">Layout.network</a>
|
|
and with no owning <a href="Layout.html#diagram">Layout.diagram</a>.</p>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <a href="TreeLayout.html" class="tsd-signature-type">TreeLayout</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alignment" class="tsd-anchor"></a>
|
|
<h3>
|
|
alignment
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the default alignment of parents relative to their children.
|
|
Must be a static constant of <a href="TreeLayout.html">TreeLayout</a> whose name starts with "Alignment".</p>
|
|
<p>The default value is <a href="TreeLayout.html#static-AlignmentCenterChildren">TreeLayout.AlignmentCenterChildren</a>.</p>
|
|
<p>This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateAlignment" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Alignment
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate alignment of parents relative to their children.
|
|
Must be a static constant of <a href="TreeLayout.html">TreeLayout</a> whose name starts with "Alignment".</p>
|
|
<p>The default value is <a href="TreeLayout.html#static-AlignmentCenterChildren">TreeLayout.AlignmentCenterChildren</a>.</p>
|
|
<p>This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateAngle" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Angle
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate direction for tree growth.</p>
|
|
<p>The default value is 0; the value must be one of: 0, 90, 180, 270.</p>
|
|
<p>These values are in degrees, where 0 is along the positive X axis,
|
|
and where 90 is along the positive Y axis.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateBreadthLimit" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Breadth<wbr>Limit
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets an alternate limit on how broad a tree should be.</p>
|
|
<p>A value of zero (the default) means there is no limit;
|
|
a positive value specifies a limit.
|
|
The default value is zero.</p>
|
|
<p>This property is just a suggested constraint on how
|
|
broadly the tree will be laid out.
|
|
When there isn't enough breadth for all of the children of a node,
|
|
the children are placed in as many rows as needed to try to stay
|
|
within the given breadth limit.
|
|
If the value is too small, since this layout algorithm
|
|
does not modify the size or shape of any node, the nodes will
|
|
just be laid out in a line, one per row, and the breadth is
|
|
determined by the broadest node.
|
|
The distance between rows is specified by <a href="TreeLayout.html#rowSpacing">rowSpacing</a>.
|
|
To make room for the links that go around earlier rows to get to
|
|
later rows, when the alignment is not a "center" alignment, the
|
|
<a href="TreeLayout.html#rowIndent">rowIndent</a> property specifies that space at the
|
|
start of each row.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateChildPortSpot" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Child<wbr>Port<wbr>Spot
|
|
<span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type">Spot</a> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate spot that children nodes' ports get as their ToSpot
|
|
The default value is <a href="Spot.html#static-Default">Spot.Default</a>.</p>
|
|
<p>A value of <a href="Spot.html#static-Default">Spot.Default</a> will cause the TreeLayout
|
|
to assign a ToSpot based on the parent node's <a href="TreeVertex.html#angle">TreeVertex.angle</a>.</p>
|
|
<p>If the value is other than NoSpot, it is just assigned.
|
|
When <a href="TreeLayout.html#path">path</a> is <a href="TreeLayout.html#static-PathSource">PathSource</a>,
|
|
the port's FromSpot is set instead of the ToSpot.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateCommentMargin" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Comment<wbr>Margin
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate distance between a node and its comments.</p>
|
|
<p>The default value is 20.</p>
|
|
<p>This is used by <a href="TreeLayout.html#addComments">addComments</a> and <a href="TreeLayout.html#layoutComments">layoutComments</a>.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateCommentSpacing" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Comment<wbr>Spacing
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate distance between comments.</p>
|
|
<p>The default value is 10.</p>
|
|
<p>This is used by <a href="TreeLayout.html#addComments">addComments</a> and <a href="TreeLayout.html#layoutComments">layoutComments</a>.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateCompaction" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Compaction
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets how closely to pack the child nodes of a subtree.
|
|
Must be either <a href="TreeLayout.html#static-CompactionBlock">TreeLayout.CompactionBlock</a> or <a href="TreeLayout.html#static-CompactionNone">TreeLayout.CompactionNone</a>.</p>
|
|
<p>The default value is <a href="TreeLayout.html#static-CompactionBlock">TreeLayout.CompactionBlock</a>.</p>
|
|
<p>This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateComparer" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Comparer
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">a</span><span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">b</span><span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate comparison function used for sorting the immediate children of a vertex.</p>
|
|
<p>The default comparer compares the <a href="LayoutVertex.html#node">LayoutVertex.node</a> Text values.</p>
|
|
<p>This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.
|
|
Whether this comparison function is used is determined by the value of <a href="TreeLayout.html#alternateSorting">alternateSorting</a>.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateDefaults" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Defaults
|
|
<span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the object holding the default values for alternate layer <a href="TreeVertex.html">TreeVertex</a>es,
|
|
used when the <a href="TreeLayout.html#treeStyle">treeStyle</a> is <a href="TreeLayout.html#static-StyleAlternating">StyleAlternating</a> or <a href="TreeLayout.html#static-StyleLastParents">StyleLastParents</a>.</p>
|
|
<p>See the list of inheritable properties in the documentation for <a href="TreeLayout.html#rootDefaults">rootDefaults</a>.
|
|
The other properties of this <a href="TreeVertex.html">TreeVertex</a> are ignored.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateLayerSpacing" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Layer<wbr>Spacing
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate distance between a parent node and its children.</p>
|
|
<p>The default value is 50.</p>
|
|
<p>This is the distance between a parent node and its first row
|
|
of children, in case there are multiple rows of its children.
|
|
The <a href="TreeLayout.html#rowSpacing">rowSpacing</a> property determines the distance
|
|
between rows of children.
|
|
Negative values may cause children to overlap with the parent.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateLayerSpacingParentOverlap" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Layer<wbr>Spacing<wbr>Parent<wbr>Overlap
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate fraction of the node's depth for which the children's layer starts overlapped with the parent's layer.</p>
|
|
<p>The default value is 0.0 -- there is overlap between layers only if <a href="TreeLayout.html#layerSpacing">layerSpacing</a> is negative.
|
|
A value of 1.0 and a zero <a href="TreeLayout.html#layerSpacing">layerSpacing</a> will cause child nodes to completely overlap the parent.</p>
|
|
<p>A value greater than zero may still cause overlap between layers,
|
|
unless the value of <a href="TreeLayout.html#layerSpacing">layerSpacing</a> is large enough.
|
|
A value of zero might still allow overlap between layers,
|
|
if <a href="TreeLayout.html#layerSpacing">layerSpacing</a> is negative.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateNodeIndent" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Node<wbr>Indent
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate indentation of the first child.</p>
|
|
<p>The default value is zero. The value should be non-negative.</p>
|
|
<p>This property is only sensible when the <a href="TreeLayout.html#alignment">alignment</a>
|
|
is <a href="TreeLayout.html#static-AlignmentStart">AlignmentStart</a> or <a href="TreeLayout.html#static-AlignmentEnd">AlignmentEnd</a>.
|
|
Having a positive value is useful if you want to reserve space
|
|
at the start of the row of children for some reason.
|
|
For example, if you want to pretend the parent node is infinitely deep,
|
|
you can set this to be the breadth of the parent node.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateNodeIndentPastParent" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Node<wbr>Indent<wbr>Past<wbr>Parent
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the fraction of this node's breadth is added to <a href="TreeLayout.html#nodeIndent">nodeIndent</a>
|
|
to determine any spacing at the start of the children.</p>
|
|
<p>The default value is 0.0 -- the only indentation is specified by <a href="TreeLayout.html#nodeIndent">nodeIndent</a>.
|
|
When the value is 1.0, the children will be indented past the breadth of the parent node.</p>
|
|
<p>This property is only sensible when the <a href="TreeLayout.html#alignment">alignment</a>
|
|
is <a href="TreeLayout.html#static-AlignmentStart">AlignmentStart</a> or <a href="TreeLayout.html#static-AlignmentEnd">AlignmentEnd</a>.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateNodeSpacing" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Node<wbr>Spacing
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate distance between child nodes.</p>
|
|
<p>The default value is 20.</p>
|
|
<p>A negative value causes sibling nodes to overlap.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternatePortSpot" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Port<wbr>Spot
|
|
<span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type">Spot</a> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate spot that this node's port gets as its FromSpot.</p>
|
|
<p>The default value is <a href="Spot.html#static-Default">Spot.Default</a>.</p>
|
|
<p>A value of <a href="Spot.html#static-Default">Spot.Default</a> will cause the TreeLayout
|
|
to assign a FromSpot based on the parent node's <a href="TreeVertex.html#angle">TreeVertex.angle</a>.
|
|
If the value is other than NoSpot, it is just assigned.
|
|
When <a href="TreeLayout.html#path">path</a> is <a href="TreeLayout.html#static-PathSource">PathSource</a>,
|
|
the port's ToSpot is set instead of the FromSpot.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateRowIndent" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Row<wbr>Indent
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate indentation of the first child of each row,
|
|
if the <a href="TreeLayout.html#alignment">alignment</a> is not a "Center" alignment.</p>
|
|
<p>The default value is 10. The value should be non-negative.</p>
|
|
<p>This is used to leave room for the links that connect a parent node
|
|
with the child nodes that are in additional rows.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateRowSpacing" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Row<wbr>Spacing
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate distance between rows of children.</p>
|
|
<p>The default value is 25.</p>
|
|
<p>This property is only used when there is more than one
|
|
row of children for a given parent node.
|
|
<a href="TreeLayout.html#layerSpacing">layerSpacing</a> determines the distance between
|
|
the parent node and its first row of child nodes.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateSetsChildPortSpot" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Sets<wbr>Child<wbr>Port<wbr>Spot
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<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 spot of the ports of the children nodes,
|
|
if the node has only a single port.</p>
|
|
<p>The spot used depends on the value of <a href="TreeLayout.html#childPortSpot">childPortSpot</a>.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateSetsPortSpot" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Sets<wbr>Port<wbr>Spot
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<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>The spot used depends on the value of <a href="TreeLayout.html#portSpot">portSpot</a>.
|
|
This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="alternateSorting" class="tsd-anchor"></a>
|
|
<h3>
|
|
alternate<wbr>Sorting
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the alternate sorting policy for ordering the immediate children of a vertex.
|
|
Must be <a href="TreeLayout.html#static-SortingForwards">TreeLayout.SortingForwards</a>, <a href="TreeLayout.html#static-SortingReverse">TreeLayout.SortingReverse</a>,
|
|
<a href="TreeLayout.html#static-SortingAscending">TreeLayout.SortingAscending</a>, or <a href="TreeLayout.html#static-SortingDescending">TreeLayout.SortingDescending</a>.</p>
|
|
<p>The default value is <a href="TreeLayout.html#static-SortingForwards">SortingForwards</a>.</p>
|
|
<p>This sets the <a href="TreeLayout.html#alternateDefaults">alternateDefaults</a>' property of the same name.
|
|
The sort order is determined by <a href="TreeLayout.html#alternateComparer">alternateComparer</a>.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="angle" class="tsd-anchor"></a>
|
|
<h3>
|
|
angle
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the default direction for tree growth.</p>
|
|
<p>The default value is 0; the value must be one of: 0, 90, 180, 270.</p>
|
|
<p>These values are in degrees, where 0 is along the positive X axis,
|
|
and where 90 is along the positive Y axis.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="arrangement" class="tsd-anchor"></a>
|
|
<h3>
|
|
arrangement
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets how <a href="TreeLayout.html#arrangeTrees">arrangeTrees</a> should lay out the separate trees.
|
|
Must be <a href="TreeLayout.html#static-ArrangementVertical">TreeLayout.ArrangementVertical</a>, <a href="TreeLayout.html#static-ArrangementHorizontal">TreeLayout.ArrangementHorizontal</a>,
|
|
or <a href="TreeLayout.html#static-ArrangementFixedRoots">TreeLayout.ArrangementFixedRoots</a>.</p>
|
|
<p>The default value is <a href="TreeLayout.html#static-ArrangementVertical">TreeLayout.ArrangementVertical</a></p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="arrangementSpacing" class="tsd-anchor"></a>
|
|
<h3>
|
|
arrangement<wbr>Spacing
|
|
<span class="tsd-signature-symbol">: </span><a href="Size.html" class="tsd-signature-type">Size</a> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the space between which <a href="TreeLayout.html#arrangeTrees">arrangeTrees</a> will position the trees.</p>
|
|
<p>This defaults to the Size(10, 10).</p>
|
|
<p>This property is ignored if <a href="TreeLayout.html#arrangement">arrangement</a> is <a href="TreeLayout.html#static-ArrangementFixedRoots">TreeLayout.ArrangementFixedRoots</a>.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="breadthLimit" class="tsd-anchor"></a>
|
|
<h3>
|
|
breadth<wbr>Limit
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets a limit on how broad a tree should be.</p>
|
|
<p>A value of zero (the default) means there is no limit;
|
|
a positive value specifies a limit.
|
|
The default value is zero.</p>
|
|
<p>This property is just a suggested constraint on how
|
|
broadly the tree will be laid out.
|
|
When there isn't enough breadth for all of the children of a node,
|
|
the children are placed in as many rows as needed to try to stay
|
|
within the given breadth limit.
|
|
If the value is too small, since this layout algorithm
|
|
does not modify the size or shape of any node, the nodes will
|
|
just be laid out in a line, one per row, and the breadth is
|
|
determined by the broadest node.
|
|
The distance between rows is specified by <a href="TreeLayout.html#rowSpacing">rowSpacing</a>.
|
|
To make room for the links that go around earlier rows to get to
|
|
later rows, when the alignment is not a "center" alignment, the
|
|
<a href="TreeLayout.html#rowIndent">rowIndent</a> property specifies that space at the
|
|
start of each row.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="childPortSpot" class="tsd-anchor"></a>
|
|
<h3>
|
|
child<wbr>Port<wbr>Spot
|
|
<span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type">Spot</a> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the spot that children nodes' ports get as their ToSpot.</p>
|
|
<p>The default value is <a href="Spot.html#static-Default">Spot.Default</a>.</p>
|
|
<p>A value of <a href="Spot.html#static-Default">Spot.Default</a> will cause the TreeLayout
|
|
to assign a ToSpot based on the parent node's <a href="TreeVertex.html#angle">TreeVertex.angle</a>.
|
|
If the value is other than NoSpot, it is just assigned.
|
|
When <a href="TreeLayout.html#path">path</a> is <a href="TreeLayout.html#static-PathSource">PathSource</a>,
|
|
the port's FromSpot is set instead of the ToSpot.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="commentMargin" class="tsd-anchor"></a>
|
|
<h3>
|
|
comment<wbr>Margin
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the distance between a node and its comments.</p>
|
|
<p>The default value is 20.</p>
|
|
<p>This is used by <a href="TreeLayout.html#addComments">addComments</a> and <a href="TreeLayout.html#layoutComments">layoutComments</a>.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="commentSpacing" class="tsd-anchor"></a>
|
|
<h3>
|
|
comment<wbr>Spacing
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the distance between comments.</p>
|
|
<p>The default value is 10.</p>
|
|
<p>This is used by <a href="TreeLayout.html#addComments">addComments</a> and <a href="TreeLayout.html#layoutComments">layoutComments</a>.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="comments" class="tsd-anchor"></a>
|
|
<h3>
|
|
comments
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets whether this layout should find all <a href="Node.html">Node</a>s
|
|
whose category is "Comment" and
|
|
whose anchors are nodes represented in the network,
|
|
and increase the size of the corresponding TreeVertex to make room for the comment nodes.
|
|
The default value is true.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.3</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="compaction" class="tsd-anchor"></a>
|
|
<h3>
|
|
compaction
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets how closely to pack the child nodes of a subtree.
|
|
Must be either <a href="TreeLayout.html#static-CompactionBlock">TreeLayout.CompactionBlock</a> or <a href="TreeLayout.html#static-CompactionNone">TreeLayout.CompactionNone</a>.</p>
|
|
<p>The default value is <a href="TreeLayout.html#static-CompactionBlock">CompactionBlock</a>.</p>
|
|
<p>This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="comparer" class="tsd-anchor"></a>
|
|
<h3>
|
|
comparer
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">a</span><span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">b</span><span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the default comparison function used for sorting the immediate children of a vertex.</p>
|
|
<p>The default comparer compares the <a href="LayoutVertex.html#node">LayoutVertex.node</a> Text values.</p>
|
|
<p>This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.
|
|
Whether this comparison function is used is determined by the value of <a href="TreeLayout.html#sorting">sorting</a>.</p>
|
|
<pre><code class="hljs js"> $(go.TreeLayout,
|
|
{
|
|
<span class="hljs-attr">sorting</span>: go.TreeLayout.SortingAscending,
|
|
<span class="hljs-attr">comparer</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">va, vb</span>) </span>{
|
|
<span class="hljs-keyword">var</span> da = va.node.data;
|
|
<span class="hljs-keyword">var</span> db = vb.node.data;
|
|
<span class="hljs-keyword">if</span> (da.someProperty < db.someProperty) <span class="hljs-keyword">return</span> <span class="hljs-number">-1</span>;
|
|
<span class="hljs-keyword">if</span> (da.someProperty > db.someProperty) <span class="hljs-keyword">return</span> <span class="hljs-number">1</span>;
|
|
<span class="hljs-keyword">return</span> <span class="hljs-number">0</span>;
|
|
}
|
|
}
|
|
)</code></pre>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="layerSpacing" class="tsd-anchor"></a>
|
|
<h3>
|
|
layer<wbr>Spacing
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the distance between a parent node and its children.</p>
|
|
<p>The default value is 50.</p>
|
|
<p>This is the distance between a parent node and its first row
|
|
of children, in case there are multiple rows of its children.
|
|
The <a href="TreeLayout.html#rowSpacing">rowSpacing</a> property determines the distance
|
|
between rows of children.
|
|
Negative values may cause children to overlap with the parent.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="layerSpacingParentOverlap" class="tsd-anchor"></a>
|
|
<h3>
|
|
layer<wbr>Spacing<wbr>Parent<wbr>Overlap
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the fraction of the node's depth for which the children's layer starts overlapped with the parent's layer.</p>
|
|
<p>The default value is 0.0 -- there is overlap between layers only if <a href="TreeLayout.html#layerSpacing">layerSpacing</a> is negative.
|
|
A value of 1.0 and a zero <a href="TreeLayout.html#layerSpacing">layerSpacing</a> will cause child nodes to completely overlap the parent.</p>
|
|
<p>A value greater than zero may still cause overlap between layers,
|
|
unless the value of <a href="TreeLayout.html#layerSpacing">layerSpacing</a> is large enough.
|
|
A value of zero might still allow overlap between layers,
|
|
if <a href="TreeLayout.html#layerSpacing">layerSpacing</a> is negative.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="layerStyle" class="tsd-anchor"></a>
|
|
<h3>
|
|
layer<wbr>Style
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the manner in which the nodes are aligned in layers.
|
|
Must be <a href="TreeLayout.html#static-LayerIndividual">TreeLayout.LayerIndividual</a>, <a href="TreeLayout.html#static-LayerSiblings">TreeLayout.LayerSiblings</a>,
|
|
or <a href="TreeLayout.html#static-LayerUniform">TreeLayout.LayerUniform</a>.</p>
|
|
<p>The default value is <a href="TreeLayout.html#static-LayerIndividual">TreeLayout.LayerIndividual</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.4</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="nodeIndent" class="tsd-anchor"></a>
|
|
<h3>
|
|
node<wbr>Indent
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the default indentation of the first child.</p>
|
|
<p>The default value is zero. The value should be non-negative.</p>
|
|
<p>This property is only sensible when the <a href="TreeLayout.html#alignment">alignment</a>
|
|
is <a href="TreeLayout.html#static-AlignmentStart">AlignmentStart</a> or <a href="TreeLayout.html#static-AlignmentEnd">AlignmentEnd</a>.
|
|
Having a positive value is useful if you want to reserve space
|
|
at the start of the row of children for some reason.
|
|
For example, if you want to pretend the parent node is infinitely deep,
|
|
you can set this to be the breadth of the parent node.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="nodeIndentPastParent" class="tsd-anchor"></a>
|
|
<h3>
|
|
node<wbr>Indent<wbr>Past<wbr>Parent
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the fraction of this node's breadth is added to <a href="TreeLayout.html#nodeIndent">nodeIndent</a>
|
|
to determine any spacing at the start of the children.</p>
|
|
<p>The default value is 0.0 -- the only indentation is specified by <a href="TreeLayout.html#nodeIndent">nodeIndent</a>.
|
|
When the value is 1.0, the children will be indented past the breadth of the parent node.</p>
|
|
<p>This property is only sensible when the <a href="TreeLayout.html#alignment">alignment</a>
|
|
is <a href="TreeLayout.html#static-AlignmentStart">AlignmentStart</a> or <a href="TreeLayout.html#static-AlignmentEnd">AlignmentEnd</a>.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="nodeSpacing" class="tsd-anchor"></a>
|
|
<h3>
|
|
node<wbr>Spacing
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<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 causes sibling nodes to overlap.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="path" class="tsd-anchor"></a>
|
|
<h3>
|
|
path
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets how the tree should be constructed from the
|
|
<a href="TreeEdge.html">TreeEdge</a>s connecting <a href="TreeVertex.html">TreeVertex</a>es.
|
|
Must be <a href="TreeLayout.html#static-PathDestination">TreeLayout.PathDestination</a> or <a href="TreeLayout.html#static-PathSource">TreeLayout.PathSource</a> or <a href="TreeLayout.html#static-PathDefault">TreeLayout.PathDefault</a>.</p>
|
|
<p>The default value is <a href="TreeLayout.html#static-PathDefault">TreeLayout.PathDefault</a>,
|
|
where the value of <a href="Diagram.html#isTreePathToChildren">Diagram.isTreePathToChildren</a> determines the effective value of this property.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="portSpot" class="tsd-anchor"></a>
|
|
<h3>
|
|
port<wbr>Spot
|
|
<span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type">Spot</a> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the spot that this node's port gets as its FromSpot.</p>
|
|
<p>The default value is <a href="Spot.html#static-Default">Spot.Default</a>.</p>
|
|
<p>A value of <a href="Spot.html#static-Default">Spot.Default</a> will cause the TreeLayout
|
|
to assign a FromSpot based on the parent node's <a href="TreeVertex.html#angle">TreeVertex.angle</a>.
|
|
If the value is other than NoSpot, it is just assigned.
|
|
When <a href="TreeLayout.html#path">path</a> is <a href="TreeLayout.html#static-PathSource">PathSource</a>,
|
|
the port's ToSpot is set instead of the FromSpot.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="rootDefaults" class="tsd-anchor"></a>
|
|
<h3>
|
|
root<wbr>Defaults
|
|
<span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the object holding the default values for root <a href="TreeVertex.html">TreeVertex</a>es.</p>
|
|
<p>The values for the following inheritable properties are actually stored in this object:
|
|
<a href="TreeLayout.html#sorting">sorting</a>, <a href="TreeLayout.html#comparer">comparer</a>, <a href="TreeLayout.html#angle">angle</a>,
|
|
<a href="TreeLayout.html#alignment">alignment</a>, <a href="TreeLayout.html#nodeIndent">nodeIndent</a>, <a href="TreeLayout.html#nodeIndentPastParent">nodeIndentPastParent</a>,
|
|
<a href="TreeLayout.html#nodeSpacing">nodeSpacing</a>, <a href="TreeLayout.html#layerSpacing">layerSpacing</a>, <a href="TreeLayout.html#layerSpacingParentOverlap">layerSpacingParentOverlap</a>,
|
|
<a href="TreeLayout.html#compaction">compaction</a>, <a href="TreeLayout.html#breadthLimit">breadthLimit</a>, <a href="TreeLayout.html#rowSpacing">rowSpacing</a>, <a href="TreeLayout.html#rowIndent">rowIndent</a>,
|
|
<a href="TreeLayout.html#commentSpacing">commentSpacing</a>, <a href="TreeLayout.html#commentMargin">commentMargin</a>,
|
|
<a href="TreeLayout.html#setsPortSpot">setsPortSpot</a>, <a href="TreeLayout.html#portSpot">portSpot</a>, <a href="TreeLayout.html#setsChildPortSpot">setsChildPortSpot</a>, <a href="TreeLayout.html#childPortSpot">childPortSpot</a>.
|
|
The other properties of this <a href="TreeVertex.html">TreeVertex</a> are ignored.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="roots" class="tsd-anchor"></a>
|
|
<h3>
|
|
roots
|
|
<span class="tsd-signature-symbol">: </span><a href="Set.html" class="tsd-signature-type">Set</a><span class="tsd-signature-symbol"><</span><a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a><span class="tsd-signature-symbol">></span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the collection of root vertexes.</p>
|
|
<p>Initially this will be an empty <a href="Set.html">Set</a>.</p>
|
|
<p>If the <a href="TreeLayout.html#path">path</a> is either <a href="TreeLayout.html#static-PathDestination">PathDestination</a> or
|
|
<a href="TreeLayout.html#static-PathSource">PathSource</a>, this layout can easily
|
|
determine all of the tree roots by searching the whole network.
|
|
Otherwise, you should explicitly initialize this collection
|
|
with one or more <a href="TreeVertex.html">TreeVertex</a>es.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="rowIndent" class="tsd-anchor"></a>
|
|
<h3>
|
|
row<wbr>Indent
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the default indentation of the first child of each row,
|
|
if the <a href="TreeLayout.html#alignment">alignment</a> is not a "Center" alignment.</p>
|
|
<p>The default value is 10. The value should be non-negative.</p>
|
|
<p>This is used to leave room for the links that connect a parent node
|
|
with the child nodes that are in additional rows.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="rowSpacing" class="tsd-anchor"></a>
|
|
<h3>
|
|
row<wbr>Spacing
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the distance between rows of children.</p>
|
|
<p>The default value is 25.</p>
|
|
<p>This property is only used when there is more than one
|
|
row of children for a given parent node.
|
|
<a href="TreeLayout.html#layerSpacing">layerSpacing</a> determines the distance between
|
|
the parent node and its first row of child nodes.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="setsChildPortSpot" class="tsd-anchor"></a>
|
|
<h3>
|
|
sets<wbr>Child<wbr>Port<wbr>Spot
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<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 spot of the ports of the children nodes,
|
|
if the node has only a single port.</p>
|
|
<p>The spot used depends on the value of <a href="TreeLayout.html#childPortSpot">childPortSpot</a>.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="setsPortSpot" class="tsd-anchor"></a>
|
|
<h3>
|
|
sets<wbr>Port<wbr>Spot
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<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>The spot used depends on the value of <a href="TreeLayout.html#portSpot">portSpot</a>.
|
|
This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="sorting" class="tsd-anchor"></a>
|
|
<h3>
|
|
sorting
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the default sorting policy for ordering the immediate children of a vertex.
|
|
Must be <a href="TreeLayout.html#static-SortingForwards">TreeLayout.SortingForwards</a>, <a href="TreeLayout.html#static-SortingReverse">TreeLayout.SortingReverse</a>,
|
|
<a href="TreeLayout.html#static-SortingAscending">TreeLayout.SortingAscending</a>, or <a href="TreeLayout.html#static-SortingDescending">TreeLayout.SortingDescending</a>.</p>
|
|
<p>The default value is <a href="TreeLayout.html#static-SortingForwards">TreeLayout.SortingForwards</a>.</p>
|
|
<p>This sets the <a href="TreeLayout.html#rootDefaults">rootDefaults</a>' property of the same name.
|
|
The sort order is determined by <a href="TreeLayout.html#comparer">comparer</a>.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="treeStyle" class="tsd-anchor"></a>
|
|
<h3>
|
|
tree<wbr>Style
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the Style for the resulting trees.
|
|
Must be <a href="TreeLayout.html#static-StyleLayered">TreeLayout.StyleLayered</a>, <a href="TreeLayout.html#static-StyleAlternating">TreeLayout.StyleAlternating</a>,
|
|
<a href="TreeLayout.html#static-StyleLastParents">TreeLayout.StyleLastParents</a>, or <a href="TreeLayout.html#static-StyleRootOnly">TreeLayout.StyleRootOnly</a>.</p>
|
|
<p>The default value is <a href="TreeLayout.html#static-StyleLayered">TreeLayout.StyleLayered</a>.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="addComments" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
add<wbr>Comments
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Comments<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Find any associated objects to be positioned along with the <a href="LayoutVertex.html#node">LayoutVertex.node</a>.</p>
|
|
<p>This looks for visible <a href="Node.html">Node</a>'s whose category is "Comment" and
|
|
that refer to the tree vertex's <a href="Node.html">Node</a>.
|
|
This method is only called when <a href="TreeLayout.html#comments">comments</a> is true.</p>
|
|
<p>You may want to override this method in order to customize how
|
|
any associated objects are found and how the node's <a href="LayoutVertex.html#bounds">LayoutVertex.bounds</a>
|
|
are set to reserve space for those associated objects.
|
|
This method should not walk the tree, since it is called for each
|
|
<a href="TreeVertex.html">TreeVertex</a> in an indeterminate order.
|
|
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>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.2</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>v: <a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="arrangeTrees" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
arrange<wbr>Trees
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">arrange<wbr>Trees<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></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Position each separate tree.</p>
|
|
<p>This is called after each tree has been laid out and thus each subtree
|
|
bounds are known.
|
|
The <a href="TreeLayout.html#arrangement">arrangement</a> and <a href="TreeLayout.html#arrangementSpacing">arrangementSpacing</a> and <a href="Layout.html#arrangementOrigin">Layout.arrangementOrigin</a>
|
|
properties affect this method's behavior.
|
|
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>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.2</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="assignTreeVertexValues" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
assign<wbr>Tree<wbr>Vertex<wbr>Values
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">assign<wbr>Tree<wbr>Vertex<wbr>Values<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Assign final property values for a <a href="TreeVertex.html">TreeVertex</a>.</p>
|
|
<p>This method is commonly overridden in order to provide
|
|
tree layout properties for particular nodes.
|
|
This method is called after values have been inherited from other
|
|
<a href="TreeVertex.html">TreeVertex</a>es, so you can examine and modify the
|
|
values of related tree nodes.
|
|
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>
|
|
<p>However, when <a href="TreeVertex.html#alignment">TreeVertex.alignment</a> is <a href="TreeLayout.html#static-AlignmentBusBranching">TreeLayout.AlignmentBusBranching</a>,
|
|
changing the <a href="TreeVertex.html#sorting">TreeVertex.sorting</a> or
|
|
<a href="TreeVertex.html#comparer">TreeVertex.comparer</a> properties in this method will have no effect.</p>
|
|
<p>This method should not walk the tree, since it is called for each
|
|
<a href="TreeVertex.html">TreeVertex</a> in a depth-first manner starting at a root.</p>
|
|
<p>Here is an example where the children are squeezed together if there are many of them,
|
|
but only on nodes that have no grandchildren. This makes use of two <a href="TreeVertex.html">TreeVertex</a>
|
|
properties that are automatically computed for you, <a href="TreeVertex.html#childrenCount">TreeVertex.childrenCount</a> and <a href="TreeVertex.html#descendantCount">TreeVertex.descendantCount</a>.</p>
|
|
<pre><code class="hljs js"> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">SqueezingTreeLayout</span>(<span class="hljs-params"></span>) </span>{
|
|
go.TreeLayout.call(<span class="hljs-keyword">this</span>);
|
|
}
|
|
go.Diagram.inherit(SqueezingTreeLayout, go.TreeLayout);
|
|
|
|
public assignTreeVertexValues(v) {
|
|
<span class="hljs-keyword">if</span> (v.childrenCount > <span class="hljs-number">6</span> && v.childrenCount === v.descendantCount) {
|
|
v.alignment = go.TreeLayout.AlignmentBottomRightBus;
|
|
v.layerSpacing = <span class="hljs-number">10</span>;
|
|
v.rowSpacing = <span class="hljs-number">0</span>;
|
|
}
|
|
}</code></pre>
|
|
<p>If you need to assign TreeVertex values and also have them be "inherited" by the child vertexes,
|
|
you should override <a href="TreeLayout.html#initializeTreeVertexValues">initializeTreeVertexValues</a> instead.
|
|
However at the time that method is called, the computed properties of TreeVertex will not be available.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.1</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>v: <a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<a name="commitLayers" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
commit<wbr>Layers
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-kind-icon">commit<wbr>Layers<span class="tsd-signature-symbol">(</span>layerRects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="Rect.html" class="tsd-signature-type">Rect</a><span class="tsd-signature-symbol">></span>, offset<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This overridable method is called by <a href="TreeLayout.html#commitLayout">commitLayout</a>
|
|
if <a href="TreeLayout.html#layerStyle">layerStyle</a> is LayerUniform
|
|
to support custom arrangement of bands or labels across each layout layer.
|
|
By default this method does nothing.</p>
|
|
<p>The coordinates used in the resulting Rects may need to be offset by the <a href="Layout.html#arrangementOrigin">Layout.arrangementOrigin</a>
|
|
and/or by the arrangement of subtrees done by <a href="TreeLayout.html#arrangeTrees">arrangeTrees</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.4</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>layerRects: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="Rect.html" class="tsd-signature-type">Rect</a><span class="tsd-signature-symbol">></span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>an Array of <a href="Rect.html">Rect</a>s with the bounds of each of the "layers"</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>offset: <a href="Point.html" class="tsd-signature-type">Point</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the position of the top-left corner of the banded area relative to the coordinates given by the layerRects</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<a name="commitLayout" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagOverride">Override</span>
|
|
commit<wbr>Layout
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-kind-icon">commit<wbr>Layout<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></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Set the fromSpot and toSpot on each Link, position each Node according
|
|
to the vertex position, and then position/route the Links.</p>
|
|
<p>This calls the <a href="TreeLayout.html#commitNodes">commitNodes</a> and <a href="TreeLayout.html#commitLinks">commitLinks</a> methods, the latter only if <a href="Layout.html#isRouting">isRouting</a> is true.
|
|
You should not call this method -- it is a "protected virtual" method.
|
|
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 <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<a name="commitLinks" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
commit<wbr>Links
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-kind-icon">commit<wbr>Links<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></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Routes the links.</p>
|
|
<p>This is called by <a href="TreeLayout.html#commitLayout">commitLayout</a>.
|
|
This is only called if <a href="Layout.html#isRouting">Layout.isRouting</a> is true.
|
|
See also <a href="TreeLayout.html#commitNodes">commitNodes</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 <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<a name="commitNodes" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
commit<wbr>Nodes
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-kind-icon">commit<wbr>Nodes<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></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Commit the position of all nodes.</p>
|
|
<p>This is called by <a href="TreeLayout.html#commitLayout">commitLayout</a>.
|
|
See also <a href="TreeLayout.html#commitLinks">commitLinks</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 <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="createNetwork" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagOverride">Override</span>
|
|
create<wbr>Network
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Network<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TreeNetwork.html" class="tsd-signature-type">TreeNetwork</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Create a new <a href="LayoutNetwork.html">LayoutNetwork</a> of <a href="TreeVertex.html">TreeVertex</a>es and <a href="TreeEdge.html">TreeEdge</a>s.</p>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <a href="TreeNetwork.html" class="tsd-signature-type">TreeNetwork</a></h4>
|
|
<p>a new <a href="LayoutNetwork.html">LayoutNetwork</a>.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="doLayout" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagOverride">Override</span>
|
|
do<wbr>Layout
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">do<wbr>Layout<span class="tsd-signature-symbol">(</span>coll<span class="tsd-signature-symbol">: </span><a href="Diagram.html" class="tsd-signature-type">Diagram</a><span class="tsd-signature-symbol"> | </span><a href="Group.html" class="tsd-signature-type">Group</a><span class="tsd-signature-symbol"> | </span><a href="Iterable.html" class="tsd-signature-type">Iterable</a><span class="tsd-signature-symbol"><</span><a href="Part.html" class="tsd-signature-type">Part</a><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></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Perform the tree layout.</p>
|
|
<p>If there is no <a href="Layout.html#network">Layout.network</a>, this calls <a href="TreeLayout.html#makeNetwork">makeNetwork</a> to create a <a href="LayoutNetwork.html">LayoutNetwork</a> from the given collection of Parts.</p>
|
|
<p>If there are no <a href="TreeVertex.html">TreeVertex</a> <a href="TreeLayout.html#roots">roots</a> specified, this finds all roots in the <a href="Layout.html#network">Layout.network</a>.</p>
|
|
<p>This initializes all of the <a href="TreeVertex.html">TreeVertex</a>es and <a href="TreeEdge.html">TreeEdge</a>s, calling <a href="TreeLayout.html#initializeTreeVertexValues">initializeTreeVertexValues</a> on each vertex,
|
|
supporting inheritance of vertex values.
|
|
Then it calls <a href="TreeLayout.html#assignTreeVertexValues">assignTreeVertexValues</a> on each one, to allow for node/vertex-specific customizations.
|
|
Next it sorts all of the child vertexes for each parent vertex, if needed.</p>
|
|
<p>This also calls <a href="TreeLayout.html#addComments">addComments</a> of each vertex, in order to find any comment nodes associated with each vertex,
|
|
so that they can be accommodated by the layout.</p>
|
|
<p>This then actually does the "layout" of the vertexes and optionally the routing of the edges of each tree in the network.
|
|
To deal with multiple roots/trees this also calls <a href="TreeLayout.html#arrangeTrees">arrangeTrees</a> to position each separate tree relative to each other.</p>
|
|
<p>Finally this calls <a href="Layout.html#updateParts">Layout.updateParts</a> to commit the Node positions from the vertex positions and the Link routes from the edges.
|
|
<a href="Layout.html#updateParts">Layout.updateParts</a> calls <a href="TreeLayout.html#commitLayout">commitLayout</a> within a transaction.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>coll: <a href="Diagram.html" class="tsd-signature-type">Diagram</a><span class="tsd-signature-symbol"> | </span><a href="Group.html" class="tsd-signature-type">Group</a><span class="tsd-signature-symbol"> | </span><a href="Iterable.html" class="tsd-signature-type">Iterable</a><span class="tsd-signature-symbol"><</span><a href="Part.html" class="tsd-signature-type">Part</a><span class="tsd-signature-symbol">></span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A <a href="Diagram.html">Diagram</a> or a <a href="Group.html">Group</a> or a collection of <a href="Part.html">Part</a>s.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="initializeTreeVertexValues" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
initialize<wbr>Tree<wbr>Vertex<wbr>Values
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">initialize<wbr>Tree<wbr>Vertex<wbr>Values<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Assign initial property values for a <a href="TreeVertex.html">TreeVertex</a>.</p>
|
|
<p>The values may be inherited, so this method is called while
|
|
propagating values from the root nodes.
|
|
This method should not walk the tree, since it is called for each
|
|
<a href="TreeVertex.html">TreeVertex</a> in a depth-first manner starting at a root.</p>
|
|
<p>You probably do not need to override this method,
|
|
but if you do you should call first either the base method
|
|
or <a href="TreeVertex.html#copyInheritedPropertiesFrom">TreeVertex.copyInheritedPropertiesFrom</a>, since they
|
|
assign most of the <a href="TreeVertex.html">TreeVertex</a> property values
|
|
used to influence the layout.
|
|
Informational properties such as <a href="TreeVertex.html#descendantCount">TreeVertex.descendantCount</a>
|
|
and <a href="TreeVertex.html#maxGenerationCount">TreeVertex.maxGenerationCount</a> will not yet have been initialized
|
|
by the time this method is called.
|
|
It is more common to override <a href="TreeLayout.html#assignTreeVertexValues">assignTreeVertexValues</a> in order to
|
|
modify a property or two to customize the layout at that node.
|
|
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>
|
|
<p>When the <a href="TreeVertex.html#alignment">TreeVertex.alignment</a> is <a href="TreeLayout.html#static-AlignmentBusBranching">TreeLayout.AlignmentBusBranching</a>,
|
|
this will modify the <a href="TreeVertex.html#angle">TreeVertex.angle</a> appropriately depending on which
|
|
side of the bus the vertex is on.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.2</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>v: <a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="layoutComments" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
layout<wbr>Comments
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">layout<wbr>Comments<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Position and <a href="TreeVertex.html#comments">TreeVertex.comments</a> around the vertex.</p>
|
|
<p>This method should not walk the tree, since it is called for each
|
|
<a href="TreeVertex.html">TreeVertex</a> in an indeterminate order.
|
|
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>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.2</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>v: <a href="TreeVertex.html" class="tsd-signature-type">TreeVertex</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="makeNetwork" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagOverride">Override</span>
|
|
make<wbr>Network
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Network<span class="tsd-signature-symbol">(</span>coll<span class="tsd-signature-symbol">: </span><a href="Diagram.html" class="tsd-signature-type">Diagram</a><span class="tsd-signature-symbol"> | </span><a href="Group.html" class="tsd-signature-type">Group</a><span class="tsd-signature-symbol"> | </span><a href="Iterable.html" class="tsd-signature-type">Iterable</a><span class="tsd-signature-symbol"><</span><a href="Part.html" class="tsd-signature-type">Part</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LayoutNetwork.html" class="tsd-signature-type">LayoutNetwork</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Create and initialize a <a href="LayoutNetwork.html">LayoutNetwork</a> with the given nodes and links.</p>
|
|
<p>This does not include any nodes of category "Comment".
|
|
Comment nodes are added by the <a href="TreeLayout.html#addComments">addComments</a> method.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>coll: <a href="Diagram.html" class="tsd-signature-type">Diagram</a><span class="tsd-signature-symbol"> | </span><a href="Group.html" class="tsd-signature-type">Group</a><span class="tsd-signature-symbol"> | </span><a href="Iterable.html" class="tsd-signature-type">Iterable</a><span class="tsd-signature-symbol"><</span><a href="Part.html" class="tsd-signature-type">Part</a><span class="tsd-signature-symbol">></span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A <a href="Diagram.html">Diagram</a> or a <a href="Group.html">Group</a> or a collection of <a href="Part.html">Part</a>s.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="LayoutNetwork.html" class="tsd-signature-type">LayoutNetwork</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constants</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-AlignmentBottomRightBus" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Alignment<wbr>Bottom<wbr>Right<wbr>Bus
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The children are positioned in a bus, only on the bottom or right side of the parent;
|
|
this value is used for <a href="TreeLayout.html#alignment">TreeLayout.alignment</a> or <a href="TreeLayout.html#alternateAlignment">TreeLayout.alternateAlignment</a>.</p>
|
|
<p>A bus does not take <a href="TreeVertex.html#breadthLimit">TreeVertex.breadthLimit</a> into account.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-AlignmentBus" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Alignment<wbr>Bus
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The children are positioned in a bus on both sides of an "aisle" where the links to them go,
|
|
with the last odd child (if any) placed at the end of the aisle in the middle;
|
|
this value is used for <a href="TreeLayout.html#alignment">TreeLayout.alignment</a> or <a href="TreeLayout.html#alternateAlignment">TreeLayout.alternateAlignment</a>.</p>
|
|
<p>The children, if they are themselves parents, continue at the same inherited angle;
|
|
use <a href="TreeLayout.html#static-AlignmentBusBranching">TreeLayout.AlignmentBusBranching</a> if you want grandchildren to proceed growing in
|
|
the different angle as determined by the side.</p>
|
|
<p>A bus does not take <a href="TreeVertex.html#breadthLimit">TreeVertex.breadthLimit</a> into account.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-AlignmentBusBranching" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Alignment<wbr>Bus<wbr>Branching
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Like <a href="TreeLayout.html#static-AlignmentBus">TreeLayout.AlignmentBus</a> with the children arranged on both sides of an "aisle"
|
|
with any last odd child placed at the end of the aisle,
|
|
but the children get an <a href="TreeVertex.html#angle">TreeVertex.angle</a> that depends on which side of the aisle
|
|
they were placed;
|
|
this value is used for <a href="TreeLayout.html#alignment">TreeLayout.alignment</a> or <a href="TreeLayout.html#alternateAlignment">TreeLayout.alternateAlignment</a>.</p>
|
|
<p>This only works well when the <a href="TreeLayout.html#treeStyle">TreeLayout.treeStyle</a> is <a href="TreeLayout.html#static-StyleLayered">TreeLayout.StyleLayered</a>.</p>
|
|
<p>A bus does not take <a href="TreeVertex.html#breadthLimit">TreeVertex.breadthLimit</a> into account.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-AlignmentCenterChildren" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Alignment<wbr>Center<wbr>Children
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The parent is centered at the middle of the range of its immediate child nodes;
|
|
this value is used for <a href="TreeLayout.html#alignment">TreeLayout.alignment</a> or <a href="TreeLayout.html#alternateAlignment">TreeLayout.alternateAlignment</a>.</p>
|
|
<p>When there is a breadth limit that causes there to be multiple rows,
|
|
the links that extend from the parent to those children in rows past
|
|
the first one may cross over the nodes that are in earlier rows.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-AlignmentCenterSubtrees" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Alignment<wbr>Center<wbr>Subtrees
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The parent is centered at the middle of the range of its child subtrees;
|
|
this value is used for <a href="TreeLayout.html#alignment">TreeLayout.alignment</a> or <a href="TreeLayout.html#alternateAlignment">TreeLayout.alternateAlignment</a>.</p>
|
|
<p>When there is a breadth limit that causes there to be multiple rows,
|
|
the links that extend from the parent to those children in rows past
|
|
the first one may cross over the nodes that are in earlier rows.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-AlignmentEnd" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Alignment<wbr>End
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The parent is positioned near the last of its children;
|
|
this value is used for <a href="TreeLayout.html#alignment">TreeLayout.alignment</a> or <a href="TreeLayout.html#alternateAlignment">TreeLayout.alternateAlignment</a>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-AlignmentStart" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Alignment<wbr>Start
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The parent is positioned near the first of its children;
|
|
this value is used for <a href="TreeLayout.html#alignment">TreeLayout.alignment</a> or <a href="TreeLayout.html#alternateAlignment">TreeLayout.alternateAlignment</a>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-AlignmentTopLeftBus" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Alignment<wbr>Top<wbr>Left<wbr>Bus
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The children are positioned in a bus, only on the top or left side of the parent;
|
|
this value is used for <a href="TreeLayout.html#alignment">TreeLayout.alignment</a> or <a href="TreeLayout.html#alternateAlignment">TreeLayout.alternateAlignment</a>.</p>
|
|
<p>A bus does not take <a href="TreeVertex.html#breadthLimit">TreeVertex.breadthLimit</a> into account.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-ArrangementFixedRoots" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Arrangement<wbr>Fixed<wbr>Roots
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Do not move each root node, but position all of their descendants relative to their root;
|
|
this value is used for <a href="TreeLayout.html#arrangement">TreeLayout.arrangement</a>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-ArrangementHorizontal" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Arrangement<wbr>Horizontal
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Position each tree in a non-overlapping fashion by increasing X coordinates,
|
|
starting at the <a href="Layout.html#arrangementOrigin">Layout.arrangementOrigin</a>;
|
|
this value is used for <a href="TreeLayout.html#arrangement">TreeLayout.arrangement</a>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-ArrangementVertical" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Arrangement<wbr>Vertical
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Position each tree in a non-overlapping fashion by increasing Y coordinates,
|
|
starting at the <a href="Layout.html#arrangementOrigin">Layout.arrangementOrigin</a>;
|
|
this value is used for <a href="TreeLayout.html#arrangement">TreeLayout.arrangement</a>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-CompactionBlock" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Compaction<wbr>Block
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A simple fitting of subtrees;
|
|
this value is used for <a href="TreeLayout.html#compaction">TreeLayout.compaction</a> or <a href="TreeLayout.html#alternateCompaction">TreeLayout.alternateCompaction</a>.</p>
|
|
<p>This mode produces more compact trees -- often nicer looking too;
|
|
Nodes will not overlap each other, unless you have negative values
|
|
for some of the spacing properties;
|
|
However it is possible when the links are orthogonally styled that
|
|
occasionally the subtrees will be placed so close together that some
|
|
links may overlap the links or even the nodes of other subtrees.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-CompactionNone" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Compaction<wbr>None
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Only simple placement of children next to each other, as determined by their subtree breadth;
|
|
this value is used for <a href="TreeLayout.html#compaction">TreeLayout.compaction</a> or <a href="TreeLayout.html#alternateCompaction">TreeLayout.alternateCompaction</a>.</p>
|
|
<p>For any node, there will not be another node at any depth occupying the same breadth position,
|
|
unless there are multiple rows; In other words, if there is no breadth limit resulting in
|
|
multiple rows, with this compaction mode it is as if every node were infinitely deep.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-LayerIndividual" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Layer<wbr>Individual
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The normal layer style, where each node takes up only the depth that it needs;
|
|
this value is used for <a href="TreeLayout.html#layerStyle">TreeLayout.layerStyle</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.4</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-LayerSiblings" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Layer<wbr>Siblings
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A layer style where all of the children of a parent node take up the same amount of depth --
|
|
this typically causes all cousins to be aligned;
|
|
this value is used for <a href="TreeLayout.html#layerStyle">TreeLayout.layerStyle</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.4</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-LayerUniform" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Layer<wbr>Uniform
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A layer style where all nodes with the same <a href="TreeVertex.html#level">TreeVertex.level</a> throughout the tree take up the same amount of depth --
|
|
if the <a href="TreeVertex.html#angle">TreeVertex.angle</a> is the same for all nodes, this will result in all nodes in the same layer to be aligned;
|
|
this value is used for <a href="TreeLayout.html#layerStyle">TreeLayout.layerStyle</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.4</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-PathDefault" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Path<wbr>Default
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This value for <a href="TreeLayout.html#path">TreeLayout.path</a> causes the value of <a href="Diagram.html#isTreePathToChildren">Diagram.isTreePathToChildren</a>
|
|
to effectively choose either <a href="TreeLayout.html#static-PathDestination">TreeLayout.PathDestination</a> (if true) or <a href="TreeLayout.html#static-PathSource">TreeLayout.PathSource</a> (if false).</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-PathDestination" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Path<wbr>Destination
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The children of a <a href="TreeVertex.html">TreeVertex</a> are its <a href="LayoutVertex.html#destinationVertexes">LayoutVertex.destinationVertexes</a>,
|
|
the collection of connected <a href="LayoutEdge.html#toVertex">LayoutEdge.toVertex</a>es;
|
|
this value is used for <a href="TreeLayout.html#path">TreeLayout.path</a>.</p>
|
|
<p>The tree roots are those <a href="TreeVertex.html">TreeVertex</a>es that have zero source edges.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-PathSource" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Path<wbr>Source
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The children of a <a href="TreeVertex.html">TreeVertex</a> are its <a href="LayoutVertex.html#sourceVertexes">LayoutVertex.sourceVertexes</a>,
|
|
the collection of connected <a href="LayoutEdge.html#fromVertex">LayoutEdge.fromVertex</a>es;
|
|
this value is used for <a href="TreeLayout.html#path">TreeLayout.path</a>.</p>
|
|
<p>The tree roots are those <a href="TreeVertex.html">TreeVertex</a>es that have zero destination edges.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-SortingAscending" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Sorting<wbr>Ascending
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Lay out each child according to the sort order given by <a href="TreeVertex.html#comparer">TreeVertex.comparer</a>;
|
|
this value is used for <a href="TreeLayout.html#sorting">TreeLayout.sorting</a> or <a href="TreeLayout.html#alternateSorting">TreeLayout.alternateSorting</a>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-SortingDescending" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Sorting<wbr>Descending
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Lay out each child in reverse sort order given by <a href="TreeVertex.html#comparer">TreeVertex.comparer</a>;
|
|
this value is used for <a href="TreeLayout.html#sorting">TreeLayout.sorting</a> or <a href="TreeLayout.html#alternateSorting">TreeLayout.alternateSorting</a>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-SortingForwards" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Sorting<wbr>Forwards
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Lay out each child in the order in which they were found;
|
|
this value is used for <a href="TreeLayout.html#sorting">TreeLayout.sorting</a> or <a href="TreeLayout.html#alternateSorting">TreeLayout.alternateSorting</a>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-SortingReverse" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Sorting<wbr>Reverse
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Lay out each child in reverse order from which they were found;
|
|
this value is used for <a href="TreeLayout.html#sorting">TreeLayout.sorting</a> or <a href="TreeLayout.html#alternateSorting">TreeLayout.alternateSorting</a>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-StyleAlternating" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Style<wbr>Alternating
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Alternate layers of the tree have different properties, typically including the angle;
|
|
this value is used for <a href="TreeLayout.html#treeStyle">TreeLayout.treeStyle</a>.</p>
|
|
<p>Each <a href="TreeVertex.html">TreeVertex</a> gets its properties from its grandparent node;
|
|
The root nodes get their defaults from <a href="TreeLayout.html#rootDefaults">TreeLayout.rootDefaults</a>.</p>
|
|
<p>The immediate children of root nodes get their defaults from <a href="TreeLayout.html#alternateDefaults">TreeLayout.alternateDefaults</a>.</p>
|
|
<p>Depending on the properties used, it is possible for some link routes to cross over nodes.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-StyleLastParents" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Style<wbr>Last<wbr>Parents
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Just like the standard layered tree style, except that the nodes with children but no grandchildren
|
|
have alternate properties;
|
|
this value is used for <a href="TreeLayout.html#treeStyle">TreeLayout.treeStyle</a>.</p>
|
|
<p>Each <a href="TreeVertex.html">TreeVertex</a> gets its properties from its parent node;
|
|
However, for those nodes whose <a href="TreeVertex.html#maxGenerationCount">TreeVertex.maxGenerationCount</a> is 1,
|
|
in other words when it has children but no grandchildren,
|
|
the properties are copied from <a href="TreeLayout.html#alternateDefaults">TreeLayout.alternateDefaults</a>.</p>
|
|
<p>If the tree only has two levels, the root node gets the <a href="TreeLayout.html#rootDefaults">TreeLayout.rootDefaults</a>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-StyleLayered" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Style<wbr>Layered
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The normal tree style, where all of the children of each <a href="TreeVertex.html">TreeVertex</a> are lined up
|
|
horizontally or vertically;
|
|
this value is used for <a href="TreeLayout.html#treeStyle">TreeLayout.treeStyle</a>.</p>
|
|
<p>Each <a href="TreeVertex.html">TreeVertex</a> gets its properties from its parent node;
|
|
<a href="TreeLayout.html#rootDefaults">TreeLayout.rootDefaults</a> is used for all default <a href="TreeVertex.html">TreeVertex</a> property values;
|
|
<a href="TreeLayout.html#alternateDefaults">TreeLayout.alternateDefaults</a> is ignored.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-StyleRootOnly" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Style<wbr>Root<wbr>Only
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>All of the nodes get the alternate properties, except the root node gets the default properties;
|
|
this value is used for <a href="TreeLayout.html#treeStyle">TreeLayout.treeStyle</a>.</p>
|
|
<p>The root node gets the <a href="TreeLayout.html#rootDefaults">TreeLayout.rootDefaults</a> properties,
|
|
the root node's children get the <a href="TreeLayout.html#alternateDefaults">TreeLayout.alternateDefaults</a> properties,
|
|
and all the rest of the <a href="TreeVertex.html">TreeVertex</a>es get their properties from their parent node.</p>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="globals ">
|
|
<a href="../index.html"><em>GoJS <wbr>Class <wbr>Index</em></a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class">
|
|
<a href="TreeLayout.html" class="tsd-kind-icon">Tree<wbr>Layout</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alignment" class="tsd-kind-icon">alignment</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateAlignment" class="tsd-kind-icon">alternate<wbr>Alignment</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateAngle" class="tsd-kind-icon">alternate<wbr>Angle</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateBreadthLimit" class="tsd-kind-icon">alternate<wbr>Breadth<wbr>Limit</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateChildPortSpot" class="tsd-kind-icon">alternate<wbr>Child<wbr>Port<wbr>Spot</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateCommentMargin" class="tsd-kind-icon">alternate<wbr>Comment<wbr>Margin</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateCommentSpacing" class="tsd-kind-icon">alternate<wbr>Comment<wbr>Spacing</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateCompaction" class="tsd-kind-icon">alternate<wbr>Compaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateComparer" class="tsd-kind-icon">alternate<wbr>Comparer</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateDefaults" class="tsd-kind-icon">alternate<wbr>Defaults</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateLayerSpacing" class="tsd-kind-icon">alternate<wbr>Layer<wbr>Spacing</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateLayerSpacingParentOverlap" class="tsd-kind-icon">alternate<wbr>Layer<wbr>Spacing<wbr>Parent<wbr>Overlap</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateNodeIndent" class="tsd-kind-icon">alternate<wbr>Node<wbr>Indent</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateNodeIndentPastParent" class="tsd-kind-icon">alternate<wbr>Node<wbr>Indent<wbr>Past<wbr>Parent</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateNodeSpacing" class="tsd-kind-icon">alternate<wbr>Node<wbr>Spacing</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternatePortSpot" class="tsd-kind-icon">alternate<wbr>Port<wbr>Spot</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateRowIndent" class="tsd-kind-icon">alternate<wbr>Row<wbr>Indent</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateRowSpacing" class="tsd-kind-icon">alternate<wbr>Row<wbr>Spacing</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateSetsChildPortSpot" class="tsd-kind-icon">alternate<wbr>Sets<wbr>Child<wbr>Port<wbr>Spot</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateSetsPortSpot" class="tsd-kind-icon">alternate<wbr>Sets<wbr>Port<wbr>Spot</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#alternateSorting" class="tsd-kind-icon">alternate<wbr>Sorting</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#angle" class="tsd-kind-icon">angle</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#arrangement" class="tsd-kind-icon">arrangement</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#arrangementSpacing" class="tsd-kind-icon">arrangement<wbr>Spacing</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#breadthLimit" class="tsd-kind-icon">breadth<wbr>Limit</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#childPortSpot" class="tsd-kind-icon">child<wbr>Port<wbr>Spot</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#commentMargin" class="tsd-kind-icon">comment<wbr>Margin</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#commentSpacing" class="tsd-kind-icon">comment<wbr>Spacing</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#comments" class="tsd-kind-icon">comments</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#compaction" class="tsd-kind-icon">compaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#comparer" class="tsd-kind-icon">comparer</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#layerSpacing" class="tsd-kind-icon">layer<wbr>Spacing</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#layerSpacingParentOverlap" class="tsd-kind-icon">layer<wbr>Spacing<wbr>Parent<wbr>Overlap</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#layerStyle" class="tsd-kind-icon">layer<wbr>Style</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#nodeIndent" class="tsd-kind-icon">node<wbr>Indent</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#nodeIndentPastParent" class="tsd-kind-icon">node<wbr>Indent<wbr>Past<wbr>Parent</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#nodeSpacing" class="tsd-kind-icon">node<wbr>Spacing</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#path" class="tsd-kind-icon">path</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#portSpot" class="tsd-kind-icon">port<wbr>Spot</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#rootDefaults" class="tsd-kind-icon">root<wbr>Defaults</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#roots" class="tsd-kind-icon">roots</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#rowIndent" class="tsd-kind-icon">row<wbr>Indent</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#rowSpacing" class="tsd-kind-icon">row<wbr>Spacing</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#setsChildPortSpot" class="tsd-kind-icon">sets<wbr>Child<wbr>Port<wbr>Spot</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#setsPortSpot" class="tsd-kind-icon">sets<wbr>Port<wbr>Spot</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#sorting" class="tsd-kind-icon">sorting</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#treeStyle" class="tsd-kind-icon">tree<wbr>Style</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#addComments" class="tsd-kind-icon">add<wbr>Comments</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#arrangeTrees" class="tsd-kind-icon">arrange<wbr>Trees</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#assignTreeVertexValues" class="tsd-kind-icon">assign<wbr>Tree<wbr>Vertex<wbr>Values</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<a href="TreeLayout.html#commitLayers" class="tsd-kind-icon">commit<wbr>Layers</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<a href="TreeLayout.html#commitLayout" class="tsd-kind-icon">commit<wbr>Layout</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<a href="TreeLayout.html#commitLinks" class="tsd-kind-icon">commit<wbr>Links</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<a href="TreeLayout.html#commitNodes" class="tsd-kind-icon">commit<wbr>Nodes</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#createNetwork" class="tsd-kind-icon">create<wbr>Network</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#doLayout" class="tsd-kind-icon">do<wbr>Layout</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#initializeTreeVertexValues" class="tsd-kind-icon">initialize<wbr>Tree<wbr>Vertex<wbr>Values</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#layoutComments" class="tsd-kind-icon">layout<wbr>Comments</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="TreeLayout.html#makeNetwork" class="tsd-kind-icon">make<wbr>Network</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-AlignmentBottomRightBus" class="tsd-kind-icon">Alignment<wbr>Bottom<wbr>Right<wbr>Bus</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-AlignmentBus" class="tsd-kind-icon">Alignment<wbr>Bus</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-AlignmentBusBranching" class="tsd-kind-icon">Alignment<wbr>Bus<wbr>Branching</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-AlignmentCenterChildren" class="tsd-kind-icon">Alignment<wbr>Center<wbr>Children</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-AlignmentCenterSubtrees" class="tsd-kind-icon">Alignment<wbr>Center<wbr>Subtrees</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-AlignmentEnd" class="tsd-kind-icon">Alignment<wbr>End</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-AlignmentStart" class="tsd-kind-icon">Alignment<wbr>Start</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-AlignmentTopLeftBus" class="tsd-kind-icon">Alignment<wbr>Top<wbr>Left<wbr>Bus</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-ArrangementFixedRoots" class="tsd-kind-icon">Arrangement<wbr>Fixed<wbr>Roots</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-ArrangementHorizontal" class="tsd-kind-icon">Arrangement<wbr>Horizontal</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-ArrangementVertical" class="tsd-kind-icon">Arrangement<wbr>Vertical</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-CompactionBlock" class="tsd-kind-icon">Compaction<wbr>Block</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-CompactionNone" class="tsd-kind-icon">Compaction<wbr>None</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-LayerIndividual" class="tsd-kind-icon">Layer<wbr>Individual</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-LayerSiblings" class="tsd-kind-icon">Layer<wbr>Siblings</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-LayerUniform" class="tsd-kind-icon">Layer<wbr>Uniform</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-PathDefault" class="tsd-kind-icon">Path<wbr>Default</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-PathDestination" class="tsd-kind-icon">Path<wbr>Destination</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-PathSource" class="tsd-kind-icon">Path<wbr>Source</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-SortingAscending" class="tsd-kind-icon">Sorting<wbr>Ascending</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-SortingDescending" class="tsd-kind-icon">Sorting<wbr>Descending</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-SortingForwards" class="tsd-kind-icon">Sorting<wbr>Forwards</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-SortingReverse" class="tsd-kind-icon">Sorting<wbr>Reverse</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-StyleAlternating" class="tsd-kind-icon">Style<wbr>Alternating</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-StyleLastParents" class="tsd-kind-icon">Style<wbr>Last<wbr>Parents</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-StyleLayered" class="tsd-kind-icon">Style<wbr>Layered</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="TreeLayout.html#static-StyleRootOnly" class="tsd-kind-icon">Style<wbr>Root<wbr>Only</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="container-fluid bottom-copyright plr15">
|
|
Copyright © 1998-2019 by Northwoods Software Corporation.
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
<script src="../../assets/js/api.js"></script>
|
|
<script src="../../assets/js/bootstrap.min.js"></script>
|
|
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
|
|
|
ga('create', 'UA-1506307-5', 'auto');
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</body>
|
|
</html> |