create-gojs-kit
Version:
A CLI for downloading GoJS samples, extensions, and docs
105 lines (103 loc) • 34.5 kB
HTML
<html class="default" lang="en"><head><meta charSet="utf-8"/><link rel="stylesheet" href="../../assets/css/style.css"/><link rel="preconnect" href="https://rsms.me/"/><link rel="stylesheet" href="https://rsms.me/inter/inter.css"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Robot | GoJS API</title><meta name="description" content="Documentation for GoJS API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script type="text/javascript">// formerly in api.js
var hash = null;
function changeHash() {
var panels = document.getElementsByClassName("tsd-panel");
for (let i = 0; i < panels.length; i++) {
var p = panels[i];
p.classList.remove("targeted");
}
hash = window.location.hash.slice(1);
if (hash) {
var elt = document.getElementById(hash);
if (elt) elt.parentNode.classList.add("targeted");
}
}
document.addEventListener("DOMContentLoaded", changeHash);
window.addEventListener("hashchange", changeHash);</script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header><nav id="navTop" class="w-full h-[var(--topnav-h)] z-30 bg-[var(--color-background-secondary)] border-b border-b-[var(--color-accent)]"><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="../../index.html">GoJS</a><div class="relative"><button id="topnavButton" class="h-[calc(var(--topnav-h)_-_1px)] px-2 m-0 text-[var(--color-text)] 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"></path></svg></button><div id="topnavList" class="hidden md:block"><div class="absolute right-0 z-30 flex flex-col items-end rounded border border-[var(--color-accent)] p-4 pl-12 shadow bg-[var(--color-background-secondary)] text-[var(--color-text)] 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/index.html">Learn</a><a href="../../samples/index.html">Samples</a><a href="../../intro/index.html">Intro</a><a class="active" href="../../api/index.html">API</a><a href="../../download.html">Download</a><a href="https://forum.nwoods.com/c/gojs/11" target="_blank" rel="noopener">Forum</a><a href="https://nwoods.com/contact.html" target="_blank" rel="noopener" id="contactBtn">Contact</a><a href="https://nwoods.com/sales/index.html" target="_blank" rel="noopener" id="buyBtn">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
// done via active tag below, always API
}
});</script><div class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><div id="tsd-search-help"><code class="!text-lg">/</code> to search</div><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">GoJS API</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><div class="flex w-full max-w-screen-xl mx-auto px-2 items-center justify-between"><div><ul class="tsd-breadcrumb"><li><a href="../index.html">GoJS API</a></li><li><a href="Robot.html">Robot</a></li></ul><h1 class="flex items-center">Class Robot</h1></div><div class="text-xs"><b>GoJS</b>® Diagramming Components<br/>version 3.1.0<br/>by <a href="https://nwoods.com/">Northwoods Software®</a></div></div></div><section class="tsd-panel tsd-extension"><p>This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. See the <a href="../../intro/extensions.html">Extensions intro page</a> for more information.</p></section><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A class for simulating mouse and keyboard input.</p>
<p>As a special feature, this supports limited simulation of drag-and-drop between Diagrams,
by setting both the <code>sourceDiagram</code> and <code>targetDiagram</code> properties
on the <code>eventprops</code> argument of the mouseDown/mouseMove/mouseUp methods.
Although <a href="InputEvent.html#targetDiagram" class="tsd-kind-accessor">go.InputEvent.targetDiagram</a> is a real property,
the <code>sourceDiagram</code> property is only used by these Robot methods.</p>
<p>Typical setup:</p>
<pre><code class="language-js"><span class="hl-2"> </span><span class="hl-0">// a shared Robot that can be used by all commands for this one Diagram</span><br/><span class="hl-2"> </span><span class="hl-4">myRobot</span><span class="hl-2"> = </span><span class="hl-1">new</span><span class="hl-2"> </span><span class="hl-5">Robot</span><span class="hl-2">(</span><span class="hl-4">myDiagram</span><span class="hl-2">); </span><span class="hl-0">// defined in Robot.js</span>
</code><button>Copy</button></pre>
<p>Then later:</p>
<pre><code class="language-js"><span class="hl-2"> </span><span class="hl-0">// Simulate a mouse drag to move a node:</span><br/><span class="hl-2"> </span><span class="hl-1">const</span><span class="hl-2"> </span><span class="hl-3">loc</span><span class="hl-2"> = ...; </span><span class="hl-0">// some Point in document coordinates that is within the bounds of a node</span><br/><span class="hl-2"> </span><span class="hl-1">const</span><span class="hl-2"> </span><span class="hl-3">options</span><span class="hl-2"> = {}; </span><span class="hl-0">// possible settings of InputEvent, such as setting control or shift to true</span><br/><span class="hl-2"> </span><span class="hl-4">myRobot</span><span class="hl-2">.</span><span class="hl-5">mouseDown</span><span class="hl-2">(</span><span class="hl-4">loc</span><span class="hl-2">.</span><span class="hl-4">x</span><span class="hl-2">, </span><span class="hl-4">loc</span><span class="hl-2">.</span><span class="hl-4">y</span><span class="hl-2">, </span><span class="hl-7">0</span><span class="hl-2">, </span><span class="hl-4">options</span><span class="hl-2">);</span><br/><span class="hl-2"> </span><span class="hl-4">myRobot</span><span class="hl-2">.</span><span class="hl-5">mouseMove</span><span class="hl-2">(</span><span class="hl-4">loc</span><span class="hl-2">.</span><span class="hl-4">x</span><span class="hl-2"> + </span><span class="hl-7">80</span><span class="hl-2">, </span><span class="hl-4">loc</span><span class="hl-2">.</span><span class="hl-4">y</span><span class="hl-2"> + </span><span class="hl-7">50</span><span class="hl-2">, </span><span class="hl-7">50</span><span class="hl-2">, </span><span class="hl-4">options</span><span class="hl-2">);</span><br/><span class="hl-2"> </span><span class="hl-4">myRobot</span><span class="hl-2">.</span><span class="hl-5">mouseMove</span><span class="hl-2">(</span><span class="hl-4">loc</span><span class="hl-2">.</span><span class="hl-4">x</span><span class="hl-2"> + </span><span class="hl-7">20</span><span class="hl-2">, </span><span class="hl-4">loc</span><span class="hl-2">.</span><span class="hl-4">y</span><span class="hl-2"> + </span><span class="hl-7">100</span><span class="hl-2">, </span><span class="hl-7">100</span><span class="hl-2">, </span><span class="hl-4">options</span><span class="hl-2">);</span><br/><span class="hl-2"> </span><span class="hl-4">myRobot</span><span class="hl-2">.</span><span class="hl-5">mouseUp</span><span class="hl-2">(</span><span class="hl-4">loc</span><span class="hl-2">.</span><span class="hl-4">x</span><span class="hl-2"> + </span><span class="hl-7">20</span><span class="hl-2">, </span><span class="hl-4">loc</span><span class="hl-2">.</span><span class="hl-4">y</span><span class="hl-2"> + </span><span class="hl-7">100</span><span class="hl-2">, </span><span class="hl-7">150</span><span class="hl-2">, </span><span class="hl-4">options</span><span class="hl-2">);</span>
</code><button>Copy</button></pre>
<p>If you want to experiment with this extension, try the <a href="../../samples/Robot.html">Simulating Input</a> sample.</p>
</div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="true" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Robot.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="Robot.html#diagram" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>diagram</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Robot.html#keyDown" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>key<wbr/>Down</span></a>
<a href="Robot.html#keyUp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>key<wbr/>Up</span></a>
<a href="Robot.html#mouseDown" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mouse<wbr/>Down</span></a>
<a href="Robot.html#mouseMove" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mouse<wbr/>Move</span></a>
<a href="Robot.html#mouseUp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mouse<wbr/>Up</span></a>
<a href="Robot.html#mouseWheel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mouse<wbr/>Wheel</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Robot" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Robot</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dia</span><span class="tsd-signature-symbol">?: </span><a href="Diagram.html" class="tsd-signature-type tsd-kind-class">Diagram</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Robot.html" class="tsd-signature-type tsd-kind-class">Robot</a><a href="#constructor.new_Robot" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Construct a robot for a given <a href="Diagram.html" class="tsd-kind-class">go.Diagram</a>. If none is provided, a new Diagram will be created.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">dia</span>: <a href="Diagram.html" class="tsd-signature-type tsd-kind-class">Diagram</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Robot.html" class="tsd-signature-type tsd-kind-class">Robot</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="diagram" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>diagram</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Diagram.html" class="tsd-signature-type tsd-kind-class">Diagram</a></div><a href="#diagram" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the <a href="Diagram.html" class="tsd-kind-class">go.Diagram</a> associated with this Robot.</p>
</div></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="keyDown" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>key<wbr/>Down</span><a href="#keyDown" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="keyDown.keyDown-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">key<wbr/>Down</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyCodeOrKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">eventprops</span><span class="tsd-signature-symbol">?: </span><a href="ObjectData.html" class="tsd-signature-type tsd-kind-interface">ObjectData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#keyDown.keyDown-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Simulate a key down event.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">keyCodeOrKey</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>A simulated KeyboardEvent.keyCode (number) or KeyboardEvent.key (string)</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the timestamp of the simulated event, in milliseconds; default zero</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">eventprops</span>: <a href="ObjectData.html" class="tsd-signature-type tsd-kind-interface">ObjectData</a></h5><div class="tsd-comment tsd-typography"><p>an optional argument providing properties for the InputEvent.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="keyUp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>key<wbr/>Up</span><a href="#keyUp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="keyUp.keyUp-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">key<wbr/>Up</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keyCodeOrKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">eventprops</span><span class="tsd-signature-symbol">?: </span><a href="ObjectData.html" class="tsd-signature-type tsd-kind-interface">ObjectData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#keyUp.keyUp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Simulate a key up event.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">keyCodeOrKey</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>A simulated KeyboardEvent.keyCode (number) or KeyboardEvent.key (string)</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the timestamp of the simulated event, in milliseconds; default zero</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">eventprops</span>: <a href="ObjectData.html" class="tsd-signature-type tsd-kind-interface">ObjectData</a></h5><div class="tsd-comment tsd-typography"><p>an optional argument providing properties for the InputEvent.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="mouseDown" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mouse<wbr/>Down</span><a href="#mouseDown" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="mouseDown.mouseDown-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mouse<wbr/>Down</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">y</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">eventprops</span><span class="tsd-signature-symbol">?: </span><a href="ObjectData.html" class="tsd-signature-type tsd-kind-interface">ObjectData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mouseDown.mouseDown-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Simulate a mouse down event.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the X-coordinate of the mouse point in document coordinates.</p>
</div></li><li><h5><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the Y-coordinate of the mouse point in document coordinates.</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the timestamp of the simulated event, in milliseconds; default zero</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">eventprops</span>: <a href="ObjectData.html" class="tsd-signature-type tsd-kind-interface">ObjectData</a></h5><div class="tsd-comment tsd-typography"><p>an optional argument providing properties for the InputEvent.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="mouseMove" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mouse<wbr/>Move</span><a href="#mouseMove" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="mouseMove.mouseMove-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mouse<wbr/>Move</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">y</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">eventprops</span><span class="tsd-signature-symbol">?: </span><a href="ObjectData.html" class="tsd-signature-type tsd-kind-interface">ObjectData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mouseMove.mouseMove-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Simulate a mouse move event.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the X-coordinate of the mouse point in document coordinates.</p>
</div></li><li><h5><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the Y-coordinate of the mouse point in document coordinates.</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the timestamp of the simulated event, in milliseconds; default zero</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">eventprops</span>: <a href="ObjectData.html" class="tsd-signature-type tsd-kind-interface">ObjectData</a></h5><div class="tsd-comment tsd-typography"><p>an optional argument providing properties for the InputEvent.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="mouseUp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mouse<wbr/>Up</span><a href="#mouseUp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="mouseUp.mouseUp-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mouse<wbr/>Up</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">y</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">eventprops</span><span class="tsd-signature-symbol">?: </span><a href="ObjectData.html" class="tsd-signature-type tsd-kind-interface">ObjectData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mouseUp.mouseUp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Simulate a mouse up event.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the X-coordinate of the mouse point in document coordinates.</p>
</div></li><li><h5><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the Y-coordinate of the mouse point in document coordinates.</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the timestamp of the simulated event, in milliseconds; default zero</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">eventprops</span>: <a href="ObjectData.html" class="tsd-signature-type tsd-kind-interface">ObjectData</a></h5><div class="tsd-comment tsd-typography"><p>an optional argument providing properties for the InputEvent.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="mouseWheel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mouse<wbr/>Wheel</span><a href="#mouseWheel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="mouseWheel.mouseWheel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mouse<wbr/>Wheel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">delta</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">eventprops</span><span class="tsd-signature-symbol">?: </span><a href="ObjectData.html" class="tsd-signature-type tsd-kind-interface">ObjectData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mouseWheel.mouseWheel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Simulate a mouse wheel event.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">delta</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>non-zero turn</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the timestamp of the simulated event, in milliseconds; default zero</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">eventprops</span>: <a href="ObjectData.html" class="tsd-signature-type tsd-kind-interface">ObjectData</a></h5><div class="tsd-comment tsd-typography"><p>an optional argument providing properties for the InputEvent.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><ul><li><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></li><li><a href="#diagram"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>diagram</span></a></li><li><a href="#keyDown"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>key<wbr/>Down</span></a></li><li><a href="#keyUp"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>key<wbr/>Up</span></a></li><li><a href="#mouseDown"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mouse<wbr/>Down</span></a></li><li><a href="#mouseMove"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mouse<wbr/>Move</span></a></li><li><a href="#mouseUp"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mouse<wbr/>Up</span></a></li><li><a href="#mouseWheel"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mouse<wbr/>Wheel</span></a></li></ul></div></details><div class="tsd-navigation settings"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">System</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>GoJS API</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd w-full max-w-screen-xl mx-auto px-2"><div class="bottom-copyright">Copyright © 1998-2025 by Northwoods Software Corporation.</div></div><div class="overlay"></div><script async src="https://www.googletagmanager.com/gtag/js?id=G-S5QK8VSK84"></script><script>window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-S5QK8VSK84');
var getOutboundLink = function(url, label) {
gtag('event', 'click', {
'event_category': 'outbound',
'event_label': label,
'transport_type': 'beacon'
});
}
document.getElementById("contactBtn").addEventListener("click", function() {
getOutboundLink('https://nwoods.com/contact.html', 'contact');
});
document.getElementById("buyBtn").addEventListener("click", function() {
getOutboundLink('https://nwoods.com/sales/index.html', 'buy');
});</script></body></html>