create-gojs-kit
Version:
A CLI for downloading GoJS samples, extensions, and docs
318 lines (279 loc) • 14.6 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, viewport-fit=cover"/>
<meta name="description" content="A tree-structured diagram annotated with balloon comments, automatically laid out." />
<meta itemprop="description" content="A tree-structured diagram annotated with balloon comments, automatically laid out." />
<meta property="og:description" content="A tree-structured diagram annotated with balloon comments, automatically laid out." />
<meta name="twitter:description" content="A tree-structured diagram annotated with balloon comments, automatically laid out." />
<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="Comment Nodes Laid out by Tree Layout" />
<meta property="og:title" content="Comment Nodes Laid out by Tree Layout" />
<meta name="twitter:title" content="Comment Nodes Laid out by Tree Layout" />
<meta property="og:image" content="https://gojs.net/latest/assets/images/screenshots/comments.png" />
<meta itemprop="image" content="https://gojs.net/latest/assets/images/screenshots/comments.png" />
<meta name="twitter:image" content="https://gojs.net/latest/assets/images/screenshots/comments.png" />
<meta property="og:url" content="https://gojs.net/latest/samples/comments.html" />
<meta property="twitter:url" content="https://gojs.net/latest/samples/comments.html" />
<meta name="twitter:card" content="summary_large_image" />
<meta property="og:type" content="website" />
<meta property="twitter:domain" content="gojs.net" />
<title>
Comment Nodes Laid out by Tree Layout | GoJS Diagramming Library
</title>
</head>
<body>
<!-- This top nav is not part of the sample code -->
<nav id="navTop" class=" w-full h-[var(--topnav-h)] z-30 bg-white border-b border-b-gray-200">
<div class="max-w-screen-xl mx-auto flex flex-wrap items-start justify-between px-4">
<a class="text-white bg-nwoods-primary font-bold !leading-[calc(var(--topnav-h)_-_1px)] my-0 px-2 text-4xl lg:text-5xl logo"
href="../">
GoJS
</a>
<div class="relative">
<button id="topnavButton" class="h-[calc(var(--topnav-h)_-_1px)] px-2 m-0 text-gray-900 bg-inherit shadow-none md:hidden hover:!bg-inherit hover:!text-nwoods-accent hover:!shadow-none" aria-label="Navigation">
<svg class="h-7 w-7 block" aria-hidden="true" fill="none" stroke="currentColor" stroke-width="2" viewBox="0 0 24 24">
<path d="M3.75 6.75h16.5M3.75 12h16.5m-16.5 5.25h16.5" stroke-linecap="round" stroke-linejoin="round"/>
</svg>
</button>
<div id="topnavList" class="hidden md:block">
<div class="absolute right-0 z-30 flex flex-col items-end rounded border border-gray-200 p-4 pl-12 shadow bg-white text-gray-900 font-semibold
md:flex-row md:space-x-4 md:items-start md:border-0 md:p-0 md:shadow-none md:bg-inherit">
<a href="../learn/">Learn</a>
<a href="../samples/">Samples</a>
<a href="../intro/">Intro</a>
<a href="../api/">API</a>
<a href="../download.html">Download</a>
<a href="https://forum.nwoods.com/c/gojs/11" target="_blank" rel="noopener">Forum</a>
<a id="tc" href="https://nwoods.com/contact.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://nwoods.com/contact.html', 'contact');">Contact</a>
<a id="tb" href="https://nwoods.com/sales/index.html"
target="_blank" rel="noopener" onclick="getOutboundLink('https://nwoods.com/sales/index.html', 'buy');">Buy</a>
</div>
</div>
</div>
</div>
</nav>
<script>
window.addEventListener("DOMContentLoaded", function () {
// topnav
var topButton = document.getElementById("topnavButton");
var topnavList = document.getElementById("topnavList");
if (topButton && topnavList) {
topButton.addEventListener("click", function (e) {
topnavList
.classList
.toggle("hidden");
e.stopPropagation();
});
document.addEventListener("click", function (e) {
// if the clicked element isn't the list, close the list
if (!topnavList.classList.contains("hidden") && !e.target.closest("#topnavList")) {
topButton.click();
}
});
// set active <a> element
var url = window
.location
.href
.toLowerCase();
var aTags = topnavList.getElementsByTagName('a');
for (var i = 0; i < aTags.length; i++) {
var lowerhref = aTags[i]
.href
.toLowerCase();
if (lowerhref.endsWith('.html'))
lowerhref = lowerhref.slice(0, -5);
if (url.startsWith(lowerhref)) {
aTags[i]
.classList
.add('active');
break;
}
}
}
});
</script>
<div class="flex flex-col prose">
<div class="w-full max-w-screen-xl mx-auto">
<!-- * * * * * * * * * * * * * -->
<!-- Start of GoJS sample code -->
<script src="https://cdn.jsdelivr.net/npm/gojs@3.1.0"></script>
<link rel="stylesheet" href="../assets/css/prism.css"/>
<script src="../assets/js/prism.js"></script>
<div id="allSampleContent" class="p-4 w-full">
<script src="../extensions/BalloonLink.js"></script>
<script id="code">
function init() {
myDiagram = new go.Diagram('myDiagramDiv', {
layout: new go.TreeLayout({
angle: 90,
setsPortSpot: false,
setsChildPortSpot: false,
arrangement: go.TreeArrangement.Horizontal
}),
'undoManager.isEnabled': true,
// When a Node is deleted by the user, also delete all of its Comment Nodes.
// When a Comment Link is deleted, also delete the corresponding Comment Node.
SelectionDeleting: e => {
var parts = e.subject; // the collection of Parts to be deleted, the Diagram.selection
// iterate over a copy of this collection,
// because we may add to the collection by selecting more Parts
parts.copy().each(p => {
if (p instanceof go.Node) {
var node = p;
node.findNodesConnected().each(n => {
// remove every Comment Node that is connected with this node
if (n.category === 'Comment') {
n.isSelected = true; // include in normal deletion process
}
});
} else if (p instanceof go.Link && p.category === 'Comment') {
var comlink = p; // a "Comment" Link
var comnode = comlink.fromNode;
// remove the Comment Node that is associated with this Comment Link,
if (comnode.category === 'Comment') {
comnode.isSelected = true; // include in normal deletion process
}
}
});
}
});
myDiagram.nodeTemplate =
new go.Node('Auto')
.add(
new go.Shape({ fill: 'white' })
.bind('fill', 'color'),
new go.TextBlock({ margin: 6 })
.bind('text')
);
myDiagram.linkTemplate =
new go.Link()
.add(
new go.Shape({ strokeWidth: 1.5 }),
new go.Shape({ toArrow: 'Standard', stroke: null })
);
myDiagram.nodeTemplateMap.add('Comment',
new go.Node({ background: 'transparent' })
.add( // this needs to act as a rectangular shape for BalloonLink,
// which can be accomplished by setting the background.
new go.TextBlock({ stroke: 'brown', margin: 3 })
.bind('text')
)
);
myDiagram.linkTemplateMap.add('Comment',
// if the BalloonLink class has been loaded from the Extensions directory, use it
new (typeof BalloonLink === 'function' ? BalloonLink : go.Link)()
.add(
new go.Shape( // the Shape.geometry will be computed to surround the comment node and
// point all the way to the commented node
{ stroke: 'brown', strokeWidth: 1, fill: 'lightyellow' })
)
);
myDiagram.model = new go.GraphLinksModel({
nodeDataArray: [
{ key: 1, text: 'Alpha', color: 'orange' },
{ key: 2, text: 'Beta', color: 'lightgreen' },
{ key: 3, text: 'Gamma', color: 'lightgreen' },
{ key: 4, text: 'Delta', color: 'pink' },
{ key: -1, text: 'comment\nabout Alpha', category: 'Comment' },
{ key: -2, text: 'comment\nabout Beta', category: 'Comment' },
{ key: -3, text: 'comment\nabout Gamma', category: 'Comment' }
],
linkDataArray: [
{ from: 1, to: 2 },
{ from: 1, to: 3 },
{ from: 1, to: 4 },
{ from: -1, to: 1, category: 'Comment' },
{ from: -2, to: 2, category: 'Comment' },
{ from: -3, to: 3, category: 'Comment' }
]
});
// show the model in JSON format
document.getElementById('savedModel').innerHTML = `<code>${myDiagram.model.toJson()}</code>`;
if (window.Prism) window.Prism.highlightAll();
}
window.addEventListener('DOMContentLoaded', init);
</script>
<div id="sample">
<div id="myDiagramDiv" style="border: solid 1px black; width: 100%; height: 400px"></div>
<p>
<b>GoJS</b> supports the notion of "Comment"s. A "Comment" is a node that is linked with another
node but is positioned by some layouts to go along with that other node, rather than be laid out
like a regular node and link.
</p>
<p>
In this sample there are three "Comment" nodes, connected with regular nodes by three "Comment"
links. Node and link data are marked as "Comment"s by specifying "Comment" as the category. But
the "Comment" nodes and links have a different default template, and thus a different
appearance, than regular nodes and links. You can specify your own templates for "Comment" nodes
and "Comment" links. The "Comment" link template defined here uses the
<code>BalloonLink</code> class defined in
<a href="../extensions/BalloonLink.js">BalloonLink.js</a> in the Extensions directory.
</p>
<div style="display: inline">
Initial Diagram.model saved in JSON format:<br />
<pre id="savedModel" class="lang-js"></pre>
</div>
</div>
</div>
<!-- * * * * * * * * * * * * * -->
<!-- End of GoJS sample code -->
</div>
<div id="allTagDescriptions" class="p-4 w-full max-w-screen-xl mx-auto">
<hr/>
<h3 class="text-xl">GoJS Features in this sample</h3>
<!-- blacklist tags that do not correspond to a specific GoJS feature -->
<h4>Links</h4>
<p>
The <a href="../api/symbols/Link.html" target="api">Link</a> class is used to implement a visual relationship between nodes.
Links are normally created by the presence of link data objects in the <a href="../api/symbols/GraphLinksModel.html#linkDataArray" target="api">GraphLinksModel.linkDataArray</a>
or by a parent key reference as the value of the <a href="../api/symbols/TreeModel.html#nodeParentKeyProperty" target="api">TreeModel.nodeParentKeyProperty</a> of a node data object
in a <a href="../api/symbols/TreeModel.html" target="api">TreeModel</a>.
More information can be found in the <a href="../intro/links.html">GoJS Intro</a>.
</p>
<p>
<a href="../samples/index.html#links">Related samples</a>
</p>
<hr>
<!-- blacklist tags that do not correspond to a specific GoJS feature -->
<h4>Tree Layout</h4>
<p>
This predefined layout is used for placing Nodes of a tree-structured graph in layers (rows or columns).
For discussion and examples of the most commonly used properties of the <a href="../api/symbols/TreeLayout.html">TreeLayout</a>,
see the <a href="../intro/trees.html">Trees</a> page in the Introduction.
More information can be found in the <a href="../intro/layouts.html#TreeLayout">GoJS Intro</a>.
</p>
<p>
<a href="../samples/index.html#treelayout">Related samples</a>
</p>
<hr>
<!-- blacklist tags that do not correspond to a specific GoJS feature -->
<h4>Geometry Path Strings</h4>
<p>
The <b>GoJS</b> <a href="../api/symbols/Geometry.html" target="api">Geometry</a> class controls the "shape" of a <a href="../api/symbols/Shape.html" target="api">Shape</a>,
whereas the <a href="../api/symbols/Shape.html#fill" target="api">Shape.fill</a> and <a href="../api/symbols/Shape.html#stroke" target="api">Shape.stroke</a> and other shape properties control the colors and appearance of the shape.
For common shape figures, there are predefined geometries that can be used by setting <a href="../api/symbols/Shape.html#figure" target="api">Shape.figure</a>.
However one can also define custom geometries.
</p>
<p>
One can construct any Geometry by allocating and initializing a <a href="../api/symbols/Geometry.html" target="api">Geometry</a> of at least one <a href="../api/symbols/PathFigure.html" target="api">PathFigure</a> holding some <a href="../api/symbols/PathSegment.html" target="api">PathSegment</a>s.
But you may find that using the string representation of a Geometry is easier to write and save in a database.
Use the static method <a href="../api/symbols/Geometry.html#parse" target="api">Geometry.parse</a> or the <a href="../api/symbols/Shape.html#geometryString" target="api">Shape.geometryString</a> property to transform a geometry path string into a <a href="../api/symbols/Geometry.html" target="api">Geometry</a> object.
</p>
<p>
More information can be found in the <a href="../intro/geometry.html">GoJS Intro</a>.
</p>
<p>
<a href="../samples/index.html#geometries">Related samples</a>
</p>
<hr>
</div>
</div>
</body>
<!-- This script is part of the gojs.net website, and is not needed to run the sample -->
<script src="../assets/js/goSamples.js"></script>
</html>