-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
Copy pathnodes.html
906 lines (852 loc) · 34.2 KB
/
nodes.html
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
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
<!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="preconnect" href="https://rsms.me/">
<link rel="stylesheet" href="../assets/css/style.css">
<!-- Copyright 1998-2025 by Northwoods Software Corporation. -->
<meta itemprop="name" content="Nodes" />
<meta property="og:title" content="Nodes" />
<meta name="twitter:title" content="Nodes" />
<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/nodes.html" />
<meta property="twitter:url" content="https://gojs.net/latest/intro/nodes.html" />
<meta name="twitter:card" content="summary_large_image" />
<meta property="og:type" content="website" />
<meta property="twitter:domain" content="gojs.net" />
<title>
Nodes | 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 (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 flex-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="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="routers.html">Routers</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="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="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>Nodes</h1>
<p>
You can customize your nodes to have exactly the appearance and behavior that you want.
So far you have only seen very simple nodes.
But if you have seen the <a href="../samples/index.html">Sample Applications</a>,
you have seen many other kinds of nodes.
</p>
<p>
In this page we demonstrate some of the choices you can make when designing your nodes.
</p>
<h2 id="SurroundingContent">Surrounding Content</h2>
<p>
It is common to surround interesting information with a border or other background.
</p>
<h3 id="SimpleBorders">Simple borders</h3>
<p>
Many of the simplest nodes just consist of a <a>Panel</a> of type <a>Panel.Auto</a> with a <a>Shape</a>
surrounding a <a>TextBlock</a>.
</p>
<pre class="lang-js" id="border"><code>
diagram.nodeTemplate =
new go.Node("Auto")
.add(
new go.Shape("Rectangle")
.bind("fill", "color"),
new go.TextBlock({ margin: 5 })
.bind("text")
);
diagram.model.nodeDataArray = [
{ text: "Alpha", color: "lightblue" }
];
</code></pre>
<script>goCode("border", 300, 150)</script>
<h3 id="ShapedNodes">Shaped nodes</h3>
<p>
The Shape surrounding the content need not be rectangular.
This example demonstrates a number of shapes.
</p>
<pre class="lang-js" id="shapes"><code>
diagram.nodeTemplate =
new go.Node("Auto")
.add(
new go.Shape()
.bind("figure", "fig")
.bind("fill", "color"),
new go.TextBlock({ margin: 5 })
.bind("text")
);
diagram.model.nodeDataArray = [
{ text: "Alpha", color: "lightblue", fig: "RoundedRectangle" },
{ text: "Beta", color: "lightblue", fig: "Ellipse" },
{ text: "Gamma", color: "lightblue", fig: "Hexagon" },
{ text: "Delta", color: "lightblue", fig: "FramedRectangle" },
{ text: "Epsilon", color: "lightblue", fig: "Cloud" },
{ text: "Zeta", color: "lightblue", fig: "Procedure" }
];
</code></pre>
<script>goCode("shapes", 300, 150)</script>
<p>
The surrounding/background object need not be a <a>Shape</a>.
You could use a <a>Picture</a> or even a more complex object such as a <a>Panel</a>.
</p>
<h3 id="ComplexContents">Complex contents</h3>
<p>
The content of an Auto <a>Panel</a> need not be limited to a single <a>TextBlock</a> --
you can have arbitrarily complex panels of objects.
In this example the content is a Table Panel with three rows of TextBlocks.
</p>
<pre class="lang-js" id="borderedtable"><code>
diagram.nodeTemplate =
new go.Node("Auto")
.add(
new go.Shape({
fill: new go.Brush("Linear", { 0: "white", 1: "lightblue" }),
stroke: "darkblue", strokeWidth: 2
}),
new go.Panel("Table", { defaultAlignment: go.Spot.Left, margin: 4 })
.addColumnDefinition(1, { width: 4 })
.add(
new go.TextBlock({
row: 0, column: 0, columnSpan: 3, alignment: go.Spot.Center,
font: "bold 12pt sans-serif"
})
.bind("text"),
new go.TextBlock("First: ", { row: 1, column: 0 }),
new go.TextBlock({ row: 1, column: 2 })
.bind("text", "prop1"),
new go.TextBlock("Second: ", { row: 2, column: 0 }),
new go.TextBlock({ row: 2, column: 2 })
.bind("text", "prop2")
)
);
diagram.model.nodeDataArray = [
{ text: "Alpha", prop1: "value of 'prop1'", prop2: "the other property" }
];
</code></pre>
<script>goCode("borderedtable", 300, 150)</script>
<h3 id="FixedSizeNodes">Fixed-size nodes</h3>
<p>
The above examples have the "Auto" Panel surround some content, where the content might be of different sizes.
That results in the Nodes having different sizes.
</p>
<p>
If you want a <a>Panel</a> (and thus a Node, because <a>Node</a> inherits from <a>Part</a> which inherits from <a>Panel</a>)
to be of fixed size, set <a>GraphObject.desiredSize</a> on that panel.
(Equivalently, you can set <a>GraphObject.width</a> and <a>GraphObject.height</a>.)
That may result in the clipping of content that is too large,
or it may result in extra space if the content is smaller than the available area provided by the "Auto" Panel.
</p>
<pre class="lang-js" id="fixedsize"><code>
diagram.nodeTemplate =
new go.Node("Auto", { desiredSize: new go.Size(100, 50) }) // on Panel
.add(
new go.Shape()
.bind("figure", "fig")
.bind("fill", "color"),
new go.TextBlock({ margin: 5 })
.bind("text")
);
diagram.model.nodeDataArray = [
{ text: "Alpha", color: "lightblue", fig: "RoundedRectangle" },
{ text: "Beta", color: "lightblue", fig: "Ellipse" },
{ text: "Gamma", color: "lightblue", fig: "Hexagon" },
{ text: "Delta", color: "lightblue", fig: "FramedRectangle" },
{ text: "Epsilon,Epsilon,Epsilon", color: "lightblue", fig: "Cloud" },
{ text: "Z", color: "lightblue", fig: "Procedure" }
];
</code></pre>
<script>goCode("fixedsize", 500, 200)</script>
<p>
Note how the "Epsilon..." TextBlock is measured with the constraint of having a limited width,
as imposed by the Panel's width. That results in the text being wrapped before (maybe) being clipped.
</p>
<p>
You probably do not want to set the desiredSize of the main element, the Shape in this case above.
If you did, that would not constrain how the content elements are sized within the Panel.
</p>
<pre class="lang-js" id="fixedsize2"><code>
diagram.nodeTemplate =
new go.Node("Auto")
.add(
new go.Shape({ desiredSize: new go.Size(100, 50) }) // not here!
.bind("figure", "fig")
.bind("fill", "color"),
new go.TextBlock({ margin: 5 })
.bind("text")
);
diagram.model.nodeDataArray = [
{ text: "Alpha", color: "lightblue", fig: "RoundedRectangle" },
{ text: "Beta", color: "lightblue", fig: "Ellipse" },
{ text: "Gamma", color: "lightblue", fig: "Hexagon" },
{ text: "Delta", color: "lightblue", fig: "FramedRectangle" },
{ text: "Epsilon,Epsilon,Epsilon", color: "lightblue", fig: "Cloud" },
{ text: "Z", color: "lightblue", fig: "Procedure" }
];
</code></pre>
<script>goCode("fixedsize2", 500, 200)</script>
<p>
Note how the TextBlock is measured without the constraint of having a limited width from the Panel.
That results in the text being treated as a single long line, which is then clipped by the Panel.
</p>
<h2 id="StackedContent">Stacked Content</h2>
<p>
Many simple nodes consist of a few objects positioned above each other or next to each other.
</p>
<h3 id="Icons">Icons</h3>
<p>
Perhaps the most commonly seen kind of node can be implemented using a Vertical <a>Panel</a>.
</p>
<pre class="lang-js" id="icons"><code>
diagram.nodeTemplate =
new go.Node("Vertical")
.add(
new go.Picture({ maxSize: new go.Size(50, 50) })
.bind("source", "img"),
new go.TextBlock({
margin: new go.Margin(3, 0, 0, 0),
maxSize: new go.Size(100, 30),
isMultiline: false
})
.bind("text")
);
diagram.model.nodeDataArray = [
{ text: "Jellylorum", img: "images/50x40.png" }
];
</code></pre>
<script>goCode("icons", 300, 150)</script>
<p>
Of course you are not limited to just two objects in a panel.
In fact you can have as many GraphObjects in a "Vertical" or a "Horizontal" Panel as you like.
</p>
<pre class="lang-js" id="icons2"><code>
diagram.nodeTemplate =
new go.Node("Vertical")
.add(
new go.TextBlock({
margin: new go.Margin(3, 0, 0, 0),
maxSize: new go.Size(100, 30),
isMultiline: false,
font: "bold 10pt sans-serif"
})
.bind("text", "head"),
new go.Picture({ maxSize: new go.Size(50, 50) })
.bind("source", "img"),
new go.TextBlock({
margin: new go.Margin(3, 0, 0, 0),
maxSize: new go.Size(100, 30),
isMultiline: false
})
.bind("text", "foot")
);
diagram.model.nodeDataArray = [
{ head: "Kitten", foot: "Tantomile", img: "images/50x40.png" }
];
</code></pre>
<script>goCode("icons2", 300, 150)</script>
<h3 id="SmallIcons">Small icons</h3>
<p>
Another commonly seen kind of node can be implemented using a Horizontal <a>Panel</a>.
</p>
<pre class="lang-js" id="smallicons"><code>
diagram.nodeTemplate =
new go.Node("Horizontal")
.add(
new go.Picture({ maxSize: new go.Size(16, 16) })
.bind("source", "img"),
new go.TextBlock({ margin: new go.Margin(0, 0, 0, 2) })
.bind("text")
);
diagram.model.nodeDataArray = [
{ text: "Alonzo", img: "images/50x40.png" }
];
</code></pre>
<script>goCode("smallicons", 300, 150)</script>
<h2 id="NestedPanels">Nested Panels</h2>
<p>
Panels can be nested.
For example, here is a node consisting of a "Vertical" Panel consisting of an "Auto" Panel surrounding a "Vertical" Panel including a "Horizontal" Panel.
The outer "Vertical" Panel arranges the main stuff on top and a TextBlock on the bottom.
The "Auto" Panel supplies a border around everything but the bottom text.
The inner "Vertical" Panel places three objects vertically in a stack.
The "Horizontal" Panel which is the first element of the "Vertical" Panel places three objects horizontally in a row.
</p>
<pre class="lang-js" id="nestedpanel1"><code>
// common styling for each indicator
function makeIndicator(propName) { // the data property name
return new go.Shape("Circle", {
width: 8, height: 8, fill: "white", strokeWidth: 0, margin: 5
})
.bind("fill", propName);
}
function makeImagePath(icon) { return "../samples/images/" + icon; }
diagram.nodeTemplate =
new go.Node("Vertical")
.add(
new go.Panel("Auto", {
background: "white",
portId: "" // this whole panel acts as the only port for the node
})
.add(
new go.Shape( // the border
{ fill: "transparent", stroke: "lightgray" }),
new go.Panel("Vertical") // everything within the border
.add(
new go.Panel("Horizontal")
.add( // the row of status indicators
makeIndicator("ind0"),
makeIndicator("ind1"),
makeIndicator("ind2")
), // end Horizontal Panel
new go.Picture({ width: 32, height: 32, margin: 4 })
.bind("source", "icon", makeImagePath),
new go.TextBlock({
stretch: go.Stretch.Horizontal, textAlign: "center"
})
.bind("text", "number")
.bind("background", "color")
) // end Vertical Panel
), // end Auto Panel
new go.TextBlock({ margin: 4 })
.bind("text")
);
diagram.model.nodeDataArray = [
{ key: 1, text: "Device Type A", number: 17, icon: "server switch.jpg", color: "moccasin",
ind0: "red", ind1: "orange", ind2: "mediumspringgreen" },
{ key: 2, text: "Device Type B", number: 97, icon: "voice atm switch.jpg", color: "mistyrose",
ind0: "lightgray", ind1: "orange", ind2: "green" }
];
diagram.model.linkDataArray = [
{ from: 1, to: 2 }
];
</code></pre>
<script>goCode("nestedpanel1", 300, 150)</script>
<h2 id="DecoratedContent">Decorated Content</h2>
<p>
Sometimes you want to have a simple node that may display additional visuals to indicate what state it is in.
</p>
<p>
One way to implement this is to use a Spot <a>Panel</a>, where the main element is itself a Panel containing the
elements that you always want to display, and there are additional objects located at spots around the main element.
The basic outline would be:
</p>
<pre class="lang-js"><code>
Node, "Spot"
Panel, "Auto" // the contents with border
Shape // the border
Panel, ... // the contents
. . .
Shape // the decoration
</code></pre>
<p>
So the basic body of the node is in a "Vertical" or any kind of Panel,
which is surrounded by a border using an "Auto" Panel,
which gets decorations using the "Spot" Panel that is also the Node.
</p>
<p>
The same design of having the Node be a "Spot" Panel can also used for placing ports relative to the body of a node.
</p>
<pre class="lang-js" id="spotdecorations"><code>
diagram.nodeTemplate =
new go.Node("Spot", {
toolTip:
new go.Adornment("Auto")
.add(
new go.Shape({ fill: "#FFFFCC" })
.bind("visible", "info", i => i ? true : false),
new go.TextBlock({ margin: 4 })
.bind("text", "info")
)
})
.add(
// the main content:
new go.Panel("Vertical")
.add(
new go.Picture({ maxSize: new go.Size(50, 50) })
.bind("source", "img"),
new go.TextBlock({ margin: new go.Margin(3, 0, 0, 0) })
.bind("text", "text")
.bind("stroke", "error", err => err ? "red" : "black")
),
// decorations:
new go.Shape("TriangleUp", {
alignment: go.Spot.TopLeft,
fill: "yellow", width: 14, height: 14,
visible: false
})
.bind("visible", "info", i => i ? true : false),
new go.Shape("StopSign", {
alignment: go.Spot.TopRight,
fill: "red", width: 14, height: 14,
visible: false
})
.bind("visible", "error")
);
diagram.model.nodeDataArray = [
{ text: "Demeter", img: "images/50x40.png", info: "" },
{ text: "Copricat", img: "images/50x40.png", error: true, info: "shredded curtains" }
];
</code></pre>
<script>goCode("spotdecorations", 300, 150)</script>
<p>
As another example of a node decoration, this implements a "ribbon" at the top right corner of the node.
The ribbon is implemented by a <a>Panel</a> that contains both a <a>Shape</a> and a <a>TextBlock</a>,
and the panel is positioned by its <a>GraphObject.alignment</a> and <a>GraphObject.alignmentFocus</a> in
the Spot Panel that also is the <a>Node</a>.
The appearance of the ribbon is achieved by using a custom <a>Geometry</a> and binding <a>GraphObject.opacity</a>.
</p>
<pre class="lang-js" id="ribbondecorations"><code>
diagram.nodeTemplate =
new go.Node("Spot", {
locationSpot: go.Spot.Center, locationObjectName: "BODY",
selectionObjectName: "BODY"
})
.add(
new go.Panel("Auto", {
name: "BODY", width: 150, height: 100, portId: ""
})
.add(
new go.Shape({ fill: "lightgray", stroke: null, strokeWidth: 0 }),
new go.TextBlock()
.bind("text")
), // end "Auto" Panel
new go.Panel("Spot", {
// note that the opacity defaults to zero (not visible),
// in case there is no "ribbon" property
opacity: 0,
alignment: new go.Spot(1, 0, 2, -2),
alignmentFocus: go.Spot.TopRight
})
.bind("opacity", "ribbon", t => t ? 1 : 0)
.add(
new go.Shape({ // the ribbon itself
geometryString: "F1 M0 0 L30 0 70 40 70 70z",
fill: "red", stroke: null, strokeWidth: 0
}),
new go.TextBlock({
alignment: new go.Spot(1, 0, -29, 29),
angle: 45, maxSize: new go.Size(100, NaN),
stroke: "white", font: "bold 13px sans-serif", textAlign: "center"
})
.bind("text", "ribbon")
) // end inner "Spot" Panel
); // end outer "Spot" Panel
diagram.model = new go.GraphLinksModel([
{ key: 1, text: "Alpha" },
{ key: 2, text: "Beta", ribbon: "NEWEST" }
],[
]);
</code></pre>
<script>goCode("ribbondecorations", 500, 150)</script>
<h2 id="PositionAndLocation">Position and Location</h2>
<p>
Nodes are positioned in document coordinates.
(For more information, read <a href="viewport.html">Coordinate Systems</a>.)
The point at which a Node resides, in document coordinates, is normally the top-left corner of the Node's <a>GraphObject.actualBounds</a>.
If you set the <a>GraphObject.position</a> of a Node, you will be modifying the <code>x</code> and <code>y</code> values
of the node's <a>GraphObject.actualBounds</a>.
</p>
<p>
However there are times when it is more natural to think that the "point" of a Node is not at the top-left corner but at some other spot within.
This is especially true when you want any variably-sized text labels or occasional decorations to be ignored regarding the node's location.
That is why Nodes also have a "location" which refers to a point inside the Node.
If you set the <a>Part.location</a> of a Node, you will be lining up the location point of the node to be at that point in document coordinates.
When you move a Node you are actually changing its <a>Part.location</a>.
</p>
<p>
By default the location of a Node is the same as its position.
However you can set the <a>Part.locationSpot</a> to cause the location point to be at some spot in the node's actualBounds.
Furthermore you can set the <a>Part.locationObjectName</a> to cause the location point to be at some spot in some element within the node.
The position will always be at the top-left corner of the whole node,
but the location may be some point at some spot in some object within the node.
</p>
<pre class="lang-js" id="positionlocation"><code>
diagram.grid.visible = true;
diagram.add(
new go.Node("Vertical", { position: new go.Point(0, 0) }) // set the Node.position
.add(
new go.TextBlock("position", { editable: true }),
new go.Shape({ name: "SHAPE", width: 30, height: 30, fill: "lightgreen" })
));
diagram.add(
new go.Node("Vertical", {
location: new go.Point(100, 0), // set the Node.location
locationObjectName: "SHAPE" // the location point is on the element named "SHAPE"
})
.add(
new go.TextBlock("location", { editable: true }),
new go.Shape({ name: "SHAPE", width: 30, height: 30, fill: "lightgreen" })
));
</code></pre>
<script>goCode("positionlocation", 500, 200)</script>
<p>
In this example both nodes have the same Y-coordinate value of zero.
Note how in the above example the "position" Node has the top-left corner of the node at the grid point.
Yet the "location" Node has the top-left corner of the green square at the grid point.
If you edit the text of each node after double-clicking on the text,
note how the green square moves relative to the diagram grid for the "position" node,
but that it does not move for the "location" node.
</p>
<p>
It is common to specify the <a>Part.locationSpot</a> to be <code>go.Spot.Center</code> so that the location point
is at the center of some element in the node, rather than at the top-left corner of that element.
</p>
<pre class="lang-js" id="positionlocation2"><code>
diagram.grid.visible = true;
diagram.add(
new go.Node("Vertical", { position: new go.Point(0, 0) }) // set the Node.position
.add(
new go.TextBlock("position", { editable: true }),
new go.Panel("Auto")
.add(
new go.Shape("Circle", { name: "SHAPE", width: 16, height: 16, fill: "lightgreen" }),
new go.Shape("Circle", { width: 6, height: 6, strokeWidth: 0 })
)
));
diagram.add(
new go.Node("Vertical", {
location: new go.Point(100, 0), // set the Node.location
locationObjectName: "SHAPE", // the location point is at the center of "SHAPE"
locationSpot: go.Spot.Center
})
.add(
new go.TextBlock("location", { editable: true }),
new go.Panel("Auto")
.add(
new go.Shape("Circle", { name: "SHAPE", width: 16, height: 16, fill: "lightgreen" }),
new go.Shape("Circle", { width: 6, height: 6, strokeWidth: 0 })
)
));
</code></pre>
<script>goCode("positionlocation2", 500, 200)</script>
<p>
If the position or location of a Node is not <a>Point.isReal</a>, it will not be seen, because GoJS will not know where to draw the node.
In fact the default value for a node's position or location is <code>NaN, NaN</code> and it is the responsibility
of either the <a>Diagram.layout</a> or data bindings to assign real point values for each node.
</p>
</div>
</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>
</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="../release/go.js"></script>
<script src="../extensions/Figures.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>