create-gojs-kit
Version:
A CLI for downloading GoJS samples, extensions, and docs
917 lines (848 loc) • 37.4 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, viewport-fit=cover"/>
<link rel="preconnect" href="https://rsms.me/">
<link rel="stylesheet" href="../assets/css/style.css">
<!-- Copyright 1998-2025 by Northwoods Software Corporation. -->
<meta itemprop="name" content="Layouts" />
<meta property="og:title" content="Layouts" />
<meta name="twitter:title" content="Layouts" />
<meta property="og:image" content="https://gojs.net/latest/assets/images/fp/defaultCard.png" />
<meta itemprop="image" content="https://gojs.net/latest/assets/images/fp/defaultCard.png" />
<meta name="twitter:image" content="https://gojs.net/latest/assets/images/fp/defaultCard.png" />
<meta property="og:url" content="https://gojs.net/latest/intro/layouts.html" />
<meta property="twitter:url" content="https://gojs.net/latest/intro/layouts.html" />
<meta name="twitter:card" content="summary_large_image" />
<meta property="og:type" content="website" />
<meta property="twitter:domain" content="gojs.net" />
<title>
Layouts | GoJS
</title>
<link rel="stylesheet" href="../assets/css/prism.css"/>
</head>
<script>
window.diagrams = [];
window.goCode = function (pre, w, h, parentid, animation) {
window
.diagrams
.push([pre, w, h, parentid, animation]);
}
</script>
<body>
<nav id="navTop" class=" w-full h-[var(--topnav-h)] z-30 bg-white border-b border-b-gray-200">
<div class="max-w-screen-xl mx-auto flex flex-wrap items-start justify-between px-4">
<a class="text-white bg-nwoods-primary font-bold !leading-[calc(var(--topnav-h)_-_1px)] my-0 px-2 text-4xl lg:text-5xl logo"
href="../">
GoJS
</a>
<div class="relative">
<button id="topnavButton" class="h-[calc(var(--topnav-h)_-_1px)] px-2 m-0 text-gray-900 bg-inherit shadow-none md:hidden hover:!bg-inherit hover:!text-nwoods-accent hover:!shadow-none" aria-label="Navigation">
<svg class="h-7 w-7 block" aria-hidden="true" fill="none" stroke="currentColor" stroke-width="2" viewBox="0 0 24 24">
<path d="M3.75 6.75h16.5M3.75 12h16.5m-16.5 5.25h16.5" stroke-linecap="round" stroke-linejoin="round"/>
</svg>
</button>
<div id="topnavList" class="hidden md:block">
<div class="absolute right-0 z-30 flex flex-col items-end rounded border border-gray-200 p-4 pl-12 shadow bg-white text-gray-900 font-semibold
md:flex-row md:space-x-4 md:items-start md:border-0 md:p-0 md:shadow-none md:bg-inherit">
<a href="../learn/">Learn</a>
<a href="../samples/">Samples</a>
<a href="../intro/">Intro</a>
<a href="../api/">API</a>
<a href="../download.html">Download</a>
<a href="https://forum.nwoods.com/c/gojs/11" target="_blank" rel="noopener">Forum</a>
<a id="tc" href="https://nwoods.com/contact.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://nwoods.com/contact.html', 'contact');">Contact</a>
<a id="tb" href="https://nwoods.com/sales/index.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://nwoods.com/sales/index.html', 'buy');">Buy</a>
</div>
</div>
</div>
</div>
</nav>
<script>
window.addEventListener("DOMContentLoaded", function () {
// topnav
var topButton = document.getElementById("topnavButton");
var topnavList = document.getElementById("topnavList");
if (topButton && topnavList) {
topButton.addEventListener("click", function (e) {
topnavList
.classList
.toggle("hidden");
e.stopPropagation();
});
document.addEventListener("click", function (e) {
// if the clicked element isn't the list, close the list
if (!topnavList.classList.contains("hidden") && !e.target.closest("#topnavList")) {
topButton.click();
}
});
// set active <a> element
var url = window
.location
.href
.toLowerCase();
var aTags = topnavList.getElementsByTagName('a');
for (var i = 0; i < aTags.length; i++) {
var lowerhref = aTags[i]
.href
.toLowerCase();
if (lowerhref.endsWith('.html'))
lowerhref = lowerhref.slice(0, -5);
if (url.startsWith(lowerhref)) {
aTags[i]
.classList
.add('active');
break;
}
}
}
});
</script>
<div class="sticky top-0 left-0 z-10 px-2 w-full bg-white border-b border-b-gray-200 md:hidden">
<button id="sidenavButton" class="flex p-2 text-gray-900 bg-inherit shadow-none items-center text-sm font-semibold hover:!bg-inherit hover:!text-nwoods-accent hover:!shadow-none" aria-label="Navigation">
<svg class="h-7 w-7 block mr-2" aria-hidden="true" fill="none" stroke="currentColor" stroke-width="2" viewBox="0 0 24 24">
<path d="M3.75 6.75h16.5M3.75 12h16.5m-16.5 5.25h16.5" stroke-linecap="round" stroke-linejoin="round"/>
</svg>
<span>Menu</span>
</button>
</div>
<script>
window.addEventListener("DOMContentLoaded", function () {
// sidenav
var sideButton = document.getElementById("sidenavButton");
var sidenav = document.getElementById("sidenav");
if (sideButton && sidenav) {
sideButton.addEventListener("click", function (e) {
sidenav
.classList
.toggle("hidden");
e.stopPropagation();
});
document.addEventListener("click", function (e) {
// if the clicked element isn't the list, close the list
if (!sidenav.classList.contains("hidden") && !e.target.closest("#sidenavList")) {
sideButton.click();
}
});
}
});
</script>
<div class="flex flex-row md:min-h-screen w-full max-w-screen-xl mx-auto">
<aside id="sidenav"
class="hidden fixed top-0 left-0 z-10 w-full bg-black/10 min-h-screen max-h-screen overflow-x-hidden overflow-y-auto shrink-0
md:block md:sticky md:w-52 md:min-h-0 md:bg-inherit md:border-r md:border-r-gray-200 md:overscroll-auto">
<nav id="sidenavList" class="flex flex-col bg-white w-52 min-h-screen pl-2 pt-4 pb-24 md:w-full md:min-h-0">
<a href="index.html">Basics</a>
<a href="buildingObjects.html">Building Parts</a>
<a href="usingModels.html">Using Models</a>
<a href="dataBinding.html">Data Binding</a>
<a href="react.html">GoJS with React</a>
<a href="svelte.html">GoJS with Svelte</a>
<a href="angular.html">GoJS with Angular</a>
<a href="textBlocks.html">TextBlocks</a>
<a href="shapes.html">Shapes</a>
<a href="pictures.html">Pictures</a>
<a href="panels.html">Panels</a>
<a href="tablePanels.html">Table Panels</a>
<a href="brush.html">Brushes</a>
<a href="sizing.html">Sizing Objects</a>
<a href="itemArrays.html">Item Arrays</a>
<a href="changedEvents.html">Changed Events</a>
<a href="transactions.html">Transactions</a>
<a href="viewport.html">Coordinates</a>
<a href="initialView.html">Initial View</a>
<a href="collections.html">Collections</a>
<a href="links.html">Links</a>
<a href="linkLabels.html">Link Labels</a>
<a href="connectionPoints.html">Link Points</a>
<a href="ports.html">Ports</a>
<a href="nodes.html">Nodes</a>
<a href="typings.html">Typings</a>
<a href="debugging.html">Debugging</a>
<a href="layouts.html">Layouts</a>
<a href="routers.html">Routers</a>
<a href="trees.html">Trees</a>
<a href="subtrees.html">SubTrees</a>
<a href="groups.html">Groups</a>
<a href="subgraphs.html">SubGraphs</a>
<a href="sizedGroups.html">Sized Groups</a>
<a href="selection.html">Selection</a>
<a href="highlighting.html">Highlighting</a>
<a href="theming.html">Theming</a>
<a href="tooltips.html">ToolTips</a>
<a href="contextMenus.html">Context Menus</a>
<a href="events.html">Diagram Events</a>
<a href="tools.html">Tools</a>
<a href="commands.html">Commands</a>
<a href="accessibility.html">Accessibility</a>
<a href="buttons.html">Buttons</a>
<a href="permissions.html">Permissions</a>
<a href="validation.html">Validation</a>
<a href="animation.html">Animation</a>
<a href="HTMLInteraction.html">HTML Interaction</a>
<a href="layers.html">Layers & Z-ordering</a>
<a href="palette.html">Palette</a>
<a href="overview.html">Overview</a>
<a href="replacingDeleting.html">Replacing and Deleting</a>
<a href="templateMaps.html">Template Maps</a>
<a href="legends.html">Legends and Titles</a>
<a href="extensions.html">Extensions</a>
<a href="geometry.html">Geometry Strings</a>
<a href="grids.html">Grid Patterns</a>
<a href="graduatedPanels.html">Graduated Panels</a>
<a href="SVGContext.html">Rendering to SVG</a>
<a href="makingSVG.html">Snapshot to SVG</a>
<a href="makingImages.html">Diagram Images</a>
<a href="printing.html">Printing</a>
<a href="serverSideImages.html">Server-side Images</a>
<a href="nodeScript.html">GoJS in Node.js</a>
<a href="testing.html">Testing</a>
<a href="performance.html">Performance</a>
<a href="platforms.html">Platforms</a>
<a href="deployment.html">Deployment</a>
</nav>
</aside>
<script>
var navList = document.getElementById('sidenavList');
if (navList !== null) {
var url = window.location.href;
var lindex = url.lastIndexOf('/');
url = url
.slice(lindex + 1)
.toLowerCase();
var aTags = navList.getElementsByTagName('a');
var currentindex = -1;
for (var i = 0; i < aTags.length; i++) {
var lowerhref = aTags[i]
.href
.toLowerCase();
if (lowerhref.indexOf('/' + url) !== -1) {
currentindex = i;
aTags[i]
.classList
.add('active');
break;
}
}
}
</script>
<div class="px-4 pb-16 w-full overflow-hidden prose">
<h1>Diagram Layouts</h1>
<p>
In general terms, a "layout" is a way of sizing and positioning a collection of objects. HTML has its own layouts for its HTML elements.
In <b>GoJS</b> you have already seen many examples of Panel layout, such as Auto or Table, which sizes and positions <a>GraphObject</a>s within a <a>Panel</a>.
<b>GoJS</b> also provides Diagram layouts, which position <a>Node</a>s and route <a>Link</a>s within a <a>Diagram</a> or a <a>Group</a>.
</p>
<p>
Naturally the principal purpose of each diagram <a>Layout</a> is to position nodes, typically by calling <a>Part.move</a>.
But layouts also may also result in custom routing of the links, by setting properties on each <a>Link</a>.
For example <a>TreeLayout</a> also ensures that links are routed in the expected direction by setting
<a>Link.fromSpot</a> and <a>Link.toSpot</a> depending on the <a>TreeLayout.angle</a>.
(However, that behavior can be disabled by setting <a>TreeLayout.setsPortSpot</a> and <a>TreeLayout.setsChildPortSpot</a>.
The same is true for some other layouts.)
</p>
<p>
Diagram layouts can be accomplished in several manners.
Manual layouts occur because the user moves nodes, thereby establishing new positions for those nodes.
Such layouts might be saved in some persistent data format and later loaded using data binding or assignments in code.
Programmatic layouts happen when some code executes to set the <a>Part</a> position or location.
Automatic layouts are programmatic layouts that are implemented by the <a>Layout</a> class or its subclasses.
</p>
<h2 id="DefaultLayout">Default Layout</h2>
<p>
The value of <a>Diagram.layout</a> defaults to an instance of <a>Layout</a>.
This kind of layout is unlike all of the other layout subclasses, in that it only sets the position of nodes that do not already
have a position -- i.e. where the X or Y of the <a>GraphObject.actualBounds</a> is NaN.
It leaves unmodified all nodes that do have a defined position, and it ignores all links.
</p>
<p>
The default layout is used in apps where the user is expected to position each Node, perhaps with the aid of grid-snapping or with a tool.
Many of the examples you have seen so far do not set <a>Diagram.layout</a> and thus use the default layout.
Some of the examples data bind the <a>Part.location</a> or <a>GraphObject.position</a> to a data property.
Those examples are basically using manual layout, but with the node positions coming from the node data rather than from arrangement by the user.
</p>
<p>
Often such apps are diagram editors, where the user places and adjusts the locations of nodes, and those locations are saved in the server.
Such bindings are usually TwoWay, in order to automatically save the node locations to the model data.
</p>
<p>
However many of the examples just allow the standard behavior of a <a>Layout</a> class or subclass to assign positions to the nodes
in the order in which they are seen by the layout and considering any link relationships between the nodes.
Those examples are exhibiting automatic layout behavior.
</p>
<h2 id="AutomaticLayouts">Automatic Layouts</h2>
<p><b>GoJS</b> offers several kinds of built-in automatic layouts, including:</p>
<ul>
<li><a>GridLayout</a></li>
<li><a>TreeLayout</a></li>
<li><a>ForceDirectedLayout</a></li>
<li><a>LayeredDigraphLayout</a></li>
<li><a>CircularLayout</a></li>
</ul>
<p>
There are samples for each of these layouts, demonstrating the effects of setting various detailed layout properties.
Many of the properties are very specific to the particular kind of layout that they are trying to affect.
</p>
<ul>
<li><a href="../samples/gLayout.html" target="samples">GridLayout Sample</a></li>
<li><a href="../samples/tLayout.html" target="samples">TreeLayout Sample</a></li>
<li><a href="../samples/fdLayout.html" target="samples">ForceDirectedLayout Sample</a></li>
<li><a href="../samples/ldLayout.html" target="samples">LayeredDigraphLayout Sample</a></li>
<li><a href="../samples/cLayout.html" target="samples">CircularLayout Sample</a></li>
</ul>
<p>
In the introduction pages and samples you will see many examples that make use of automatic layout by setting the <a>Diagram.layout</a> property.
</p>
<h3 id="LayoutUsage">Layout Usage</h3>
<p>
You can set <a>Diagram.layout</a> in a JavaScript statement:
</p>
<pre class="lang-js"><code>diagram.layout = new go.ForceDirectedLayout();</code></pre>
or:
<pre class="lang-js"><code>
const diagram =
new go.Diagram("myDiagramDiv",
{
layout: new go.TreeLayout({ angle: 90, nodeSpacing: 10, layerSpacing: 30 })
});
</code></pre>
<h3 id="GridLayout">Grid Layout</h3>
<p>A simple layout for placing Nodes in a grid-like arrangement.</p>
<pre class="lang-js" id="gridlayout" style="display: none"><code>
diagram.layout = new go.GridLayout();
diagram.contentAlignment = go.Spot.Center;
// define a simple Node template
diagram.nodeTemplate =
new go.Node("Spot") // the Shape will go around the TextBlock
.add(
new go.Shape("Ellipse", {
fill: 'palegreen', stroke: '#333', strokeWidth: 3, width: 40, height: 40
}),
new go.TextBlock({
font: 'bold 12pt sans-serif', stroke: '#333' // some room around the text
})
// TextBlock.text is bound to Node.data.key
.bind("text", "key")
);
diagram.linkTemplate =
new go.Link()
// Default routing is go.Routing.Normal
// Default corner is 0
.add(
new go.Shape({ strokeWidth: 3, stroke: "#333" })
);
// create the model data that will be represented by Nodes and Links
diagram.model = new go.GraphLinksModel(
[
{ key: "1" },
{ key: "2" },
{ key: "3" },
{ key: "4" },
{ key: "5" },
{ key: "6" },
{ key: "7" },
{ key: "8" },
{ key: "9" },
{ key: "10" },
{ key: "11" },
],
[
]);
</code></pre>
<script>
goCode('gridlayout', 400, 120);
</script>
<p>
See the <a href="../samples/gLayout.html" target="samples">GridLayout Sample</a> for a demonstration of layout options. The
<a href="../samples/swimlanes.html" target="samples">Swim Lanes</a> sample demonstrates a customization of <a>GridLayout</a>. See more samples that make use
of <a>GridLayout</a> in the <a href="../samples/index.html#gridlayout">samples index</a>.
</p>
<h3 id="TreeLayout">Tree Layout</h3>
<p>
This layout positions nodes of a tree-structured graph in layers, either rows or columns depending on the <a>TreeLayout.angle</a>.
</p>
<pre class="lang-js" id="treelayout" style="display: none"><code>
diagram.layout = new go.TreeLayout();
diagram.contentAlignment = go.Spot.Center;
// define a simple Node template
diagram.nodeTemplate =
new go.Node("Spot") // the Shape will go around the TextBlock
.add(
new go.Shape("Ellipse", {
fill: 'palegreen', stroke: '#333', strokeWidth: 3, width: 40, height: 40
}),
new go.TextBlock({
font: 'bold 12pt sans-serif', stroke: '#333' // some room around the text
})
// TextBlock.text is bound to Node.data.key
.bind("text", "key")
);
diagram.linkTemplate =
new go.Link()
// Default routing is go.Routing.Normal
// Default corner is 0
.add(
new go.Shape({ strokeWidth: 3, stroke: "#333" })
);
// create the model data that will be represented by Nodes and Links
diagram.model = new go.GraphLinksModel(
[
{ key: "1" },
{ key: "2" },
{ key: "3" },
{ key: "4" },
{ key: "5" },
{ key: "6" }
],
[
{ from: "1", to: "2" },
{ from: "1", to: "3" },
{ from: "3", to: "4" },
{ from: "3", to: "5" },
{ from: "3", to: "6" }
]);
</code></pre>
<script>
goCode('treelayout', 400, 200);
</script>
<p>
See the <a href="../samples/tLayout.html" target="samples">TreeLayout sample</a> for a demonstration of layout options. The
<a href="../samples/orgChartEditor.html" target="samples">Org Chart Editor</a>, <a href="../samples/parseTree.html" target="samples">Parse Tree</a>,
<a href="../samples/swimBands.html" target="samples">Layer Bands</a>, and
<a href="../samples/virtualizedTreeLayout.html" target="samples">Virtualized Tree</a>
samples demonstrate customization of <a>TreeLayout</a>. See more samples that make use of <a>TreeLayout</a> in the
<a href="../samples/index.html#treelayout">samples index</a>.
</p>
<h3 id="ForceDirectedLayout">Force-Directed Layout</h3>
<p>
Force-directed layout treats the graph as if it were a system of physical bodies with forces acting on them and between them.
</p>
<pre class="lang-js" id="fdlayout" style="display: none"><code>
diagram.layout = new go.ForceDirectedLayout({ defaultElectricalCharge: 50, defaultSpringLength: 10 });
diagram.initialAutoScale = go.AutoScale.Uniform;
diagram.contentAlignment = go.Spot.Center;
// define a simple Node template
diagram.nodeTemplate =
new go.Node("Spot") // the Shape will go around the TextBlock
.add(
new go.Shape("Ellipse", {
fill: 'palegreen', stroke: '#333', strokeWidth: 3, width: 40, height: 40
}),
new go.TextBlock({
font: 'bold 12pt sans-serif', stroke: '#333' // some room around the text
})
// TextBlock.text is bound to Node.data.key
.bind("text", "key")
);
diagram.linkTemplate =
new go.Link()
.add(
new go.Shape({ strokeWidth: 3, stroke: "#333" })
);
// create the model data that will be represented by Nodes and Links
diagram.model = new go.GraphLinksModel(
[
{ key: "1" },
{ key: "2" },
{ key: "3" },
{ key: "4" },
{ key: "5" },
{ key: "6" },
{ key: "7" },
{ key: "8" },
{ key: "9" },
{ key: "10" },
{ key: "11" },
],
[
{ from: "6", to: "2" },
{ from: "3", to: "4" },
{ from: "3", to: "5" },
{ from: "3", to: "6" },
{ from: "6", to: "1" },
{ from: "6", to: "7" },
{ from: "4", to: "8" },
{ from: "4", to: "9" },
{ from: "4", to: "10" },
{ from: "4", to: "11" },
]);
</code></pre>
<script>
goCode('fdlayout', 400, 300);
</script>
<p>
See the <a href="../samples/fdLayout.html" target="samples">ForceDirectedLayout sample</a> for a demonstration of layout options. That sample also
demonstrates a simple customization of <a>ForceDirectedLayout</a>. The
<a href="../samples/virtualizedForceLayout.html" target="samples">Virtualized Force Directed</a> sample demonstrates a more complicated customization of
<a>ForceDirectedLayout</a>. See more samples that make use of <a>ForceDirectedLayout</a> in the
<a href="../samples/index.html#forcedirectedlayout">samples index</a>.
</p>
<h3 id="LayeredDigraphLayout">Layered Digraph Layout</h3>
<p>
This arranges nodes of directed graphs into layers, rows or columns depending on the <a>LayeredDigraphLayout.direction</a>.
Unlike <a>TreeLayout</a>, this works not only with tree-structured graphs, but with any graph, although it's best with directed acyclic graphs.
</p>
<pre class="lang-js" id="ldllayout" style="display: none"><code>
diagram.layout = new go.LayeredDigraphLayout();
diagram.contentAlignment = go.Spot.Center;
// define a simple Node template
diagram.nodeTemplate =
new go.Node("Spot") // the Shape will go around the TextBlock
.add(
new go.Shape("Ellipse", {
fill: 'palegreen', stroke: '#333', strokeWidth: 3, width: 40, height: 40
}),
new go.TextBlock({
font: 'bold 12pt sans-serif', stroke: '#333' // some room around the text
})
// TextBlock.text is bound to Node.data.key
.bind("text", "key")
);
diagram.linkTemplate =
new go.Link()
.add(
new go.Shape({ strokeWidth: 3, stroke: "#333" })
);
// create the model data that will be represented by Nodes and Links
diagram.model = new go.GraphLinksModel(
[
{ key: "1" },
{ key: "2" },
{ key: "3" },
{ key: "4" },
{ key: "5" },
{ key: "6" },
{ key: "7" },
],
[
{ from: "1", to: "2" },
{ from: "1", to: "3" },
{ from: "3", to: "4" },
{ from: "3", to: "5" },
{ from: "3", to: "6" },
{ from: "2", to: "5" },
{ from: "1", to: "5" },
{ from: "1", to: "7" },
{ from: "6", to: "7" },
]);
</code></pre>
<script>
goCode('ldllayout', 400, 300);
</script>
<p>
See the <a href="../samples/ldLayout.html" target="samples">LayeredDigraphLayout sample</a> for a demonstration of layout options. The
<a href="../samples/genogram.html" target="samples">Genogram</a> sample demonstrates a complex customization of <a>LayeredDigraphLayout</a>. See more samples
that make use of <a>LayeredDigraphLayout</a> in the <a href="../samples/index.html#layereddigraphlayout">samples index</a>.
</p>
<h3 id="CircularLayout">Circular Layout</h3>
<p>
This layout positions nodes in a circular or elliptical arrangement.
</p>
<pre class="lang-js" id="circularLayout" style="display: none"><code>
diagram.layout = new go.CircularLayout();
diagram.contentAlignment = go.Spot.Center;
// define a simple Node template
diagram.nodeTemplate =
new go.Node("Spot") // the Shape will go around the TextBlock
.add(
new go.Shape("Ellipse", {
fill: 'palegreen', stroke: '#333', strokeWidth: 3, width: 40, height: 40
}),
new go.TextBlock({
font: 'bold 12pt sans-serif', stroke: '#333' // some room around the text
})
// TextBlock.text is bound to Node.data.key
.bind("text", "key")
);
diagram.linkTemplate =
new go.Link()
.add(
new go.Shape({ strokeWidth: 3, stroke: "#333" })
);
// create the model data that will be represented by Nodes and Links
diagram.model = new go.GraphLinksModel(
[
{ key: "1" },
{ key: "2" },
{ key: "3" },
{ key: "4" },
{ key: "5" },
{ key: "6" },
{ key: "7" },
],
[
{ from: "1", to: "2" },
{ from: "1", to: "3" },
{ from: "3", to: "4" },
{ from: "3", to: "5" },
{ from: "3", to: "6" },
{ from: "2", to: "5" },
{ from: "1", to: "5" },
{ from: "1", to: "7" },
{ from: "6", to: "7" },
]);
</code></pre>
<script>
goCode('circularLayout', 400, 250);
</script>
<p>
See the <a href="../samples/cLayout.html" target="samples">CircularLayout sample</a> for a demonstration of layout options. The
<a href="../samples/friendWheel.html" target="samples">Friend Wheel</a> sample demonstrates a simple customization of <a>CircularLayout</a>. See more samples
that make use of <a>CircularLayout</a> in the <a href="../samples/index.html#circularlayout">samples index</a>.
</p>
<h3 id="CustomLayouts">Custom Layouts</h3>
<p>
GoJS encourages creation of custom layouts.
The intro page on <a href="extensions.html">GoJS extensions</a> gives a simple example of a custom layout.
See more samples that make use of custom layouts in the <a href="../samples/index.html#customlayout">samples index</a>.
</p>
<p>
There are also many layouts that are extensions -- not predefined in the <code>go.js</code> or <code>go-debug.js</code> library,
but available as source code in one of the three extension directories, with some documentation, and with corresponding samples.
</p>
<ul>
<li>
<a>ArrangingLayout</a>: sample at <a href="../samples/Arranging.html" target="samples">ArrangingLayout Sample</a>, defined in
<a href="../extensions/ArrangingLayout.js">ArrangingLayout.js</a>
</li>
<li>
<a>DoubleTreeLayout</a>: sample at <a href="../samples/doubleTree.html" target="samples">DoubleTreeLayout Sample</a>, defined in
<a href="../extensions/DoubleTreeLayout.js">DoubleTreeLayout.js</a>
</li>
<li>
<a>FishboneLayout</a>: sample at <a href="../samples/Fishbone.html" target="samples">FishboneLayout Sample</a>, defined in
<a href="../extensions/FishboneLayout.js">FishboneLayout.js</a>
</li>
<li>
<a>PackedLayout</a>: sample at <a href="../samples/PackedLayout.html" target="samples">PackedLayout Sample</a>, defined in
<a href="../extensionsJSM/PackedLayout.js">PackedLayout.js</a>
</li>
<li>
<a>ParallelLayout</a>: sample at <a href="../samples/Parallel.html" target="samples">ParallelLayout Sample</a>, defined in
<a href="../extensions/ParallelLayout.js">ParallelLayout.js</a>
</li>
<li>
<a>SerpentineLayout</a>: sample at <a href="../samples/Serpentine.html" target="samples">SerpentineLayout Sample</a>, defined in
<a href="../extensions/SerpentineLayout.js">SerpentineLayout.js</a>
</li>
<li>
<a>SpiralLayout</a>: sample at <a href="../samples/Spiral.html" target="samples">SpiralLayout Sample</a>, defined in
<a href="../extensions/SpiralLayout.js">SpiralLayout.js</a>
</li>
<li>
<a>SwimLaneLayout</a>: sample at <a href="../samples/SwimLaneLayout.html" target="samples">SwimLaneLayout Sample</a>, defined in
<a href="../extensions/SwimLaneLayout.js">SwimLaneLayout.js</a>
</li>
<li>
<a>TableLayout</a>: sample at <a href="../samples/Table.html" target="samples">TableLayout Sample</a>, defined in
<a href="../extensions/TableLayout.js">TableLayout.js</a>
</li>
<li>
<a>TreeMapLayout</a>: sample at <a href="../samples/TreeMap.html" target="samples">TreeMapLayout Sample</a>, defined in
<a href="../extensions/TreeMapLayout.js">TreeMapLayout.js</a>
</li>
</ul>
<h2 id="LayoutInvalidation">Layout Invalidation</h2>
<p>
A layout is considered "valid" when it has performed its positioning of its nodes and perhaps routed its links.
However some kinds of changes cause a layout to become "invalid", thereby causing it to be performed again in the near future.
Because layouts can be computationally expensive, automatic layouts are not performed as soon as a layout is invalidated.
Instead they are typically performed at the end of a transaction.
</p>
<p>
The most common reasons for a layout to be invalidated are because a node or a link has been added or removed from the collection of
nodes and links that a layout is responsible for, or because a node or a link has changed visibility, or because a node has changed size.
If you do not want an automatic layout to happen when such a change occurs, it may be easiest to set <a>Layout.isOngoing</a> to false.
</p>
<p>
Another common situation is where you have set <a>Diagram.layout</a> to some kind of layout but you want to load a diagram (model)
that contains manually positioned or adjusted node locations.
The <a>Binding</a> of <a>Part.location</a> to the model data is effective,
but the locations are lost when a layout is performed immediately after loading.
This situation can be avoided by setting <a>Layout.isInitial</a> to false.
After the initial layout the layout might still be invalidated by adding or removing or changing the visibility of a node or a link
or by a change in node size, unless you have also set <a>Layout.isOngoing</a> to false.
When both <a>Layout.isInitial</a> and <a>Layout.isOngoing</a> are false, you can still explicitly cause a layout to happen
by either calling <a>Layout.invalidateLayout</a> or by calling <a>Diagram.layoutDiagram</a> with a <code>true</code> argument.
</p>
<p>
For example, in diagram editors it is commonplace to have TwoWay Bindings on <a>Node.location</a> to save manually adjusted node locations.
This means that saved models will have saved locations for all of the nodes.
But if you create a new model without all of the node data objects having real locations,
you will want a layout to be performed initially when the model is loaded.
You can accomplish this by setting <a>Layout.isInitial</a> to false (and optionally <a>Layout.isOngoing</a> to false,
if that is what you want when users add or remove nodes or links) and then implementing an "InitialLayoutCompleted"
<a>DiagramEvent</a> listener that decides whether a layout is needed.
The decision could be to look at a flag that you add to the <a>Model.modelData</a>.
Or you could look at all of the nodes to make sure their locations have real values:
</p>
<pre class="lang-js"><code>
new go.Diagram(. . .,
{
. . .,
layout: new go.TreeLayout({ isInitial: false, isOngoing: false }, . . .),
"InitialLayoutCompleted": e => {
// if not all Nodes have real locations, force a layout to happen
if (!e.diagram.nodes.all(n => n.location.isReal())) {
e.diagram.layoutDiagram(true);
}
}
})
</code></pre>
<p>
But if you do not want a change to a particular Node or Link to cause an automatic layout,
yet you do want that invalidation for other Nodes or Links, you can set the <a>Part.layoutConditions</a> property to
the combination of <a>Part</a> "Layout..." flags that suits your needs.
It is most common to not want a layout for the <a>LayoutConditions.NodeSized</a> condition:
</p>
<pre class="lang-js"><code>
new go.Node(. . ., {
layoutConditions: go.LayoutConditions.Standard & ~go.LayoutConditions.NodeSized,
. . .
})
. . .
</code></pre>
<p>
Parts that remain not visible or that are in layers that are <a>Layer.isTemporary</a> also never invalidate any Layout.
</p>
<p>
Finally, you can set <a>Part.isLayoutPositioned</a> to false in order for the Layout to completely ignore that Part.
But you will have to make sure that that Part does have a real <a>Part.location</a>, since no layout will set it for you.
Without a real location the part will not be visible anywhere in the diagram.
Furthermore if a node has <b>isLayoutPositioned</b> set to false, Layouts will not only ignore that node
but also all links connecting with that node.
Because the node will not be moved by the layout, it might overlap with the laid-out nodes and links.
You can also set or bind <a>Part.isLayoutPositioned</a> to false on Links in order to have the layout ignore those links.
This is demonstrated in <a href="../samples/orgChartExtras.html" target="samples">Org Chart Extras</a>.
</p>
</div>
</div>
<footer class="bg-white text-gray-900 border-t border-t-gray-200">
<div class="w-full max-w-screen-lg mx-auto px-4 py-6">
<p id="version" class="text-xs text-gray-900 m-0"></p>
<div class="text-sm px-0 mb-4 grid grid-cols-2 sm:grid-cols-3 gap-y-10">
<div>
<h2 class="text-base font-semibold text-nwoods-primary">GoJS</h2>
<ul class="list-none space-y-4 md:space-y-1 px-0">
<li>
<a href="../samples/index.html">Samples</a>
</li>
<li>
<a href="../learn/index.html">Learn</a>
</li>
<li>
<a href="../intro/index.html">Intro</a>
</li>
<li>
<a href="../api/index.html">API</a>
</li>
<li>
<a href="../changelog.html">Changelog</a>
</li>
<li>
<a href="https://github.com/NorthwoodsSoftware/GoJS" target="_blank" rel="noopener">GitHub</a>
</li>
</ul>
</div>
<div>
<h2 class="text-base font-semibold text-nwoods-primary">Support</h2>
<ul class="list-none space-y-4 md:space-y-1 px-0">
<li>
<a href="https://nwoods.com/contact.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://nwoods.com/contact.html', 'contact');">Contact</a>
</li>
<li>
<a href="https://forum.nwoods.com/c/gojs" target="_blank" rel="noopener">Forum</a>
</li>
<li>
<a href="https://nwoods.com/app/activate.aspx?sku=gojs" target="_blank" rel="noopener">Activate</a>
</li>
<li>
<a href="https://nwoods.com/sales/index.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://nwoods.com/sales/index.html', 'buy');">Buy</a>
</li>
<li>
<a href="https://nwoods.com/register.html" target="_blank" rel="noopener">Register</a>
</li>
</ul>
</div>
<div>
<h2 class="text-base font-semibold text-nwoods-primary">Company</h2>
<ul class="list-none space-y-4 md:space-y-1 px-0">
<li>
<a target="_blank" href="https://nwoods.com" target="_blank" rel="noopener">Northwoods</a>
</li>
<li>
<a target="_blank" href="https://nwoods.com/about.html" target="_blank" rel="noopener">About Us</a>
</li>
<li>
<a target="_blank" href="https://nwoods.com/contact.html" target="_blank" rel="noopener">Contact Us</a>
</li>
<li>
<a target="_blank" href="https://nwoods.com/consulting.html" target="_blank" rel="noopener">Consulting</a>
</li>
<li>
<a target="_blank" href="https://twitter.com/northwoodsgo" target="_blank" rel="noopener">Twitter</a>
</li>
</ul>
</div>
</div>
<p class="text-sm text-gray-900 md:mb-6">
Copyright 1998-2025 <a href="https://nwoods.com">Northwoods Software</a>
</p>
</div>
</footer>
</body>
<script async src="https://www.googletagmanager.com/gtag/js?id=G-S5QK8VSK84"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() {
dataLayer.push(arguments);
}
gtag('js', new Date());
gtag('config', 'G-S5QK8VSK84');
var getOutboundLink = function (url, label) {
gtag('event', 'click', {
'event_category': 'outbound',
'event_label': label,
'transport_type': 'beacon'
});
}
const params = new URL(document.location).searchParams
let a = params.get('a');
if (a) localStorage.setItem('a', a);
a = localStorage.getItem('a');
if (a) {
const links = [...document.body.getElementsByTagName("a")].filter((l) => l.href.includes('nwoods.com'));
for (const l of links) {
const url = new URL(l.href);
url.searchParams.set('a', a);
l.href = url;
}
}
</script>
<script src="../assets/js/prism.js"></script>
<script src="https://cdn.jsdelivr.net/npm/gojs@3.1.0"></script>
<script src="../assets/js/goDoc.js"></script>
<script>
document.addEventListener("DOMContentLoaded", function () {
if (window.go)
document
.getElementById('version')
.textContent = "GoJS version " + go.version;
if (window.goDoc)
window.goDoc();
var d = window.diagrams;
for (var i = 0; i < d.length; i++) {
var dargs = d[i];
goCodeExecute(dargs[0], dargs[1], dargs[2], dargs[3], dargs[4]);
}
if (window.extra)
window.extra();
}
);
</script>
</html>