forked from NorthwoodsSoftware/GoJS
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlayouts.html
More file actions
750 lines (684 loc) · 33.3 KB
/
Copy pathlayouts.html
File metadata and controls
750 lines (684 loc) · 33.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
<!DOCTYPE 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="stylesheet" href="../assets/css/style.css"/>
<!-- Copyright 1998-2022 by Northwoods Software Corporation. --> <title> GoJS Layouts -- Northwoods Software </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 z-30 top-0 text-white bg-nwoods-primary">
<div class="w-full container max-w-screen-lg mx-auto flex flex-wrap sm:flex-nowrap items-center justify-between mt-0 py-2">
<div class="md:pl-4">
<a class="text-white hover:text-white no-underline hover:no-underline
font-bold text-2xl lg:text-4xl rounded-lg hover:bg-nwoods-secondary " href="../">
<h1 class="mb-0 p-1 ">GoJS</h1>
</a>
</div>
<button id="topnavButton" class="rounded-lg sm:hidden focus:outline-none focus:ring" aria-label="Navigation">
<svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6">
<path id="topnavOpen" fill-rule="evenodd" d="M3 5a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM3 10a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM9 15a1 1 0 011-1h6a1 1 0 110 2h-6a1 1 0 01-1-1z" clip-rule="evenodd"></path>
<path id="topnavClosed" class="hidden" fill-rule="evenodd" d="M4.293 4.293a1 1 0 011.414 0L10 8.586l4.293-4.293a1 1 0 111.414 1.414L11.414 10l4.293 4.293a1 1 0 01-1.414 1.414L10 11.414l-4.293 4.293a1 1 0 01-1.414-1.414L8.586 10 4.293 5.707a1 1 0 010-1.414z" clip-rule="evenodd"></path>
</svg>
</button>
<div id="topnavList" class="hidden sm:block items-center w-auto mt-0 text-white p-0 z-20">
<ul class="list-reset list-none font-semibold flex justify-end flex-wrap sm:flex-nowrap items-center px-0 pb-0">
<li class="p-1 sm:p-0"><a class="topnav-link" href="../learn/">Learn</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../samples/">Samples</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../intro/">Intro</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../api/">API</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/products/register.html">Register</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../download.html">Download</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://forum.nwoods.com/c/gojs/11">Forum</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/contact.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/contact.html', 'contact');">Contact</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/sales/index.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');">Buy</a></li>
</ul>
</div>
</div>
<hr class="border-b border-gray-600 opacity-50 my-0 py-0" />
</nav>
<div class="md:flex flex-col md:flex-row md:min-h-screen w-full max-w-screen-xl mx-auto">
<div id="navSide" class="flex flex-col w-full md:w-40 lg:w-48 text-gray-700 bg-white flex-shrink-0">
<div class="flex-shrink-0 px-8 py-4">
<button id="navButton" class="rounded-lg md:hidden focus:outline-none focus:ring" aria-label="Navigation">
<svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6">
<path id="navOpen" fill-rule="evenodd" d="M3 5a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM3 10a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM9 15a1 1 0 011-1h6a1 1 0 110 2h-6a1 1 0 01-1-1z" clip-rule="evenodd"></path>
<path id="navClosed" class="hidden" fill-rule="evenodd" d="M4.293 4.293a1 1 0 011.414 0L10 8.586l4.293-4.293a1 1 0 111.414 1.414L11.414 10l4.293 4.293a1 1 0 01-1.414 1.414L10 11.414l-4.293 4.293a1 1 0 01-1.414-1.414L8.586 10 4.293 5.707a1 1 0 010-1.414z" clip-rule="evenodd"></path>
</svg>
</button>
</div>
<nav id="navList" class="min-h-screen hidden md:block sidebar-nav flex-grow px-1 lg:px-4 pb-4 md:pb-0 md:overflow-y-auto break-words">
<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="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="debugging.html">Debugging</a>
<a href="layouts.html">Layouts</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="animation.html">Animation</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="permissions.html">Permissions</a>
<a href="validation.html">Validation</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="resizing.html">Resizing Diagrams</a>
<a href="replacingDeleting.html">Replacing and Deleting</a>
<a href="buttons.html">Buttons</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="makingImages.html">Diagram Images</a>
<a href="makingSVG.html">Diagram SVG</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="storage.html">Storage</a>
<a href="performance.html">Performance</a>
<a href="source.html">Building from Source</a>
<a href="platforms.html">Platforms</a>
<a href="deployment.html">Deployment</a>
<a href="typings.html">Typings</a>
</nav>
</div>
<div class="pt-4 px-2 md:px-0 lg:px-4 pb-16 w-full overflow-hidden">
<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>
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>
However many of the examples just allow the standard behavior of the <a>Layout</a> class to assign positions to the nodes
in the order in which they are seen by the layout.
Those examples are exhibiting automatic layout behavior.
</p>
<h2 id="AutomaticLayouts">Automatic Layouts</h2>
<p>
<b>GoJS</b> offers several kinds of 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:
</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. <a href="https://github.com/NorthwoodsSoftware/GoJS/search?utf8=%E2%9C%93&q=%22layout%3A+%26%28go%22&type=Code">Search the sources of the samples for many more examples.</a>
</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>
<p>
Or you can initialize that property using <a>GraphObject,make</a>:
</p>
<pre class="lang-js"><code>
var diagram = $(go.Diagram, "myDiagramDiv",
{
layout: $(go.TreeLayout,
{ angle: 90, nodeSpacing: 10, layerSpacing: 30 })
});
</code></pre>
<p>
We recommend using <b>GraphObject.make</b> whenever you can because of the error checking that it does for property names.
</p>
<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 = $(go.GridLayout);
diagram.contentAlignment = go.Spot.Center;
// define a simple Node template
diagram.nodeTemplate =
$(go.Node, "Spot", // the Shape will go around the TextBlock
$(go.Shape, "Ellipse",
{ fill: 'palegreen', stroke: '#333', strokeWidth: 3, width: 40, height: 40 }
),
$(go.TextBlock,
{ margin: 3, font: 'bold 14px sans-serif', stroke: '#333' }, // some room around the text
// TextBlock.text is bound to Node.data.key
new go.Binding("text", "key"))
);
diagram.linkTemplate =
$(go.Link,
// Default routing is go.Link.Normal
// Default corner is 0
{ corner: 5 },
$(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>
<h id="TreeLayout">Tree Layout</h>
<p>This layout positions nodes of a tree-structured graph in layers (rows or columns).</p>
<pre class="lang-js" id="treelayout" style="display: none;"><code>
diagram.layout = $(go.TreeLayout);
diagram.contentAlignment = go.Spot.Center;
// define a simple Node template
diagram.nodeTemplate =
$(go.Node, "Spot", // the Shape will go around the TextBlock
$(go.Shape, "Ellipse",
{ fill: 'palegreen', stroke: '#333', strokeWidth: 3, width: 40, height: 40 }
),
$(go.TextBlock,
{ margin: 3, font: 'bold 14px sans-serif', stroke: '#333' }, // some room around the text
// TextBlock.text is bound to Node.data.key
new go.Binding("text", "key"))
);
diagram.linkTemplate =
$(go.Link,
// Default routing is go.Link.Normal
// Default corner is 0
{ corner: 5 },
$(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 = $(go.ForceDirectedLayout);
diagram.initialAutoScale = go.Diagram.Uniform;
diagram.contentAlignment = go.Spot.Center;
// define a simple Node template
diagram.nodeTemplate =
$(go.Node, "Spot", // the Shape will go around the TextBlock
$(go.Shape, "Ellipse",
{ fill: 'palegreen', stroke: '#333', strokeWidth: 3, width: 40, height: 40 }
),
$(go.TextBlock,
{ margin: 3, font: 'bold 14px sans-serif', stroke: '#333' }, // some room around the text
// TextBlock.text is bound to Node.data.key
new go.Binding("text", "key"))
);
diagram.linkTemplate =
$(go.Link,
// Default routing is go.Link.Normal
// Default corner is 0
{ corner: 5 },
$(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, 200)</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).</p>
<pre class="lang-js" id="ldllayout" style="display: none;"><code>
diagram.layout = $(go.LayeredDigraphLayout);
diagram.contentAlignment = go.Spot.Center;
// define a simple Node template
diagram.nodeTemplate =
$(go.Node, "Spot", // the Shape will go around the TextBlock
$(go.Shape, "Ellipse",
{ fill: 'palegreen', stroke: '#333', strokeWidth: 3, width: 40, height: 40 }
),
$(go.TextBlock,
{ margin: 3, font: 'bold 14px sans-serif', stroke: '#333' }, // some room around the text
// TextBlock.text is bound to Node.data.key
new go.Binding("text", "key"))
);
diagram.linkTemplate =
$(go.Link,
// Default routing is go.Link.Normal
// Default corner is 0
{ corner: 5 },
$(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 = $(go.CircularLayout);
diagram.contentAlignment = go.Spot.Center;
// define a simple Node template
diagram.nodeTemplate =
$(go.Node, "Spot", // the Shape will go around the TextBlock
$(go.Shape, "Ellipse",
{ fill: 'palegreen', stroke: '#333', strokeWidth: 3, width: 40, height: 40 }
),
$(go.TextBlock,
{ margin: 3, font: 'bold 14px sans-serif', stroke: '#333' }, // some room around the text
// TextBlock.text is bound to Node.data.key
new go.Binding("text", "key"))
);
diagram.linkTemplate =
$(go.Link,
// Default routing is go.Link.Normal
// Default corner is 0
{ corner: 5 },
$(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, 200)</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 allows for the 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>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="../extensions/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="../extensionsJSM/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="../extensions/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="../extensions/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="../extensions/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="../extensions/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="../extensions/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="../extensions/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 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>
$(go.Diagram, . . .,
{
. . .,
layout: $(go.TreeLayout, { isInitial: false, isOngoing: false }, . . .),
"InitialLayoutCompleted": function(e) {
// if not all Nodes have real locations, force a layout to happen
if (!e.diagram.nodes.all(function(n) { return 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>Part,LayoutNodeSized</a> condition:
</p>
<pre class="lang-js"><code>
$(go.Node, . . .,
{ layoutConditions: go.Part.LayoutStandard & ~go.Part.LayoutNodeSized },
. . .
)
</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 isLayoutPositioned 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>
<div class="bg-nwoods-primary">
<section class="max-w-screen-lg text-white container mx-auto py-2 px-12">
<p id="version" class="leading-none mb-2 my-4">GoJS</p>
</section>
</div><footer class="bg-nwoods-primary text-white">
<div class="container max-w-screen-lg mx-auto px-8">
<div class="w-full py-6">
<div class="max-w-screen-lg xl:max-w-screen-xl mx-auto px-4 sm:px-6 md:px-8">
<ul class="text-sm font-medium pb-6 grid grid-cols-2 sm:grid-cols-3 gap-y-10">
<li class="list-none row-span-2">
<h2 class="text-base font-semibold tracking-wide">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">GitHub</a>
</li>
</ul>
</li>
<li class="list-none row-span-2">
<h2 class="text-base font-semibold tracking-wide">Support</h2>
<ul class="list-none space-y-4 md:space-y-1 px-0">
<li>
<a href="https://www.nwoods.com/contact.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/contact.html', 'contact');">Contact</a>
</li>
<li>
<a href="https://forum.nwoods.com/c/gojs">Forum</a>
</li>
<li>
<a href="https://www.nwoods.com/app/activate.aspx?sku=gojs">Activate</a>
</li>
<li>
<a href="https://www.nwoods.com/sales/index.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');">Buy</a>
</li>
<li>
<a href="https://www.youtube.com/channel/UC9We8EoX596-6XFjJDtZIDg">Videos</a>
</li>
</ul>
</li>
<li class="list-none row-span-2">
<h2 class="text-base font-semibold tracking-wide">Company</h2>
<ul class="list-none space-y-4 md:space-y-1 px-0">
<li>
<a target="_blank" href="https://www.nwoods.com">Northwoods</a>
</li>
<li>
<a target="_blank" href="https://www.nwoods.com/about.html">About Us</a>
</li>
<li>
<a target="_blank" href="https://www.nwoods.com/contact.html">Contact Us</a>
</li>
<li>
<a target="_blank" href="https://www.nwoods.com/consulting.html">Consulting</a>
</li>
<li>
<a target="_blank" href="https://twitter.com/northwoodsgo">Twitter</a>
</li>
</ul>
</li>
</ul>
<p class="text-sm text-gray-100 md:mb-6">
Copyright 1998-2022 <a class="text-white" href="https://www.nwoods.com">Northwoods Software</a>
</p>
</div>
</div>
</footer> </body>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-1506307-5"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date()); gtag('config', 'UA-1506307-5');
var getOutboundLink = function(url, label) {
gtag('event', 'click', {
'event_category': 'outbound',
'event_label': label,
'transport_type': 'beacon'
});
}
// topnav
var topButton = document.getElementById("topnavButton");
var topnavList = document.getElementById("topnavList");
topButton.addEventListener("click", function() {
this.classList.toggle("active");
topnavList.classList.toggle("hidden");
document.getElementById("topnavOpen").classList.toggle("hidden");
document.getElementById("topnavClosed").classList.toggle("hidden");
});
</script>
<script src="../assets/js/prism.js"></script>
<script src="../release/go.js"></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>