gojs
Version:
Interactive diagrams, charts, and graphs, such as trees, flowcharts, orgcharts, UML, BPMN, or business diagrams
625 lines (624 loc) • 33.2 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DrawCommandHandler | GoJS API</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../assets/css/bootstrap.min.css">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<!-- non-fixed navbar -->
<nav id="non-fixed-nav" class="navbar navbar-inverse navbar-top">
<div class="container-fluid">
<div class="navbar-header">
<div class="navheader-container">
<div class="navheader-collapse" data-toggle="collapse" data-target="#navbar">
<a id="toplogo" class="navbar-brand" href="../../index.html">GoJS</a>
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
</div>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="../../index.html">Home</a></li>
<li><a href="../../learn/index.html">Learn</a></li>
<li><a href="../../samples/index.html">Samples</a></li>
<li><a href="../../intro/index.html">Intro</a></li>
<li><a href="../../api/index.html" target="api">API</a></li>
<li><a href="https://www.nwoods.com/components/evalform.htm">Register</a></li>
<li><a href="../../download.html">Download</a></li>
<li><a href="https://forum.nwoods.com/c/gojs">Forum</a></li>
<li><a href="https://www.nwoods.com/contact.html" onclick="ga('send','event','Outbound Link','click','contact');">Contact</a></li>
<li class="buy"><a href="https://www.nwoods.com/sales/index.html" onclick="ga('send','event','Outbound Link','click','buy');">Buy</a></li>
<li class="activate"><a href="https://www.nwoods.com/app/activate.aspx?sku=gojs">Activate</a></li>
</ul>
</div><!--/.nav-collapse -->
</div>
</nav>
<div class="tsd-page-header">
<div class="tsd-page-toolbar">
<div class="container-fluid plr15">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container-fluid plr15">
<div class="top-copyright">
<!--<b>GoJS</b>® Diagramming Components<br/>version <br/>version 2.1.18 for TypeScript/HTML<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a>-->
<b>GoJS</b>® Diagramming Components<br/>version 2.1.18<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a>
</div>
<div>
<h1>Class DrawCommandHandler</h1>
</div>
</div>
</div>
</div>
</header>
<div class="container-fluid container-main plr15">
<div class="row">
<div class="col-8 col-content">
<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.
Extensions can be found in the GoJS kit under the <code>extensions</code> or <code>extensionsTS</code> folders.
See the <a href="../../intro/extensions.html">Extensions intro page</a> for more information.
</p>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="CommandHandler.html" class="tsd-signature-type">CommandHandler</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">DrawCommandHandler</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<p>This CommandHandler class allows the user to position selected Parts in a diagram
relative to the first part selected, in addition to overriding the doKeyDown method
of the CommandHandler for handling the arrow keys in additional manners.</p>
<p>Typical usage:</p>
<pre><code class="hljs js"> $(go.Diagram, <span class="hljs-string">"myDiagramDiv"</span>,
{
<span class="hljs-attr">commandHandler</span>: $(DrawCommandHandler),
. . .
}
)</code></pre>
<p>or:</p>
<pre><code class="hljs js"> myDiagram.commandHandler = <span class="hljs-keyword">new</span> DrawCommandHandler();</code></pre>
<p>If you want to experiment with this extension, try the <a href="../../extensionsTS/DrawCommandHandler.html">Drawing Commands</a> sample.</p>
</div>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="DrawCommandHandler.html#arrowKeyBehavior" class="tsd-kind-icon">arrow<wbr>Key<wbr>Behavior</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="DrawCommandHandler.html#pasteOffset" class="tsd-kind-icon">paste<wbr>Offset</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#alignBottom" class="tsd-kind-icon">align<wbr>Bottom</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#alignCenterX" class="tsd-kind-icon">align<wbr>CenterX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#alignCenterY" class="tsd-kind-icon">align<wbr>CenterY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#alignColumn" class="tsd-kind-icon">align<wbr>Column</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#alignLeft" class="tsd-kind-icon">align<wbr>Left</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#alignRight" class="tsd-kind-icon">align<wbr>Right</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#alignRow" class="tsd-kind-icon">align<wbr>Row</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#alignTop" class="tsd-kind-icon">align<wbr>Top</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#canAlignSelection" class="tsd-kind-icon">can<wbr>Align<wbr>Selection</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#canRotate" class="tsd-kind-icon">can<wbr>Rotate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#copyToClipboard" class="tsd-kind-icon">copy<wbr>ToClipboard</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#doKeyDown" class="tsd-kind-icon">do<wbr>Key<wbr>Down</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#pasteFromClipboard" class="tsd-kind-icon">paste<wbr>From<wbr>Clipboard</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#pullToFront" class="tsd-kind-icon">pull<wbr>ToFront</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#pushToBack" class="tsd-kind-icon">push<wbr>ToBack</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DrawCommandHandler.html#rotate" class="tsd-kind-icon">rotate</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="arrowKeyBehavior" class="tsd-anchor"></a>
<h3>
arrow<wbr>Key<wbr>Behavior
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span> </h3>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Gets or sets the arrow key behavior. Possible values are "move", "select", and "scroll".</p>
<p>The default value is "move".</p>
</div>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="pasteOffset" class="tsd-anchor"></a>
<h3>
paste<wbr>Offset
<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</a> </h3>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Gets or sets the offset at which each repeated <a href="CommandHandler.html#pasteSelection">pasteSelection</a> puts the new copied parts from the clipboard.</p>
</div>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="alignBottom" class="tsd-anchor"></a>
<h3>
align<wbr>Bottom
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">align<wbr>Bottom<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Aligns selected parts at the bottom-most edge of the bottom-most part.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="alignCenterX" class="tsd-anchor"></a>
<h3>
align<wbr>CenterX
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">align<wbr>CenterX<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Aligns selected parts at the x-value of the center point of the first selected part.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="alignCenterY" class="tsd-anchor"></a>
<h3>
align<wbr>CenterY
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">align<wbr>CenterY<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Aligns selected parts at the y-value of the center point of the first selected part.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="alignColumn" class="tsd-anchor"></a>
<h3>
align<wbr>Column
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">align<wbr>Column<span class="tsd-signature-symbol">(</span>distance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Aligns selected parts top-to-bottom in order of the order selected.
Distance between parts can be specified. Default distance is 0.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>distance: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="alignLeft" class="tsd-anchor"></a>
<h3>
align<wbr>Left
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">align<wbr>Left<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Aligns selected parts along the left-most edge of the left-most part.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="alignRight" class="tsd-anchor"></a>
<h3>
align<wbr>Right
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">align<wbr>Right<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Aligns selected parts at the right-most edge of the right-most part.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="alignRow" class="tsd-anchor"></a>
<h3>
align<wbr>Row
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">align<wbr>Row<span class="tsd-signature-symbol">(</span>distance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Aligns selected parts left-to-right in order of the order selected.
Distance between parts can be specified. Default distance is 0.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>distance: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="alignTop" class="tsd-anchor"></a>
<h3>
align<wbr>Top
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">align<wbr>Top<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Aligns selected parts at the top-most edge of the top-most part.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="canAlignSelection" class="tsd-anchor"></a>
<h3>
can<wbr>Align<wbr>Selection
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">can<wbr>Align<wbr>Selection<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>This controls whether or not the user can invoke the <a href="DrawCommandHandler.html#alignLeft">alignLeft</a>, <a href="DrawCommandHandler.html#alignRight">alignRight</a>,
<a href="DrawCommandHandler.html#alignTop">alignTop</a>, <a href="DrawCommandHandler.html#alignBottom">alignBottom</a>, <a href="DrawCommandHandler.html#alignCenterX">alignCenterX</a>, <a href="DrawCommandHandler.html#alignCenterY">alignCenterY</a> commands.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>This returns true:
if the diagram is not <a href="Diagram.html#isReadOnly">Diagram.isReadOnly</a>,
if the model is not <a href="Model.html#isReadOnly">Model.isReadOnly</a>, and
if there are at least two selected <a href="Part.html">Part</a>s.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="canRotate" class="tsd-anchor"></a>
<h3>
can<wbr>Rotate
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">can<wbr>Rotate<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>This controls whether or not the user can invoke the <a href="DrawCommandHandler.html#rotate">rotate</a> command.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>This returns true:
if the diagram is not <a href="Diagram.html#isReadOnly">Diagram.isReadOnly</a>,
if the model is not <a href="Model.html#isReadOnly">Model.isReadOnly</a>, and
if there is at least one selected <a href="Part.html">Part</a>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="copyToClipboard" class="tsd-anchor"></a>
<h3>
<span class="tsd-flag ts-flagOverride">Override</span>
copy<wbr>ToClipboard
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">copy<wbr>ToClipboard<span class="tsd-signature-symbol">(</span>coll<span class="tsd-signature-symbol">: </span><a href="Iterable.html" class="tsd-signature-type">Iterable</a><span class="tsd-signature-symbol"><</span><a href="Part.html" class="tsd-signature-type">Part</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Reset the last offset for pasting.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>coll: <a href="Iterable.html" class="tsd-signature-type">Iterable</a><span class="tsd-signature-symbol"><</span><a href="Part.html" class="tsd-signature-type">Part</a><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<p>a collection of <a href="Part.html">Part</a>s.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="doKeyDown" class="tsd-anchor"></a>
<h3>
<span class="tsd-flag ts-flagOverride">Override</span>
do<wbr>Key<wbr>Down
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">do<wbr>Key<wbr>Down<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>This implements custom behaviors for arrow key keyboard events.
Set <a href="DrawCommandHandler.html#arrowKeyBehavior">arrowKeyBehavior</a> to "select", "move" (the default), "scroll" (the standard behavior), or "none"
to affect the behavior when the user types an arrow key.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="pasteFromClipboard" class="tsd-anchor"></a>
<h3>
<span class="tsd-flag ts-flagOverride">Override</span>
paste<wbr>From<wbr>Clipboard
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">paste<wbr>From<wbr>Clipboard<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Set.html" class="tsd-signature-type">Set</a><span class="tsd-signature-symbol"><</span><a href="Part.html" class="tsd-signature-type">Part</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Paste from the clipboard with an offset incremented on each paste, and reset when copied.</p>
</div>
<h4 class="tsd-returns-title">Returns <a href="Set.html" class="tsd-signature-type">Set</a><span class="tsd-signature-symbol"><</span><a href="Part.html" class="tsd-signature-type">Part</a><span class="tsd-signature-symbol">></span></h4>
<p>a collection of newly pasted <a href="Part.html">Part</a>s</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="pullToFront" class="tsd-anchor"></a>
<h3>
pull<wbr>ToFront
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">pull<wbr>ToFront<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Change the z-ordering of selected parts to pull them forward, in front of all other parts
in their respective layers.
All unselected parts in each layer with a selected Part with a non-numeric <a href="Part.html#zOrder">Part.zOrder</a> will get a zOrder of zero.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="pushToBack" class="tsd-anchor"></a>
<h3>
push<wbr>ToBack
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">push<wbr>ToBack<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Change the z-ordering of selected parts to push them backward, behind of all other parts
in their respective layers.
All unselected parts in each layer with a selected Part with a non-numeric <a href="Part.html#zOrder">Part.zOrder</a> will get a zOrder of zero.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="rotate" class="tsd-anchor"></a>
<h3>
rotate
</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">rotate<span class="tsd-signature-symbol">(</span>angle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography">
<p>Change the angle of the parts connected with the given part. This is in the command handler
so it can be easily accessed for the purpose of creating commands that change the rotation of a part.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>angle: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>the positive (clockwise) or negative (counter-clockwise) change in the rotation angle of each Part, in degrees.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../index.html"><em>GoJS <wbr>Class <wbr>Index</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-is-extension">
<a href="DrawCommandHandler.html" class="tsd-kind-icon">Draw<wbr>Command<wbr>Handler</a>
<ul>
<li class=" tsd-kind-accessor tsd-parent-kind-class">
<a href="DrawCommandHandler.html#arrowKeyBehavior" class="tsd-kind-icon">arrow<wbr>Key<wbr>Behavior</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class">
<a href="DrawCommandHandler.html#pasteOffset" class="tsd-kind-icon">paste<wbr>Offset</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#alignBottom" class="tsd-kind-icon">align<wbr>Bottom</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#alignCenterX" class="tsd-kind-icon">align<wbr>CenterX</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#alignCenterY" class="tsd-kind-icon">align<wbr>CenterY</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#alignColumn" class="tsd-kind-icon">align<wbr>Column</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#alignLeft" class="tsd-kind-icon">align<wbr>Left</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#alignRight" class="tsd-kind-icon">align<wbr>Right</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#alignRow" class="tsd-kind-icon">align<wbr>Row</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#alignTop" class="tsd-kind-icon">align<wbr>Top</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#canAlignSelection" class="tsd-kind-icon">can<wbr>Align<wbr>Selection</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#canRotate" class="tsd-kind-icon">can<wbr>Rotate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#copyToClipboard" class="tsd-kind-icon">copy<wbr>ToClipboard</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#doKeyDown" class="tsd-kind-icon">do<wbr>Key<wbr>Down</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#pasteFromClipboard" class="tsd-kind-icon">paste<wbr>From<wbr>Clipboard</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#pullToFront" class="tsd-kind-icon">pull<wbr>ToFront</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#pushToBack" class="tsd-kind-icon">push<wbr>ToBack</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="DrawCommandHandler.html#rotate" class="tsd-kind-icon">rotate</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<div class="container-fluid bottom-copyright plr15">
Copyright © 1998-2020 by Northwoods Software Corporation.
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script src="../../assets/js/api.js"></script>
<script src="../../assets/js/bootstrap.min.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-1506307-5', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>