create-gojs-kit
Version:
A CLI for downloading GoJS samples, extensions, and docs
340 lines (304 loc) • 14 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 traditional tree view using TreeLayout and orthogonal links." />
<meta itemprop="description" content="A traditional tree view using TreeLayout and orthogonal links." />
<meta property="og:description" content="A traditional tree view using TreeLayout and orthogonal links." />
<meta name="twitter:description" content="A traditional tree view using TreeLayout and orthogonal links." />
<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="Tree View Implemented with TreeLayout of Nodes and Links" />
<meta property="og:title" content="Tree View Implemented with TreeLayout of Nodes and Links" />
<meta name="twitter:title" content="Tree View Implemented with TreeLayout of Nodes and Links" />
<meta property="og:image" content="https://gojs.net/latest/assets/images/screenshots/treeview.png" />
<meta itemprop="image" content="https://gojs.net/latest/assets/images/screenshots/treeview.png" />
<meta name="twitter:image" content="https://gojs.net/latest/assets/images/screenshots/treeview.png" />
<meta property="og:url" content="https://gojs.net/latest/samples/treeView.html" />
<meta property="twitter:url" content="https://gojs.net/latest/samples/treeView.html" />
<meta name="twitter:card" content="summary_large_image" />
<meta property="og:type" content="website" />
<meta property="twitter:domain" content="gojs.net" />
<title>
Tree View Implemented with TreeLayout of Nodes and Links | 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>
<div id="allSampleContent" class="p-4 w-full">
<script id="code">
function init() {
myDiagram = new go.Diagram('myDiagramDiv', {
allowMove: false,
allowCopy: false,
allowDelete: false,
allowHorizontalScroll: false,
layout: new go.TreeLayout({
alignment: go.TreeAlignment.Start,
angle: 0,
compaction: go.TreeCompaction.None,
layerSpacing: 16,
layerSpacingParentOverlap: 1,
nodeIndentPastParent: 1.0,
nodeSpacing: 0,
setsPortSpot: false,
setsChildPortSpot: false
})
});
myDiagram.nodeTemplate =
new go.Node({
// no Adornment: instead change panel background color by binding to Node.isSelected
selectionAdorned: false,
// a custom function to allow expanding/collapsing on double-click
// this uses similar logic to a TreeExpanderButton
doubleClick: (e, node) => {
var cmd = myDiagram.commandHandler;
if (node.isTreeExpanded) {
if (!cmd.canCollapseTree(node)) return;
} else {
if (!cmd.canExpandTree(node)) return;
}
e.handled = true;
if (node.isTreeExpanded) {
cmd.collapseTree(node);
} else {
cmd.expandTree(node);
}
}
})
.add(
go.GraphObject.build('TreeExpanderButton', {
// customize the button's appearance
_treeExpandedFigure: 'LineDown',
_treeCollapsedFigure: 'LineRight',
'ButtonBorder.fill': 'whitesmoke',
'ButtonBorder.stroke': null,
_buttonFillOver: 'rgba(0,128,255,0.25)',
_buttonStrokeOver: null
}),
new go.Panel('Horizontal', { position: new go.Point(18, 0) })
.bindObject('background', 'isSelected', s => (s ? 'lightblue' : 'white'))
.add(
new go.Picture({
width: 18,
height: 18,
margin: new go.Margin(0, 4, 0, 0),
imageStretch: go.ImageStretch.Uniform
})
// bind the picture source on two properties of the Node
// to display open folder, closed folder, or document
.bindObject('source', 'isTreeExpanded', imageConverter)
.bindObject('source', 'isTreeLeaf', imageConverter)
)
.add(
new go.TextBlock({ font: '9pt Verdana, sans-serif' })
.bind('text', 'key', s => 'item ' + s)
)
);
// without lines
myDiagram.linkTemplate = new go.Link();
// with lines
// myDiagram.linkTemplate =
// new go.Link({
// selectable: false,
// routing: go.Routing.Orthogonal,
// fromEndSegmentLength: 4,
// toEndSegmentLength: 4,
// fromSpot: new go.Spot(0.001, 1, 7, 0),
// toSpot: go.Spot.Left }
// )
// .add(
// new go.Shape({ stroke: 'gray', strokeDashArray: [1,2] })
// );
// create a random tree
var nodeDataArray = [{ key: 0 }];
var max = 499;
var count = 0;
while (count < max) {
count = makeTree(3, count, max, nodeDataArray, nodeDataArray[0]);
}
myDiagram.model = new go.TreeModel(nodeDataArray);
}
function makeTree(level, count, max, nodeDataArray, parentdata) {
var numchildren = Math.floor(Math.random() * 10);
for (var i = 0; i < numchildren; i++) {
if (count >= max) return count;
count++;
var childdata = { key: count, parent: parentdata.key };
nodeDataArray.push(childdata);
if (level > 0 && Math.random() > 0.5) {
count = makeTree(level - 1, count, max, nodeDataArray, childdata);
}
}
return count;
}
// takes a property change on either isTreeLeaf or isTreeExpanded and selects the correct image to use
function imageConverter(prop, picture) {
var node = picture.part;
if (node.isTreeLeaf) {
return 'images/document.svg';
} else {
if (node.isTreeExpanded) {
return 'images/openFolder.svg';
} else {
return 'images/closedFolder.svg';
}
}
}
window.addEventListener('DOMContentLoaded', init);
</script>
<div id="sample">
<div id="myDiagramDiv" style="border: 1px solid black; width: 300px; height: 500px"></div>
<p>
This shows how to create a traditional "TreeView" in a <b>GoJS</b> diagram. There are 500 nodes
in the tree.
</p>
<p>Look at this page's source code to see how the properties on the <a>TreeLayout</a> are set.</p>
<p>
The node template makes use of a "TreeExpanderButton" panel to implement the expand/collapse
button. It also implements a custom doubleClick function to allow nodes to be expanded/collapsed
on double-click. Lastly, the source of the picture on each node is bound to two different
properties,
<a>Node.isTreeLeaf</a> and <a>Node.isTreeExpanded</a>; the <b>imageConverter</b> function is
used to select the correct image based on these properties.
</p>
<p>
There are two link templates in the source code, one which uses no lines, and one which connects
the items with dotted lines.
</p>
<p>
See the <a href="../intro/buttons.html" target="_blank">Intro page on Buttons</a> for more GoJS
button information. The
<a href="triStateCheckBoxTree.html" target="_blank">Tri-state CheckBox Tree</a> sample
demonstrates a "tree view" where each item has a three-state checkbox. The
<a href="treeMapper.html" target="_blank">Tree Mapper</a> sample demonstrates how to map (draw
associations) between items in two trees. The
<a href="updateDemo.html" target="_blank">Update Demo</a> sample also uses a "tree view" for its
own purposes.
</p>
<p>
The icons in this sample are from <a href="https://icons8.com/" target="blank">icons8.com</a>
</p>
</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>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>Buttons</h4>
<p>
GoJS defines several <a href="../api/symbols/Panel.html" target="api">Panel</a>s for common uses.
These include "Button", "TreeExpanderButton", "SubGraphExpanderButton", "PanelExpanderButton", "ContextMenuButton", and "CheckBoxButton".
"ContextMenuButton"s are typically used inside of "ContextMenu" Panels;
"CheckBoxButton"s are used in the implementation of "CheckBox" Panels.
</p>
<p>
These predefined panels can be used as if they were <a href="../api/symbols/Panel.html" target="api">Panel</a>-derived classes in calls to <a href="../api/symbols/GraphObject.html#build" target="api">GraphObject.build</a>.
They are implemented as simple visual trees of <a href="../api/symbols/GraphObject.html" target="api">GraphObject</a>s in <a href="../api/symbols/Panel.html" target="api">Panel</a>s,
with pre-set properties and event handlers.
</p>
<p>
More information can be found in the <a href="../intro/buttons.html">GoJS Intro</a>.
</p>
<p>
<a href="../samples/index.html#buttons">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>