gojs

<!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="stylesheet" href="../assets/css/style.css"/>  <title> Extending GoJS -- Northwoods Software </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 z-30 top-0 text-white bg-nwoods-primary"> <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"> <div class="md:pl-4"> <a class="text-white hover:text-white no-underline hover:no-underline font-bold text-2xl lg:text-4xl rounded-lg hover:bg-nwoods-secondary " href="../"> <h1 class="mb-0 p-1 ">GoJS</h1> </a> </div> <button id="topnavButton" class="rounded-lg sm:hidden focus:outline-none focus:ring" aria-label="Navigation"> <svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6"> <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> <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> </svg> </button> <div id="topnavList" class="hidden sm:block items-center w-auto mt-0 text-white p-0 z-20"> <ul class="list-reset list-none font-semibold flex justify-end flex-wrap sm:flex-nowrap items-center px-0 pb-0"> <li class="p-1 sm:p-0"><a class="topnav-link" href="../learn/">Learn</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="../samples/">Samples</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="../intro/">Intro</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="../api/">API</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/products/register.html">Register</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="../download.html">Download</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="https://forum.nwoods.com/c/gojs/11">Forum</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/contact.html" target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/contact.html', 'contact');">Contact</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/sales/index.html" target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');">Buy</a></li> </ul> </div> </div> <hr class="border-b border-gray-600 opacity-50 my-0 py-0" /> </nav> <div class="md:flex flex-col md:flex-row md:min-h-screen w-full max-w-screen-xl mx-auto"> <div id="navSide" class="flex flex-col w-full md:w-40 lg:w-48 text-gray-700 bg-white flex-shrink-0"> <div class="flex-shrink-0 px-8 py-4"> <button id="navButton" class="rounded-lg md:hidden focus:outline-none focus:ring" aria-label="Navigation"> <svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6"> <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> <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> </svg> </button> </div> <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"> <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="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="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="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="resizing.html">Resizing Diagrams</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="makingImages.html">Diagram Images</a> <a href="makingSVG.html">Diagram SVG</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="storage.html">Storage</a> <a href="performance.html">Performance</a> <a href="source.html">Building from Source</a> <a href="platforms.html">Platforms</a> <a href="deployment.html">Deployment</a> </nav> </div> <div class="pt-4 px-2 md:px-0 lg:px-4 pb-16 w-full overflow-hidden"> <h1>Extending GoJS</h1> <p> <b>GoJS</b> can be extended in a variety of ways. The most common way to change the standard behavior is to set properties on the <a>GraphObject</a>, <a>Diagram</a>, <a>CommandHandler</a>, <a>Tool</a>, or <a>Layout</a>. But when no such properties exist, you might need to override methods of CommandHandler, Tool, Layout, Link, or Node. Methods that you can override are documented in the API reference. This page describes how to override methods, either by replacing a method on an instance (a feature of JavaScript) or by defining a subclass. You should not modify the prototypes of any of the <b>GoJS</b> classes. </p> <p class="box bg-danger"> Do not modify the prototypes of the <b>GoJS</b> classes.<br /> Only use the properties and methods documented in the <a href="../api/index.html">API</a>. </p> <p class="box bg-danger"> Note that the API for extension classes may change with any version, even point releases. If you intend to use an extension in production, you should copy the code to your own source directory. </p> <p class="box bg-info"> In addition to our samples, <b>GoJS</b> provides an <strong><a href="../extensions/">extensions gallery</a></strong>, showcasing the creation of custom tools and layouts. Those classes and samples have been translated into TypeScript, available at <code>../extensionsTS/</code>. Those extension classes are UMD modules; they use the <code>../release/go.js</code> library. The extension classes are also available as ES6 modules at <code>../extensionsJSM/</code>; these use the <code>../release/go-module.js</code> library. We recommend that you copy the files that you need into your project, so that you can adjust how they refer to the "go.js" library and so that you can include them into your own building and packaging procedures. </p> <h2 id="CommandHandler">Command Handler</h2> <p> Overriding the <a>CommandHandler</a> allows you to alter default functionality and create your own key bindings. See the <a href="commands.html">intro page on Commands</a> for more. However, the techniques shown below for overriding methods on Tools and Layouts also applies to the CommandHandler. </p> <h2 id="ToolsAndLayouts">Tools and Layouts</h2> <p> <b>GoJS</b> operates on nodes and links using many tools and layouts, all of which are subclasses of the <a>Tool</a> and <a>Layout</a> classes. See the <a href="tools.html">intro page on Tools</a> for more about Tools, and the <a href="layouts.html">intro page on Layouts</a> for more about Layouts. </p> <p> Tools can be modified, or they can be replaced in or added to the <a>Diagram.toolManager</a>. All tools must inherit from the <a>Tool</a> class or from a class that inherits from Tool. </p> <p class="box bg-info"> Some of our samples, such as the <a href="../samples/pipes.html">Pipes sample</a>, contain examples of custom tools. More custom tool examples are available in the <a href="../extensions/">extensions gallery</a>. TypeScript versions of those classes and samples are available in <code>../extensionsTS/</code>. Those custom tool classes are also available as ES6 modules in <code>../extensionsJSM/</code>. </p> <p> Layouts can be modified, or they can be used by setting <a>Diagram.layout</a> or <a>Group.layout</a>. All Layouts must inherit from the <a>Layout</a> class or a class that inherits from Layout. </p> <p class="box bg-info"> Some of our samples, such as the <a href="../samples/parseTree.html">Parse Tree sample</a>, contain examples of custom layouts. More custom layout examples are available in the <a href="../extensions/">extensions gallery</a>. TypeScript versions of those classes are available in <code>../extensionsTS/</code>. Those custom layout classes are also available as ES6 modules in <code>../extensionsJSM/</code>. </p> <h2 id="OverridingMethodWithoutDefiningSubclass">Overriding a Method Without Defining a Subclass</h2> <p> Often we can avoid subclassing a Tool in its entirety and merely override a single method. This is common when we want to make a small change to the behavior of a method. Here we show how to override the <code>ClickSelectingTool.standardMouseSelect</code> method by modifying the tool instance of a particular Diagram. </p> <p> One can override Layout methods in this manner also, but that is rarely done -- layouts are almost always subclassed. It cannot be done for layouts that are the value of <a>Group.layout</a> because those layouts may be copied and cannot be shared. </p> <p> Since we are not creating a new (sub)class, we set the method directly on the Diagram's <a>ClickSelectingTool</a>, which is referenced through its <a>ToolManager</a>. Typical scaffolding for overriding a method in such a manner is as follows: </p> <pre class="lang-js"><code> var tool = diagram.toolManager.clickSelectingTool; tool.standardMouseSelect = function() { // Maybe do something else before // ... // Be careful about using 'this' within such functions! // In cases where you want normal behavior, call the base functionality. // Note the reference to the prototype // and the call to 'call' passing it what 'this' should be. go.ClickSelectingTool.prototype.standardMouseSelect.call(tool); // Maybe do something else after // ... } </code></pre> <p> As a concrete example, we will override <a>Tool.standardMouseSelect</a> to select only Nodes and Links that have a width and height of less than 50 diagram units. This means that we must find the to-be-selected object using <code>diagram.findPartAt</code>, check its bounds, and quit if the bounds are too large. Otherwise, we call the base functionality to select as we normally might. </p> <pre class="lang-js" id="tool"><code> diagram.nodeTemplate = $(go.Node, "Auto", $(go.Shape, "Rectangle", { fill: "white" }, new go.Binding("fill", "color")), $(go.TextBlock, { margin: 5 }, new go.Binding("text", "key")) ); var tool = diagram.toolManager.clickSelectingTool; tool.standardMouseSelect = function() { var diagram = tool.diagram; var e = diagram.lastInput; // to select containing Group if Part.canSelect() is false var curobj = diagram.findPartAt(e.documentPoint, false); if (curobj !== null) { var bounds = curobj.actualBounds; // End the selection process if the bounds are greater than 50 width or height if (bounds.width > 50 || bounds.height > 50) { // If this was a left click with no modifier, we want to act the same as if // we are clicking on the Diagram background, so we clear the selection if (e.left && !e.control && !e.shift) { diagram.clearSelection(); } // Then return, so that we do not call the base functionality return; } } // otherwise, call the base functionality go.ClickSelectingTool.prototype.standardMouseSelect.call(tool); } diagram.model = new go.Model([ { key: "Alpha", color: "lightblue" }, { key: "Epsilon", color: "thistle" }, { key: "Psi", color: "lightcoral" }, { key: "Gamma", color: "lightgreen" } ]); </code></pre> <p> Running this code, we see that the "Epsilon" and "Gamma" nodes are not selectable, because they are both wider than 50. Note that this custom tool does not change the behavior of other tools that might select, such as the <a>DraggingTool</a> or the <a>DragSelectingTool</a>. </p> <script>goCode("tool", 300, 130)</script> <h2 id="OverridingMethodsBySubclassingLayout">Overriding Methods by Subclassing a Layout</h2> <p> Layouts can be subclassed to create custom Layouts that inherit the properties and methods of an existing layout. Subclassing in traditional JavaScript for <b>GoJS</b> requires a few key steps: </p> <ul> <li>Create a new class (function), and call the base class constructor. <li>Call <a>Diagram,inherit</a> with the new class and the base class. <li>Modify the prototype of your derived class to add new functionality. </ul> <p> To create a new Layout, called <code>CascadeLayout</code>, we would start with the following scaffolding: </p> <pre class="lang-js"><code> function CascadeLayout() { // Note the direct constructor call, no use of "prototype" go.Layout.call(this); // new properties go here, on "this" } go.Diagram.inherit(CascadeLayout, go.Layout); // Note setting the method on the prototype CascadeLayout.prototype.doLayout = function(coll) { // Layout logic goes here. // You can reliably use "this" to refer to the layout instance // on which this method was called. } </code></pre> <p> Note that if you are writing in modern JavaScript (ECMAScript 6) or in TypeScript, you can use newer syntax for defining classes: </p> <pre class="lang-js"><code> export class CascadeLayout extends go.Layout { // new data properties (fields) get declared and initialized here constructor() { super(); // other initializations can be done here } // optionally, define property getters and setters here // override or define methods public doLayout(coll) { // Layout logic goes here. } } </code></pre> <p> Layouts commonly need additional properties that act as layout options. To add a "offset" property to <code>CascadeLayout</code>, we will use the convention that an underscore member is private, and will set a default value in the constructor: </p> <pre class="lang-js"><code> function CascadeLayout() { go.Layout.call(this); this._offset = new go.Size(12, 12); } </code></pre> <p> Then, we use <code>Object.defineProperty</code> to make a "public" getter and setter. Getters and setters allow us to do type checking and have side effects. This setter makes sure the offset value is a <code>go.Size</code> object and invalidates the layout only if the value has changed. </p> <pre class="lang-js"><code> Object.defineProperty(CascadeLayout.prototype, "offset", { get: function() { return this._offset; }, set: function(val) { if (!(val instanceof go.Size)) { throw new Error("new value for CascadeLayout.offset must be a Size, not: " + val); } if (!this._offset.equals(val)) { this._offset = val; this.invalidateLayout(); } } }); </code></pre> <p> If you are writing in ECMAScript 6 or TypeScript, you can define property getters and setters. </p> <pre class="lang-js"><code> get offset() { return this._offset; } set offset(val) { if (!(val instanceof go.Size)) { throw new Error("new value for CascadeLayout.offset must be a Size, not: " + val); } if (!this._offset.equals(val)) { this._offset = val; this.invalidateLayout(); } } </code></pre> <p> If the layout might be used as the value of <a>Group.layout</a>, you will need to make sure the instance that you set in the Group template can be copied correctly. </p> <pre class="lang-js"><code> CascadeLayout.prototype.cloneProtected = function(copy) { go.Layout.prototype.cloneProtected.call(this, copy); copy._offset = this._offset; } </code></pre> <p> Lastly we'll define a <a>Layout.doLayout</a>, being sure to look at the documentation and accomodate all possible input, as doLayout has one argument that can either be a <a>Diagram</a>, or a <a>Group</a>, or an <a>Iterable</a> collection. </p> <p> All together, we can see the cascade layout in action: </p> <pre class="lang-js" id="example"><code> /** * @constructor * @extends Layout * @class * This layout arranges nodes in a cascade specified by the offset property */ function CascadeLayout() { go.Layout.call(this); this._offset = new go.Size(12, 12); } go.Diagram.inherit(CascadeLayout, go.Layout); CascadeLayout.prototype.cloneProtected = function(copy) { go.Layout.prototype.cloneProtected.call(this, copy); copy._offset = this._offset; } Object.defineProperty(CascadeLayout.prototype, "offset", { get: function() { return this._offset; }, set: function(val) { if (!(val instanceof go.Size)) { throw new Error("new value for CascadeLayout.offset must be a Size, not: " + val); } if (!this._offset.equals(val)) { this._offset = val; this.invalidateLayout(); } } }); /** * This method positions all Nodes and ignores all Links. * @this {CascadeLayout} * @param {Diagram|Group|Iterable} coll the collection of Parts to layout. */ CascadeLayout.prototype.doLayout = function(coll) { // get the Nodes and Links to be laid out var parts = this.collectParts(coll); // Start the layout at the arrangement origin, a property inherited from Layout var x = this.arrangementOrigin.x; var y = this.arrangementOrigin.y; var offset = this.offset; var it = parts.iterator; while (it.next()) { var node = it.value; if (!(node instanceof go.Node)) continue; // ignore Links node.move(new go.Point(x, y)); x += offset.width; y += offset.height; } } // end of CascadeLayout // Regular diagram setup: diagram.layout = new CascadeLayout(); diagram.nodeTemplate = $(go.Node, "Auto", $(go.Shape, "Rectangle", { fill: "white" }, new go.Binding("fill", "color")), $(go.TextBlock, { margin: 5 }, new go.Binding("text", "key")) ); diagram.model = new go.Model([ { key: "Alpha", color: "lightblue" }, { key: "Beta", color: "thistle" }, { key: "Delta", color: "lightcoral" }, { key: "Gamma", color: "lightgreen" } ]); </code></pre> <script>goCode("example", 300, 200)</script> </div> </div> <div class="bg-nwoods-primary"> <section class="max-w-screen-lg text-white container mx-auto py-2 px-12"> <p id="version" class="leading-none mb-2 my-4">GoJS</p> </section> </div><footer class="bg-nwoods-primary text-white"> <div class="container max-w-screen-lg mx-auto px-8"> <div class="w-full py-6"> <div class="max-w-screen-lg xl:max-w-screen-xl mx-auto px-4 sm:px-6 md:px-8"> <ul class="text-sm font-medium pb-14 sm:pb-20 grid grid-cols-1 sm:grid-cols-3 gap-y-10"> <li class="list-none row-span-2"> <h2 class="text-base font-semibold tracking-wide">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">GitHub</a> </li> </ul> </li> <li class="list-none row-span-2"> <h2 class="text-base font-semibold tracking-wide">Support</h2> <ul class="list-none space-y-4 md:space-y-1 px-0"> <li> <a href="https://www.nwoods.com/contact.html" target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/contact.html', 'contact');">Contact</a> </li> <li> <a href="https://forum.nwoods.com/c/gojs">Forum</a> </li> <li> <a href="https://www.nwoods.com/app/activate.aspx?sku=gojs">Activate</a> </li> <li> <a href="https://www.nwoods.com/sales/index.html" target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');">Buy</a> </li> <li> <a href="https://www.youtube.com/channel/UC9We8EoX596-6XFjJDtZIDg">Videos</a> </li> </ul> </li> <li class="list-none row-span-2"> <h2 class="text-base font-semibold tracking-wide">Company</h2> <ul class="list-none space-y-4 md:space-y-1 px-0"> <li> <a href="https://www.nwoods.com">Northwoods</a> </li> <li> <a href="https://www.nwoods.com/about.html">About Us</a> </li> <li> <a href="https://www.nwoods.com/contact.html">Contact Us</a> </li> <li> <a href="https://twitter.com/northwoodsgo">Twitter</a> </li> </ul> </li> </ul> <p class="text-sm text-gray-100 md:mb-6"> Copyright 1998-2021 <a class="text-white" href="https://www.nwoods.com">Northwoods Software</a> </p> </div> </div> </footer> </body> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-1506307-5"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-1506307-5'); var getOutboundLink = function(url, label) { gtag('event', 'click', { 'event_category': 'outbound', 'event_label': label, 'transport_type': 'beacon' }); } // topnav var topButton = document.getElementById("topnavButton"); var topnavList = document.getElementById("topnavList"); topButton.addEventListener("click", function() { this.classList.toggle("active"); topnavList.classList.toggle("hidden"); document.getElementById("topnavOpen").classList.toggle("hidden"); document.getElementById("topnavClosed").classList.toggle("hidden"); }); </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>