-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
Copy pathpermissions.html
766 lines (707 loc) · 30.8 KB
/
permissions.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
<!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="User Permissions" />
<meta property="og:title" content="User Permissions" />
<meta name="twitter:title" content="User Permissions" />
<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/permissions.html" />
<meta property="twitter:url" content="https://gojs.net/latest/intro/permissions.html" />
<meta name="twitter:card" content="summary_large_image" />
<meta property="og:type" content="website" />
<meta property="twitter:domain" content="gojs.net" />
<title>
User Permissions | 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>User Permissions</h1>
<p>Programmatically there are no restrictions on what you can do. However you may want to restrict the actions that your users may perform.</p>
<h3 id="DiagramIsEnabled">Diagram.isEnabled</h3>
<p>
The simplest restriction is to set <a>Diagram.isEnabled</a> to false. Users will not be able to do much of anything. In this example, even though the
grouping, undo, and redo commands are enabled, the commands cannot execute because the diagram is disabled.
</p>
<pre class="lang-js" id="isEnabled"><code>
diagram.commandHandler.archetypeGroupData =
{ key: "Group", isGroup: true, color: "blue" };
const nodeDataArray = [
{ key: "Alpha" },
{ key: "Beta" },
{ key: "Delta", group: "Epsilon" },
{ key: "Gamma", group: "Epsilon" },
{ key: "Epsilon", isGroup: true }
];
const linkDataArray = [
{ from: "Alpha", to: "Beta" },
{ from: "Beta", to: "Beta" },
{ from: "Gamma", to: "Delta" },
{ from: "Delta", to: "Alpha" }
];
diagram.model = new go.GraphLinksModel(nodeDataArray, linkDataArray);
diagram.undoManager.isEnabled = true;
diagram.add( // this is just a visual comment
new go.Part({ location: new go.Point(200, 50) })
.add(
new go.TextBlock("Diagram.isEnabled == false", {
font: "16pt bold", stroke: "red"
})
));
// Disable the diagram!
diagram.isEnabled = false;
</code></pre>
<script>
goCode('isEnabled', 600, 150);
</script>
<h3 id="DiagramIsReadOnly">Diagram.isReadOnly</h3>
<p>
More common is to set <a>Diagram.isReadOnly</a> to true. This allows users to scroll and zoom and to select parts, but not to insert or delete or drag or
modify parts. (If you want to allow scroll and zoom but not selection, you can disable selection, as discussed below.)
</p>
<pre class="lang-js" id="isReadOnly"><code>
diagram.commandHandler.archetypeGroupData =
{ key: "Group", isGroup: true, color: "blue" };
const nodeDataArray = [
{ key: "Alpha" },
{ key: "Beta" },
{ key: "Delta", group: "Epsilon" },
{ key: "Gamma", group: "Epsilon" },
{ key: "Epsilon", isGroup: true }
];
const linkDataArray = [
{ from: "Alpha", to: "Beta" },
{ from: "Beta", to: "Beta" },
{ from: "Gamma", to: "Delta" },
{ from: "Delta", to: "Alpha" }
];
diagram.model = new go.GraphLinksModel(nodeDataArray, linkDataArray);
diagram.undoManager.isEnabled = true;
diagram.add( // this is just a visual comment
new go.Part({ location: new go.Point(200, 50) })
.add(
new go.TextBlock("Diagram.isReadOnly == true", {
font: "16pt bold", stroke: "red"
})
));
// Disable diagram modifications, but allow navigation and selection
diagram.isReadOnly = true;
</code></pre>
<script>
goCode('isReadOnly', 600, 150);
</script>
<h3 id="DiagramIsModelReadOnly">Diagram.isModelReadOnly</h3>
<p>
Another possibility is to set <a>Model.isReadOnly</a> to true. This allows users to scroll, zoom, select, and move parts, but not to insert or delete parts,
including not adding or removing links nor adding or removing group members.
</p>
<p>
The <a>Diagram.isModelReadOnly</a> property just gets and sets the <a>Model.isReadOnly</a> property. If you are loading new Models, you will need to set this
Diagram property after setting <a>Diagram.model</a>.
</p>
<pre class="lang-js" id="isModelReadOnly"><code>
diagram.commandHandler.archetypeGroupData =
{ key: "Group", isGroup: true, color: "blue" };
const nodeDataArray = [
{ key: "Alpha" },
{ key: "Beta" },
{ key: "Delta", group: "Epsilon" },
{ key: "Gamma", group: "Epsilon" },
{ key: "Epsilon", isGroup: true }
];
const linkDataArray = [
{ from: "Alpha", to: "Beta" },
{ from: "Beta", to: "Beta" },
{ from: "Gamma", to: "Delta" },
{ from: "Delta", to: "Alpha" }
];
diagram.model = new go.GraphLinksModel(nodeDataArray, linkDataArray);
diagram.undoManager.isEnabled = true;
diagram.add( // this is just a visual comment
new go.Part({ location: new go.Point(200, 50) })
.add(
new go.TextBlock("Diagram.model.isReadOnly == true", {
font: "16pt bold", stroke: "red"
})
));
// Disable adding or removing parts
diagram.model.isReadOnly = true;
</code></pre>
<script>
goCode('isModelReadOnly', 600, 150);
</script>
<h3 id="AllowingCollapseExpand">Allowing Collapse and Expand</h3>
<p>
One common situation with diagrams that are <a>Diagram.isReadOnly</a> is that the user can not collapse or expand trees or subgraphs. Instead of setting
<a>Diagram.isReadOnly</a>, you can set these properties:
</p>
<pre class="lang-js" id="collapseExpand"><code>
new go.Palette("myPaletteDiv",
{
isReadOnly: false,
isModelReadOnly: true,
allowDelete: false,
allowInsert: false,
allowLink: false,
allowMove: false,
allowTextEdit: false,
// maybe other Diagram.allow... properties too, depending on your templates
// also consider disabling Tools
"contextMenuTool.isEnabled": false,
nodeTemplateMap: . . .
})
</code></pre>
<h2 id="SpecificPermissions">Specific permissions</h2>
<p>
More precise restrictions on the user can be imposed by setting properties of the <a>Diagram</a> or of a particular <a>Layer</a> or of a particular
<a>Part</a> or <a>GraphObject</a>.
</p>
<p>
Some restrictions, such as <a>Diagram.allowZoom</a>, only make sense when applying to the whole diagram. Others may also apply to individual parts, such as
<a>Part.copyable</a> and <a>Layer.allowCopy</a> corresponding to <a>Diagram.allowCopy</a>. Finally some may apply to any <a>GraphObject</a>, for example
properties for ports such as <a>GraphObject.toLinkable</a>, or to text objects such as <a>TextBlock.editable</a>.
</p>
<p>
Any <a>Tool</a> can be disabled by setting <a>Tool.isEnabled</a> to false. By default all Tools are enabled, but many cannot run because the conditions are
not right for <a>Tool.canStart</a> to return true.
</p>
<p>Here is a listing of what users can do and the properties that limit that functionality. Most of these properties have a default value of true.</p>
<h3 id="CutCommand">Cut command (<a>CommandHandler</a>)</h3>
<ul>
<li><a>Diagram.allowCopy</a>, <a>Diagram.allowDelete</a>, <a>Diagram.allowClipboard</a></li>
<li><a>Diagram.isReadOnly</a> and <a>Model.isReadOnly</a> (default values are false)</li>
</ul>
<h3 id="CopyCommand">Copy command (<a>CommandHandler</a>)</h3>
<ul>
<li><a>Diagram.allowCopy</a>, <a>Diagram.allowClipboard</a></li>
<li><a>Layer.allowCopy</a></li>
<li><a>Part.copyable</a></li>
</ul>
<h3 id="PasteCommand">Paste command (<a>CommandHandler</a>)</h3>
<ul>
<li><a>Diagram.allowInsert</a>, <a>Diagram.allowClipboard</a></li>
<li><a>Diagram.isReadOnly</a> and <a>Model.isReadOnly</a> (default values are false)</li>
<li>The clipboard's data format must be the same as the <a>Model.dataFormat</a></li>
</ul>
<h3 id="DeleteCommand">Delete command (<a>CommandHandler</a>)</h3>
<ul>
<li><a>Diagram.allowDelete</a></li>
<li><a>Layer.allowDelete</a></li>
<li><a>Part.deletable</a></li>
<li><a>Diagram.isReadOnly</a> and <a>Model.isReadOnly</a> (default values are false)</li>
</ul>
<h3 id="DragAndDropWithinDiagram">Drag-and-drop within diagram (<a>DraggingTool</a>)</h3>
<ul>
<li><a>Diagram.allowMove</a>, <a>Diagram.allowCopy</a>, <a>Diagram.allowInsert</a></li>
<li><a>Layer.allowMove</a>, <a>Layer.allowCopy</a></li>
<li><a>Part.movable</a>, <a>Part.copyable</a></li>
<li><a>DraggingTool.isCopyEnabled</a></li>
<li><a>Diagram.isReadOnly</a> for moving (default value is false)</li>
<li><a>Diagram.isReadOnly</a> and <a>Model.isReadOnly</a> for copying (default values are false)</li>
<li>
Many properties affect dragging, including: <a>Part.maxLocation</a>, <a>Part.minLocation</a>, <a>Part.dragComputation</a>, and
<a>DraggingTool.isGridSnapEnabled</a>. Read about limiting user drags to be only horizontal or only vertical or only within the containing <a>Group</a> in
the documentation for <a>DraggingTool</a>.
</li>
<li><a>DraggingTool.isEnabled</a></li>
</ul>
<h3 id="DragAndDropOutOfDiagram">Drag-and-drop out of diagram (<a>DraggingTool</a>)</h3>
<ul>
<li><a>Diagram.allowDragOut</a> (default value is false except for <a>Palette</a> where it is true)</li>
<li><a>DraggingTool.isEnabled</a></li>
</ul>
<h3 id="DragAndDropIntoDiagram">Drag-and-drop into diagram (<a>DraggingTool</a>)</h3>
<ul>
<li><a>Diagram.allowDrop</a> (default value is true)</li>
<li><a>Diagram.allowInsert</a></li>
<li><a>Diagram.isReadOnly</a> and <a>Model.isReadOnly</a> (default values are false)</li>
<li><a>DraggingTool.isEnabled</a></li>
</ul>
<h3 id="InPlaceTextEditing">In-place text editing (<a>TextEditingTool</a>)</h3>
<ul>
<li><a>Diagram.allowTextEdit</a></li>
<li><a>Layer.allowTextEdit</a></li>
<li><a>Part.textEditable</a></li>
<li>
<a>TextBlock.editable</a>, <a>TextBlock.textValidation</a>, and <a>TextEditingTool.textValidation</a> affect text editing (these are discussed in the
section about <a href="validation.html">Validation</a>)
</li>
<li><a>Diagram.isReadOnly</a> (default value is false)</li>
<li><a>TextEditingTool.isEnabled</a></li>
<li><a>TextEditingTool.starting</a> controls how the editing may be initiated.</li>
</ul>
<h3 id="GroupCommand">Group command (<a>CommandHandler</a>)</h3>
<ul>
<li><a>Diagram.allowGroup</a>, <a>Diagram.allowInsert</a></li>
<li><a>Layer.allowGroup</a></li>
<li><a>Part.groupable</a></li>
<li>
The <a>CommandHandler.groupSelection</a> command requires that <a>CommandHandler.archetypeGroupData</a> has been set to a data object to be copied into the
model to be represented by a new group in the diagram; this property is null by default, causing the command to be disabled. You will need to set the
property to an object so that newly created groups have the desired property values for any data binding by the group template.
</li>
<li><a>Group.memberValidation</a> and <a>CommandHandler.memberValidation</a> also control which Parts may become members of a Group</li>
<li><a>Diagram.isReadOnly</a> and <a>Model.isReadOnly</a> (default values are false)</li>
</ul>
<h3 id="UngroupCommand">Ungroup command (<a>CommandHandler</a>)</h3>
<ul>
<li><a>Diagram.allowUngroup</a>, <a>Diagram.allowDelete</a></li>
<li><a>Layer.allowUngroup</a></li>
<li><a>Group.ungroupable</a> (default value is false)</li>
<li><a>Diagram.isReadOnly</a> and <a>Model.isReadOnly</a> (default values are false)</li>
</ul>
<h3 id="ClickCreating">Click-creating (<a>ClickCreatingTool</a>)</h3>
<ul>
<li><a>Diagram.allowInsert</a></li>
<li>
The <a>ClickCreatingTool</a> requires that <a>ClickCreatingTool.archetypeNodeData</a>
has been set to a data object to be copied into the model to be represented by a new part in the diagram; this property is null by default, causing the tool
to be disabled. You will need to set the property to an object so that newly created nodes have the desired property values for any data binding by the node
template.
</li>
<li><a>Diagram.isReadOnly</a> and <a>Model.isReadOnly</a> (default values are false)</li>
<li><a>ClickCreatingTool.isEnabled</a></li>
<li><a>ClickCreatingTool.isDoubleClick</a> whether to insert on single click or double click.</li>
</ul>
<h3 id="DrawingNewLink">Drawing a new link (<a>LinkingTool</a>)</h3>
<ul>
<li><a>Diagram.allowLink</a></li>
<li><a>Layer.allowLink</a></li>
<li>
<a>GraphObject.fromLinkable</a>, <a>GraphObject.fromLinkableDuplicates</a>, <a>GraphObject.fromLinkableSelfNode</a>, <a>GraphObject.fromMaxLinks</a>,
<a>GraphObject.toLinkable</a>, <a>GraphObject.toLinkableDuplicates</a>, <a>GraphObject.toLinkableSelfNode</a>, <a>GraphObject.toMaxLinks</a> (these are
discussed in the section about <a href="validation.html">Validation</a>)
</li>
<li>
The <a>LinkingTool</a> requires that <a>LinkingTool.archetypeLinkData</a> has been set to a data object to be copied into the model to be represented by a
new link in the diagram; this property is by default set to an empty JavaScript object. You may need to want to set properties on this object so that newly
created links have the desired property values for any data binding by the link template.
</li>
<li><a>Diagram.isReadOnly</a> and <a>Model.isReadOnly</a> (default values are false)</li>
<li><a>LinkingTool.isEnabled</a></li>
</ul>
<h3 id="RelinkingExistingLink">Relinking an existing link (<a>RelinkingTool</a>)</h3>
<ul>
<li><a>Diagram.allowRelink</a></li>
<li><a>Layer.allowRelink</a></li>
<li><a>Link.relinkableFrom</a>, <a>Link.relinkableTo</a> (default values are false)</li>
<li>
<a>GraphObject.fromLinkable</a>, <a>GraphObject.fromLinkableDuplicates</a>, <a>GraphObject.fromLinkableSelfNode</a>, <a>GraphObject.fromMaxLinks</a>,
<a>GraphObject.toLinkable</a>, <a>GraphObject.toLinkableDuplicates</a>, <a>GraphObject.toLinkableSelfNode</a>, <a>GraphObject.toMaxLinks</a> (these are
discussed in the section about <a href="validation.html">Validation</a>)
</li>
<li><a>Diagram.isReadOnly</a> and <a>Model.isReadOnly</a> (default values are false)</li>
<li><a>RelinkingTool.isEnabled</a></li>
</ul>
<h3 id="ReshapingLink">Reshaping a link (<a>LinkReshapingTool</a>)</h3>
<ul>
<li><a>Diagram.allowReshape</a></li>
<li><a>Layer.allowReshape</a></li>
<li><a>Part.reshapable</a> (default value is false)</li>
<li><a>Link.resegmentable</a> also affects whether segments can be added or removed (default value is false)</li>
<li><a>Diagram.isReadOnly</a> (default value is false)</li>
<li><a>LinkReshapingTool.isEnabled</a></li>
</ul>
<h3 id="ResizingObject">Resizing an object (<a>ResizingTool</a>)</h3>
<ul>
<li><a>Diagram.allowResize</a></li>
<li><a>Layer.allowResize</a></li>
<li><a>Part.resizable</a> (default value is false)</li>
<li>
<a>Part.resizeCellSize</a>, <a>GraphObject.maxSize</a>, and <a>GraphObject.minSize</a> limit the size to which the user may resize the
<a>Part.resizeObject</a>
</li>
<li>
<a>ResizingTool.maxSize</a>, <a>ResizingTool.minSize</a>, and <a>ResizingTool.cellSize</a> limit the size to which the user may resize the
<a>Part.resizeObject</a>
</li>
<li><a>Diagram.isReadOnly</a> (default value is false)</li>
<li><a>ResizingTool.isEnabled</a></li>
</ul>
<h3 id="RotatingObject">Rotating an object (<a>RotatingTool</a>)</h3>
<ul>
<li><a>Diagram.allowRotate</a></li>
<li><a>Layer.allowRotate</a></li>
<li><a>Part.rotatable</a> (default value is false)</li>
<li>
<a>RotatingTool.snapAngleMultiple</a> and <a>RotatingTool.snapAngleEpsilon</a> limit the angles to which the user may rotate the <a>Part.rotateObject</a>
</li>
<li><a>Diagram.isReadOnly</a> (default value is false)</li>
<li><a>RotatingTool.isEnabled</a></li>
</ul>
<h3 id="ArrowAndPageCommands">Arrow and Page commands (<a>CommandHandler</a>), panning/scrolling the diagram (<a>PanningTool</a> and scrollbars)</h3>
<ul>
<li><a>Diagram.allowHorizontalScroll</a>, <a>Diagram.allowVerticalScroll</a></li>
<li><a>Diagram.hasHorizontalScrollbar</a>, <a>Diagram.hasVerticalScrollbar</a></li>
<li><a>Diagram.scrollMargin</a> and <a>Diagram.padding</a></li>
<li><a>Diagram.scrollMode</a> and <a>Diagram.positionComputation</a> for controlling how far the user may scroll</li>
<li><a>ToolManager.mouseWheelBehavior</a> controls whether mouse wheel events scroll or zoom</li>
<li>
See the DrawCommandHandler in the <a href="../extensions">Extensions</a> directory for a <a>CommandHandler</a> that customizes the behavior of the arrow
keys
</li>
<li><a>PanningTool.isEnabled</a></li>
<li><a>PanningTool.bubbles</a> controls whether panning gestures scroll the page rather than the viewport.</li>
</ul>
<h3 id="SelectAllCommand">SelectAll command (<a>CommandHandler</a>), click selecting (<a>ClickSelectingTool</a>), drag selecting (<a>DragSelectingTool</a>)</h3>
<ul>
<li><a>Diagram.allowSelect</a></li>
<li><a>Layer.allowSelect</a></li>
<li><a>Part.selectable</a></li>
<li><a>Diagram.maxSelectionCount</a> limits how many selectable <a>Part</a>s the user may select</li>
<li><a>DragSelectingTool.isEnabled</a></li>
</ul>
<h3 id="UndoRedoCommands">Undo/Redo commands (<a>CommandHandler</a>)</h3>
<ul>
<li><a>Diagram.allowUndo</a></li>
<li><a>UndoManager.isEnabled</a> (default value is false)</li>
<li><a>Diagram.isReadOnly</a> and <a>Model.isReadOnly</a> (default values are false)</li>
</ul>
<h3 id="ZoomCommands">Zoom commands (<a>CommandHandler</a>), zooming/rescaling the diagram (<a>ToolManager</a>)</h3>
<ul>
<li><a>Diagram.allowZoom</a></li>
<li><a>ToolManager.mouseWheelBehavior</a> controls whether mouse wheel events scroll or zoom</li>
<li><a>Diagram.minScale</a>, <a>Diagram.maxScale</a>, and <a>Diagram.scaleComputation</a> for controlling how far the user may zoom.</li>
</ul>
<h3 id="ContextMenus">Context Menus (<a>ContextMenuTool</a>)</h3>
<ul>
<li><a>GraphObject.contextMenu</a></li>
<li><a>Diagram.contextMenu</a></li>
<li><a>ContextMenuTool.isEnabled</a></li>
</ul>
</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="../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>