UNPKG

16 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3 <head>
4<meta charset="utf-8"/>
5<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, viewport-fit=cover"/>
6
7<link rel="stylesheet" href="../assets/css/style.css"/>
8<!-- Copyright 1998-2021 by Northwoods Software Corporation. --> <title> GoJS in Node.js -- Northwoods Software </title>
9 <link rel="stylesheet" href="../assets/css/prism.css" />
10 </head>
11 <script>
12
13 window.diagrams = [];
14 window.goCode = function(pre, w, h, parentid, animation) {
15 window.diagrams.push([pre, w, h, parentid, animation]);
16 }
17 </script>
18 <body>
19 <nav id="navTop" class="w-full z-30 top-0 text-white bg-nwoods-primary">
20 <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">
21 <div class="md:pl-4">
22 <a class="text-white hover:text-white no-underline hover:no-underline
23 font-bold text-2xl lg:text-4xl rounded-lg hover:bg-nwoods-secondary " href="../">
24 <h1 class="mb-0 p-1 ">GoJS</h1>
25 </a>
26 </div>
27 <button id="topnavButton" class="rounded-lg sm:hidden focus:outline-none focus:ring" aria-label="Navigation">
28 <svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6">
29 <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>
30 <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>
31 </svg>
32 </button>
33 <div id="topnavList" class="hidden sm:block items-center w-auto mt-0 text-white p-0 z-20">
34 <ul class="list-reset list-none font-semibold flex justify-end flex-wrap sm:flex-nowrap items-center px-0 pb-0">
35 <li class="p-1 sm:p-0"><a class="topnav-link" href="../learn/">Learn</a></li>
36 <li class="p-1 sm:p-0"><a class="topnav-link" href="../samples/">Samples</a></li>
37 <li class="p-1 sm:p-0"><a class="topnav-link" href="../intro/">Intro</a></li>
38 <li class="p-1 sm:p-0"><a class="topnav-link" href="../api/">API</a></li>
39 <li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/products/register.html">Register</a></li>
40 <li class="p-1 sm:p-0"><a class="topnav-link" href="../download.html">Download</a></li>
41 <li class="p-1 sm:p-0"><a class="topnav-link" href="https://forum.nwoods.com/c/gojs/11">Forum</a></li>
42 <li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/contact.html"
43 target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/contact.html', 'contact');">Contact</a></li>
44 <li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/sales/index.html"
45 target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');">Buy</a></li>
46 </ul>
47 </div>
48 </div>
49 <hr class="border-b border-gray-600 opacity-50 my-0 py-0" />
50 </nav>
51
52 <div class="md:flex flex-col md:flex-row md:min-h-screen w-full max-w-screen-xl mx-auto">
53
54 <div id="navSide" class="flex flex-col w-full md:w-40 lg:w-48 text-gray-700 bg-white flex-shrink-0">
55 <div class="flex-shrink-0 px-8 py-4">
56 <button id="navButton" class="rounded-lg md:hidden focus:outline-none focus:ring" aria-label="Navigation">
57 <svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6">
58 <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>
59 <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>
60 </svg>
61 </button>
62 </div>
63 <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">
64 <a href="index.html">Basics</a>
65 <a href="buildingObjects.html">Building Parts</a>
66 <a href="usingModels.html">Using Models</a>
67 <a href="dataBinding.html">Data Binding</a>
68 <a href="react.html">GoJS with React</a>
69 <a href="angular.html">GoJS with Angular</a>
70 <a href="textBlocks.html">TextBlocks</a>
71 <a href="shapes.html">Shapes</a>
72 <a href="pictures.html">Pictures</a>
73 <a href="panels.html">Panels</a>
74 <a href="tablePanels.html">Table Panels</a>
75 <a href="brush.html">Brushes</a>
76 <a href="sizing.html">Sizing Objects</a>
77 <a href="itemArrays.html">Item Arrays</a>
78 <a href="changedEvents.html">Changed Events</a>
79 <a href="transactions.html">Transactions</a>
80 <a href="viewport.html">Coordinates</a>
81 <a href="initialView.html">Initial View</a>
82 <a href="collections.html">Collections</a>
83 <a href="links.html">Links</a>
84 <a href="linkLabels.html">Link Labels</a>
85 <a href="connectionPoints.html">Link Points</a>
86 <a href="ports.html">Ports</a>
87 <a href="nodes.html">Nodes</a>
88 <a href="debugging.html">Debugging</a>
89 <a href="layouts.html">Layouts</a>
90 <a href="trees.html">Trees</a>
91 <a href="subtrees.html">SubTrees</a>
92 <a href="groups.html">Groups</a>
93 <a href="subgraphs.html">SubGraphs</a>
94 <a href="sizedGroups.html">Sized Groups</a>
95 <a href="selection.html">Selection</a>
96 <a href="highlighting.html">Highlighting</a>
97 <a href="animation.html">Animation</a>
98 <a href="toolTips.html">ToolTips</a>
99 <a href="contextmenus.html">Context Menus</a>
100 <a href="events.html">Diagram Events</a>
101 <a href="tools.html">Tools</a>
102 <a href="commands.html">Commands</a>
103 <a href="permissions.html">Permissions</a>
104 <a href="validation.html">Validation</a>
105 <a href="HTMLInteraction.html">HTML Interaction</a>
106 <a href="layers.html">Layers &amp; Z-ordering</a>
107 <a href="palette.html">Palette</a>
108 <a href="overview.html">Overview</a>
109 <a href="resizing.html">Resizing Diagrams</a>
110 <a href="replacingDeleting.html">Replacing and Deleting</a>
111 <a href="buttons.html">Buttons</a>
112 <a href="templateMaps.html">Template Maps</a>
113 <a href="legends.html">Legends and Titles</a>
114 <a href="extensions.html">Extensions</a>
115 <a href="geometry.html">Geometry Strings</a>
116 <a href="grids.html">Grid Patterns</a>
117 <a href="graduatedPanels.html">Graduated Panels</a>
118 <a href="makingImages.html">Diagram Images</a>
119 <a href="makingSVG.html">Diagram SVG</a>
120 <a href="printing.html">Printing</a>
121 <a href="serverSideImages.html">Server-side Images</a>
122 <a href="nodeScript.html">GoJS in Node.js</a>
123 <a href="testing.html">Testing</a>
124 <a href="storage.html">Storage</a>
125 <a href="performance.html">Performance</a>
126 <a href="source.html">Building from Source</a>
127 <a href="platforms.html">Platforms</a>
128 <a href="deployment.html">Deployment</a>
129 </nav>
130 </div>
131 <div class="pt-4 px-2 md:px-0 lg:px-4 pb-16 w-full overflow-hidden">
132
133
134
135<div id="container" class="container-fluid">
136 <div id="content">
137 <h1>Using GoJS with Node.js</h1>
138
139 <p>
140 As of 2.0, GoJS can be used in DOM-less contexts like Node.js. However there are some considerations:
141 <ul>
142 <li>
143 Since there is no Diagram DIV, you must instead set the <a>Diagram.viewSize</a> property.
144 This affects all the same values as the DIV size, like Diagram.position and layout results from layouts that are viewport-sized.
145 </li>
146 <li>Cannot measure go.Pictures, you must set a <a>GraphObject.desiredSize</a> instead.</li>
147 <li>Cannot measure go.TextBlocks accurately, you should set a <a>GraphObject.desiredSize</a> instead.</li></li>
148 </ul>
149 </p>
150
151 <p>
152 For server-side operations that need to measure Pictures or TextBlocks, you should consider using a headless browser with Node.
153 <a href="serverSideImages.html">Click here for examples using Node with Puppeteer (headless Chrome)</a>.
154 </p>
155
156 <h2 id="NodeJSExample">Node.js example</h2>
157
158 <p>
159 If you saved the following JavaScript as <code>nodescript.js</code> and run it with node (<code>node nodescript.js</code>),
160 it will output Model JSON results in the console, which include the locations of laid-out Nodes. You can use Node.js
161 in this way to do server-side operations like large layouts, and then send the JSON to the client.
162 </p>
163
164<pre class="lang-js"><code>
165// nodescript.js
166// This example loads the GoJS library, creates a Diagram with a layout and prints the JSON results.
167
168// Load GoJS. This assumes using require and CommonJS:
169const go = require("gojs");
170
171const $ = go.GraphObject.make; // for conciseness in defining templates
172
173const myDiagram =
174 $(go.Diagram, '', // No DOM, so there can be no DIV!
175 {
176 viewSize: new go.Size(400,400), // Set this property in DOM-less environments
177 layout: $(go.LayeredDigraphLayout)
178 });
179
180myDiagram.nodeTemplate =
181 $(go.Node, 'Auto',
182 // specify the size of the node rather than measuring the size of the text
183 { width: 80, height: 40 },
184 // automatically save the Node.location to the node's data object
185 new go.Binding('location', 'loc', go.Point.parse).makeTwoWay(go.Point.stringify),
186 $(go.Shape, 'RoundedRectangle', { strokeWidth: 0},
187 new go.Binding('fill', 'color')),
188 $(go.TextBlock,
189 new go.Binding('text', 'key'))
190 );
191
192// After the layout, output results:
193myDiagram.addDiagramListener('InitialLayoutCompleted', function() {
194 console.log(myDiagram.model.toJson());
195});
196
197// load a model:
198myDiagram.model = new go.GraphLinksModel(
199[
200 { key: 'Alpha', color: 'lightblue' },
201 { key: 'Beta', color: 'orange' },
202 { key: 'Gamma', color: 'lightgreen' },
203 { key: 'Delta', color: 'pink' }
204],
205[
206 { from: 'Alpha', to: 'Beta' },
207 { from: 'Alpha', to: 'Gamma' },
208 { from: 'Gamma', to: 'Delta' },
209 { from: 'Delta', to: 'Alpha' }
210]);
211</code></pre>
212
213<p>
214 Alternatively, if your code is saved as <code>nodescript.mjs</code> or your project is of <code>"type": "module"</code>,
215 you can use GoJS as an ES6 module:
216</p>
217<pre class="lang-js"><code>
218// nodescript.mjs
219// This example loads the GoJS library, creates a Diagram with a layout and prints the JSON results.
220
221// Load GoJS. This assumes using import and ES6 modules:
222import * as go from "gojs/release/go.mjs";
223
224const $ = go.GraphObject.make;
225. . .
226</code></pre>
227 </div>
228 </div>
229
230 <div class="bg-nwoods-primary">
231 <section class="max-w-screen-lg text-white container mx-auto py-2 px-12">
232 <p id="version" class="leading-none mb-2 my-4">GoJS</p>
233 </section>
234 </div><footer class="bg-nwoods-primary text-white">
235 <div class="container max-w-screen-lg mx-auto px-8">
236 <div class="w-full py-6">
237
238 <div class="max-w-screen-lg xl:max-w-screen-xl mx-auto px-4 sm:px-6 md:px-8">
239 <ul class="text-sm font-medium pb-14 sm:pb-20 grid grid-cols-1 sm:grid-cols-3 gap-y-10">
240 <li class="list-none row-span-2">
241 <h2 class="text-base font-semibold tracking-wide">GoJS</h2>
242 <ul class="list-none space-y-4 md:space-y-1 px-0">
243 <li>
244 <a href="../samples/index.html">Samples</a>
245 </li>
246 <li>
247 <a href="../learn/index.html">Learn</a>
248 </li>
249 <li>
250 <a href="../intro/index.html">Intro</a>
251 </li>
252 <li>
253 <a href="../api/index.html">API</a>
254 </li>
255 <li>
256 <a href="../changelog.html">Changelog</a>
257 </li>
258 <li>
259 <a href="https://github.com/NorthwoodsSoftware/GoJS">GitHub</a>
260 </li>
261 </ul>
262 </li>
263 <li class="list-none row-span-2">
264 <h2 class="text-base font-semibold tracking-wide">Support</h2>
265 <ul class="list-none space-y-4 md:space-y-1 px-0">
266 <li>
267 <a href="https://www.nwoods.com/contact.html"
268 target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/contact.html', 'contact');">Contact</a>
269 </li>
270 <li>
271 <a href="https://forum.nwoods.com/c/gojs">Forum</a>
272 </li>
273 <li>
274 <a href="https://www.nwoods.com/app/activate.aspx?sku=gojs">Activate</a>
275 </li>
276 <li>
277 <a href="https://www.nwoods.com/sales/index.html"
278 target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');">Buy</a>
279 </li>
280 <li>
281 <a href="https://www.youtube.com/channel/UC9We8EoX596-6XFjJDtZIDg">Videos</a>
282 </li>
283 </ul>
284 </li>
285 <li class="list-none row-span-2">
286 <h2 class="text-base font-semibold tracking-wide">Company</h2>
287 <ul class="list-none space-y-4 md:space-y-1 px-0">
288 <li>
289 <a href="https://www.nwoods.com">Northwoods</a>
290 </li>
291 <li>
292 <a href="https://www.nwoods.com/about.html">About Us</a>
293 </li>
294 <li>
295 <a href="https://www.nwoods.com/contact.html">Contact Us</a>
296 </li>
297 <li>
298 <a href="https://twitter.com/northwoodsgo">Twitter</a>
299 </li>
300
301 </ul>
302 </li>
303 </ul>
304
305
306 <p class="text-sm text-gray-100 md:mb-6">
307 Copyright 1998-2021 <a class="text-white" href="https://www.nwoods.com">Northwoods Software</a>
308 </p>
309 </div>
310 </div>
311</footer> </body>
312
313<script async src="https://www.googletagmanager.com/gtag/js?id=UA-1506307-5"></script>
314<script>
315 window.dataLayer = window.dataLayer || [];
316 function gtag(){dataLayer.push(arguments);}
317 gtag('js', new Date()); gtag('config', 'UA-1506307-5');
318 var getOutboundLink = function(url, label) {
319 gtag('event', 'click', {
320 'event_category': 'outbound',
321 'event_label': label,
322 'transport_type': 'beacon'
323 });
324 }
325
326 // topnav
327 var topButton = document.getElementById("topnavButton");
328 var topnavList = document.getElementById("topnavList");
329 topButton.addEventListener("click", function() {
330 this.classList.toggle("active");
331 topnavList.classList.toggle("hidden");
332 document.getElementById("topnavOpen").classList.toggle("hidden");
333 document.getElementById("topnavClosed").classList.toggle("hidden");
334 });
335</script>
336 <script src="../assets/js/prism.js"></script>
337 <script src="../release/go.js"></script>
338 <script src="../assets/js/goDoc.js"></script>
339 <script>
340 document.addEventListener("DOMContentLoaded", function() {
341 if (window.go) document.getElementById('version').textContent = "GoJS version " + go.version;
342 if (window.goDoc) window.goDoc();
343 var d = window.diagrams;
344 for (var i = 0; i < d.length; i++) {
345 var dargs = d[i];
346 goCodeExecute(dargs[0], dargs[1], dargs[2], dargs[3], dargs[4]);
347 }
348 if (window.extra) window.extra();
349 });
350 </script>
351</html>