create-gojs-kit
Version:
A CLI for downloading GoJS samples, extensions, and docs
284 lines (251 loc) • 13.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="Create nodes by dragging, thereby specifying their initial size." />
<meta itemprop="description" content="Create nodes by dragging, thereby specifying their initial size." />
<meta property="og:description" content="Create nodes by dragging, thereby specifying their initial size." />
<meta name="twitter:description" content="Create nodes by dragging, thereby specifying their initial size." />
<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="Drag Creating Tool Lets Users Draw Box where New Node will be Created" />
<meta property="og:title" content="Drag Creating Tool Lets Users Draw Box where New Node will be Created" />
<meta name="twitter:title" content="Drag Creating Tool Lets Users Draw Box where New Node will be Created" />
<meta property="og:image" content="https://gojs.net/latest/assets/images/screenshots/dragcreating.png" />
<meta itemprop="image" content="https://gojs.net/latest/assets/images/screenshots/dragcreating.png" />
<meta name="twitter:image" content="https://gojs.net/latest/assets/images/screenshots/dragcreating.png" />
<meta property="og:url" content="https://gojs.net/latest/samples/DragCreating.html" />
<meta property="twitter:url" content="https://gojs.net/latest/samples/DragCreating.html" />
<meta name="twitter:card" content="summary_large_image" />
<meta property="og:type" content="website" />
<meta property="twitter:domain" content="gojs.net" />
<title>
Drag Creating Tool Lets Users Draw Box where New Node will be Created | 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 src="../extensions/DragCreatingTool.js"></script>
<script id="code">
function init() {
myDiagram = new go.Diagram('myDiagramDiv', {
// Define the template for Nodes, just some text inside a colored rectangle
nodeTemplate:
new go.Node('Auto', {
minSize: new go.Size(60, 20),
resizable: true
})
.bindTwoWay('desiredSize', 'size', go.Size.parse, go.Size.stringify)
.bindTwoWay('position', 'pos', go.Point.parse, go.Point.stringify)
// temporarily put selected nodes in Foreground layer
.bindObject('layerName', 'isSelected', s => s ? 'Foreground' : '')
.add(
new go.Shape('Rectangle')
.bind('fill', 'color'),
new go.TextBlock({ margin: 2 })
.bind('text', 'color')
),
'undoManager.isEnabled': true
});
myDiagram.add(
new go.Part({
layerName: 'Grid',
location: new go.Point(0, 0)
})
.add(
new go.TextBlock('Mouse-down and then drag in the background\nto add a Node there with the drawn size.',
{ stroke: 'brown' })
)
);
// Add an instance of the custom tool defined in DragCreatingTool.js.
// This needs to be inserted before the standard DragSelectingTool,
// which is normally the third Tool in the ToolManager.mouseMoveTools list.
// Note that if you do not set the DragCreatingTool.delay, the default value will
// require a wait after the mouse down event. Not waiting will allow the DragSelectingTool
// and the PanningTool to be able to run instead of the DragCreatingTool, depending on the delay.
myDiagram.toolManager.mouseMoveTools.insertAt(2,
new DragCreatingTool({
isEnabled: true, // disabled by the checkbox
delay: 0, // always canStart(), so PanningTool never gets the chance to run
box:
new go.Part({ layerName: 'Tool' })
.add(
new go.Shape({
name: 'SHAPE',
fill: null,
stroke: 'cyan',
strokeWidth: 2
})
),
archetypeNodeData: { color: 'white' }, // initial properties shared by all nodes
insertPart: function (bounds) { // method override of DragCreatingTool.insertPart
// use a different color each time
this.archetypeNodeData.color = go.Brush.randomColor();
// call the base method to do normal behavior and return its result
return DragCreatingTool.prototype.insertPart.call(this, bounds);
}
})
);
}
function toolEnabled() {
var enable = document.getElementById('ToolEnabled').checked;
var tool = myDiagram.toolManager.findTool('DragCreating');
if (tool !== null) tool.isEnabled = enable;
}
window.addEventListener('DOMContentLoaded', init);
</script>
<div id="sample">
<div id="myDiagramDiv" style="background-color: white; border: solid 1px black; width: 100%; height: 800px"></div>
<label><input id="ToolEnabled" type="checkbox" checked="checked" onclick="toolEnabled()" />DragCreatingTool enabled</label>
<p>
This sample demonstrates the DragCreatingTool, which replaces the standard DragSelectingTool. It is defined in its own file, as
<a href="../extensions/DragCreatingTool.js">DragCreatingTool.js</a>.
</p>
<p>
Press in the background and then drag to show the area to be occupied by the new node. The mouse-up event will add a copy of the
DragCreatingTool.archetypeNodeData object, causing a new node to be created. The tool will assign its <a>GraphObject.position</a> and
<a>GraphObject.desiredSize</a>.
</p>
<p>
See also <a href="../samples/basic.html">Basic</a> which uses the click
creating tool.
</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>Tools</h4>
<p>
<a href="../api/symbols/Tool.html" target="api">Tool</a>s handle all input events, such as mouse and keyboard interactions, in a Diagram.
There are many kinds of predefined Tool classes that implement all of the common operations that users do.
</p>
<p>
For flexibility and simplicity, all input events are canonicalized as <a href="../api/symbols/InputEvent.html" target="api">InputEvent</a>s and
redirected by the diagram to go to the <a href="../api/symbols/Diagram.html#currentTool" target="api">Diagram.currentTool</a>.
By default the Diagram.currentTool is an instance of <a href="../api/symbols/ToolManager.html" target="api">ToolManager</a> held as the <a href="../api/symbols/Diagram.html#toolManager" target="api">Diagram.toolManager</a>.
The ToolManager implements support for all mode-less tools.
The ToolManager is responsible for finding another tool that is ready to run and then making it the new current tool.
This causes the new tool to process all of the input events (mouse, keyboard, and touch) until the tool decides that it is finished,
at which time the diagram's current tool reverts back to the <a href="../api/symbols/Diagram.html#defaultTool" target="api">Diagram.defaultTool</a>, which is normally the ToolManager, again.
</p>
<p>
More information can be found in the <a href="../intro/tools.html">GoJS Intro</a>.
</p>
<p>
<a href="../samples/index.html#tools">Related samples</a>
</p>
<hr>
<!-- blacklist tags that do not correspond to a specific GoJS feature -->
<h4>GoJS Extensions</h4>
<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 href="../api/symbols/GraphObject.html" target="api">GraphObject</a>, <a href="../api/symbols/Diagram.html" target="api">Diagram</a>, <a href="../api/symbols/CommandHandler.html" target="api">CommandHandler</a>, <a href="../api/symbols/Tool.html" target="api">Tool</a>, or <a href="../api/symbols/Layout.html" target="api">Layout</a>.
But when the desired property does not 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.
Various features of GoJS can be overriden, 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>
In addition to our samples, <b>GoJS</b> provides an <strong><a href="../samples/#extensions">extensions gallery</a></strong>,
showcasing the creation of custom tools and layouts.
Those classes and samples are written in TypeScript, available at <code>../extensionsJSM/</code>,
as ECMAScript/JavaScript modules -- 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 GoJS library
that you choose and so that you can include them into your own building and packaging procedures.
</p>
<p>
More information can be found in the <a href="../intro/extensions.html">GoJS Intro</a>.
</p>
<p>
<a href="../samples/index.html#extensions">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>