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 | <title> GoJS with ES6 Modules -- 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 & 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 |
|
138 | <h1>GoJS and ES6 Modules</h1>
|
139 | <p>
|
140 | The GoJS installation contains the GoJS library as an ES6 module,
|
141 | extensions as ES6 modules, and examples of using GoJS with ES6 modules.
|
142 | </p>
|
143 |
|
144 |
|
145 | <h2 id="GoJSDirectly">Using GoJS as an ES6 module</h2>
|
146 |
|
147 | <p>
|
148 | The GoJS library file "go.js" does not use the <code>export</code> keyword,
|
149 | for compatibility with all JavaScript environments.
|
150 | So we have had to provide different libraries that are ES6 modules.
|
151 | In the <code>release</code> folder, they are the <code>go-module.js</code> and <code>go-debug-module.js</code> files.
|
152 | In addition, there is an ES6 module-specific TypeScript definition file: <code>go-module.d.ts</code>.
|
153 | </p>
|
154 | <p>
|
155 | In the <code>extensionsJSM</code> directory, all of the samples use ES6 modules.
|
156 | Each of the JavaScript or TypeScript files imports the GoJS library this way:
|
157 | </p>
|
158 | <pre class="lang-ts"> <code>import * as go from '../release/go-module.js';</code></pre>
|
159 |
|
160 | <p>In order to load GoJS and other ES6 modules, the HTML page also must use the <code>type="module"</code> script tag:</p>
|
161 | <pre class="lang-html"><code> <script type="module">
|
162 | import * as go from "../release/go-module.js";
|
163 | . . .
|
164 | </script>
|
165 | </code></pre>
|
166 |
|
167 | <p>
|
168 | Most browsers will not display resources with <code><script type="module"></code> if they are served from a local file system,
|
169 | so you will need to open an HTML page using modules from a web server to see the results on localhost:.
|
170 | </p>
|
171 |
|
172 | <h3 id="UsingExtensionModules">Using Extension Modules</h3>
|
173 | <p>
|
174 | Another example, this time using an extension:
|
175 | </p>
|
176 | <pre class="lang-html"><code> <script type="module">
|
177 | import * as go from "../release/go-module.js";
|
178 | import { LinkLabelDraggingTool } from '../extensionsJSM/LinkLabelDraggingTool.js';
|
179 |
|
180 | const $ = go.GraphObject.make;
|
181 |
|
182 | const myDiagram =
|
183 | $(go.Diagram, 'myDiagramDiv', . . .);
|
184 |
|
185 | // install the LinkLabelDraggingTool as a "mouse move" tool
|
186 | myDiagram.toolManager.mouseMoveTools.insertAt(0, new LinkLabelDraggingTool());
|
187 |
|
188 | . . .
|
189 | </script></code></pre>
|
190 |
|
191 | <p>
|
192 | Note that all those modules the depend on GoJS must import exactly the same library file,
|
193 | in this case "../release/go-module.js".
|
194 | Any inconsistencies will cause the GoJS library to be loaded multiple times,
|
195 | which can cause subtle errors and thus results in the library signaling error.
|
196 | </p>
|
197 | <p>
|
198 | We recommend that you copy the extension file(s) that you want to use into your own project so that you can be sure that
|
199 | all of the <code>import</code> statements import the same GoJS library.
|
200 | The extensions are all in TypeScript and were all compiled with this <code>tsconfg.json</code> file:
|
201 | </p>
|
202 | <pre class="lang-json"><code>{
|
203 | "compilerOptions": {
|
204 | "target": "es6",
|
205 | "strict": true
|
206 | }
|
207 | }</code></pre>
|
208 |
|
209 |
|
210 | <h2 id="GoJSRequireJS">GoJS with <code>RequireJS</code></h2>
|
211 | <p>
|
212 | Both the <code>go.js</code> library and the <code>go-debug.js</code> library can be loaded via <a href="https://requirejs.org/">RequireJS</a>.
|
213 | </p>
|
214 | <p>
|
215 | The <code>extensionsTS</code> directory contains all of the extension classes from the
|
216 | <code>extensions</code> directory, but in TypeScript and pre-compiled as UMD modules.
|
217 | This is reflected in that directory's <code>tsconfig.json</code>:
|
218 | </p>
|
219 | <pre class="lang-json"><code>{
|
220 | "compilerOptions": {
|
221 | "module": "umd",
|
222 | "target": "es5",
|
223 | "strict": true
|
224 | }
|
225 | }</code></pre>
|
226 | <p>
|
227 | The generated JavaScript can then be loaded as UMD modules via <code>require</code>.
|
228 | </p>
|
229 | <pre class="lang-html"><code> <script src="../samples/assets/require.js"></script>
|
230 | <script id="code">
|
231 | function init() {
|
232 | require(["CheckBoxesScript"], function (app) {
|
233 | app.init();
|
234 | });
|
235 | }
|
236 | </script></code></pre>
|
237 |
|
238 | </div >
|
239 |
|
240 | </div>
|
241 | </div>
|
242 |
|
243 | <div class="bg-nwoods-primary">
|
244 | <section class="max-w-screen-lg text-white container mx-auto py-2 px-12">
|
245 | <p id="version" class="leading-none mb-2 my-4">GoJS</p>
|
246 | </section>
|
247 | </div><footer class="bg-nwoods-primary text-white">
|
248 | <div class="container max-w-screen-lg mx-auto px-8">
|
249 | <div class="w-full py-6">
|
250 |
|
251 | <div class="max-w-screen-lg xl:max-w-screen-xl mx-auto px-4 sm:px-6 md:px-8">
|
252 | <ul class="text-sm font-medium pb-14 sm:pb-20 grid grid-cols-1 sm:grid-cols-3 gap-y-10">
|
253 | <li class="list-none row-span-2">
|
254 | <h2 class="text-base font-semibold tracking-wide">GoJS</h2>
|
255 | <ul class="list-none space-y-4 md:space-y-1 px-0">
|
256 | <li>
|
257 | <a href="../samples/index.html">Samples</a>
|
258 | </li>
|
259 | <li>
|
260 | <a href="../learn/index.html">Learn</a>
|
261 | </li>
|
262 | <li>
|
263 | <a href="../intro/index.html">Intro</a>
|
264 | </li>
|
265 | <li>
|
266 | <a href="../api/index.html">API</a>
|
267 | </li>
|
268 | <li>
|
269 | <a href="../changelog.html">Changelog</a>
|
270 | </li>
|
271 | <li>
|
272 | <a href="https://github.com/NorthwoodsSoftware/GoJS">GitHub</a>
|
273 | </li>
|
274 | </ul>
|
275 | </li>
|
276 | <li class="list-none row-span-2">
|
277 | <h2 class="text-base font-semibold tracking-wide">Support</h2>
|
278 | <ul class="list-none space-y-4 md:space-y-1 px-0">
|
279 | <li>
|
280 | <a href="https://www.nwoods.com/contact.html"
|
281 | target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/contact.html', 'contact');">Contact</a>
|
282 | </li>
|
283 | <li>
|
284 | <a href="https://forum.nwoods.com/c/gojs">Forum</a>
|
285 | </li>
|
286 | <li>
|
287 | <a href="https://www.nwoods.com/app/activate.aspx?sku=gojs">Activate</a>
|
288 | </li>
|
289 | <li>
|
290 | <a href="https://www.nwoods.com/sales/index.html"
|
291 | target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');">Buy</a>
|
292 | </li>
|
293 | <li>
|
294 | <a href="https://www.youtube.com/channel/UC9We8EoX596-6XFjJDtZIDg">Videos</a>
|
295 | </li>
|
296 | </ul>
|
297 | </li>
|
298 | <li class="list-none row-span-2">
|
299 | <h2 class="text-base font-semibold tracking-wide">Company</h2>
|
300 | <ul class="list-none space-y-4 md:space-y-1 px-0">
|
301 | <li>
|
302 | <a href="https://www.nwoods.com">Northwoods</a>
|
303 | </li>
|
304 | <li>
|
305 | <a href="https://www.nwoods.com/about.html">About Us</a>
|
306 | </li>
|
307 | <li>
|
308 | <a href="https://www.nwoods.com/contact.html">Contact Us</a>
|
309 | </li>
|
310 | <li>
|
311 | <a href="https://twitter.com/northwoodsgo">Twitter</a>
|
312 | </li>
|
313 |
|
314 | </ul>
|
315 | </li>
|
316 | </ul>
|
317 |
|
318 |
|
319 | <p class="text-sm text-gray-100 md:mb-6">
|
320 | Copyright 1998-2021 <a class="text-white" href="https://www.nwoods.com">Northwoods Software</a>
|
321 | </p>
|
322 | </div>
|
323 | </div>
|
324 | </footer> </body>
|
325 |
|
326 | <script async src="https://www.googletagmanager.com/gtag/js?id=UA-1506307-5"></script>
|
327 | <script>
|
328 | window.dataLayer = window.dataLayer || [];
|
329 | function gtag(){dataLayer.push(arguments);}
|
330 | gtag('js', new Date()); gtag('config', 'UA-1506307-5');
|
331 | var getOutboundLink = function(url, label) {
|
332 | gtag('event', 'click', {
|
333 | 'event_category': 'outbound',
|
334 | 'event_label': label,
|
335 | 'transport_type': 'beacon'
|
336 | });
|
337 | }
|
338 |
|
339 |
|
340 | var topButton = document.getElementById("topnavButton");
|
341 | var topnavList = document.getElementById("topnavList");
|
342 | topButton.addEventListener("click", function() {
|
343 | this.classList.toggle("active");
|
344 | topnavList.classList.toggle("hidden");
|
345 | document.getElementById("topnavOpen").classList.toggle("hidden");
|
346 | document.getElementById("topnavClosed").classList.toggle("hidden");
|
347 | });
|
348 | </script>
|
349 | <script src="../assets/js/prism.js"></script>
|
350 | <script src="../release/go.js"></script>
|
351 | <script src="../assets/js/goDoc.js"></script>
|
352 | <script>
|
353 | document.addEventListener("DOMContentLoaded", function() {
|
354 | if (window.go) document.getElementById('version').textContent = "GoJS version " + go.version;
|
355 | if (window.goDoc) window.goDoc();
|
356 | var d = window.diagrams;
|
357 | for (var i = 0; i < d.length; i++) {
|
358 | var dargs = d[i];
|
359 | goCodeExecute(dargs[0], dargs[1], dargs[2], dargs[3], dargs[4]);
|
360 | }
|
361 | if (window.extra) window.extra();
|
362 | });
|
363 | </script>
|
364 | </html>
|