/
DraggingOptions.html
338 lines (337 loc) · 16.7 KB
/
DraggingOptions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DraggingOptions | 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/css/style.css">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<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="../../index.html">
<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/index.html">Learn</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../../samples/index.html">Samples</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../../intro/index.html">Intro</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../../api/index.html">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="tsd tsd-page-header">
<div class="tsd-page-toolbar">
<div class="w-full max-w-screen-xl mx-auto px-2">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" 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 tsd-page-title">
<div class="w-full max-w-screen-xl mx-auto px-2">
<div class="top-copyright">
<b>GoJS</b>® Diagramming Components<br/>version 2.1.54<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a>
</div>
<div>
<h1>Class DraggingOptions</h1>
</div>
</div>
</div>
</div>
</header>
<div class="tsd w-full max-w-screen-xl mx-auto pb-4">
<div class="row px-2 w-full">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">DraggingOptions</span>
</li>
</ul>
</section>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<p>New in 2.0, this class contains options for dragging and moving parts.</p>
<p>This is used by <a href="Diagram.html#moveParts">Diagram.moveParts</a>, <a href="Diagram.html#computeMove">Diagram.computeMove</a>, and <a href="DraggingTool.html#computeMove">DraggingTool.computeMove</a>.</p>
<p>Both the <a href="Diagram.html">Diagram</a> and its <a href="DraggingTool.html">DraggingTool</a> have a DraggingOptions instance.
Typically, only the DraggingTool one is used, unless the Diagram has no DraggingTool defined.</p>
<p>In typical <a href="DraggingTool.html">DraggingTool</a> operation you do not need to create or modify a DraggingOptions instance.
Setting properties on the DraggingTool such as <a href="DraggingTool.html#isGridSnapEnabled">DraggingTool.isGridSnapEnabled</a>
sets the value on the <a href="DraggingTool.html#dragOptions">DraggingTool.dragOptions</a> instance for you.</p>
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="DraggingTool.html#dragOptions">DraggingTool.dragOptions</a></p>
</dd>
<dt>since</dt>
<dd><p>2.0</p>
</dd>
</dl>
</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="DraggingOptions.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="DraggingOptions.html#dragsLink" class="tsd-kind-icon">drags<wbr>Link</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="DraggingOptions.html#dragsMembers" class="tsd-kind-icon">drags<wbr>Members</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="DraggingOptions.html#dragsTree" class="tsd-kind-icon">drags<wbr>Tree</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="DraggingOptions.html#gridSnapCellSize" class="tsd-kind-icon">grid<wbr>Snap<wbr>Cell<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="DraggingOptions.html#gridSnapCellSpot" class="tsd-kind-icon">grid<wbr>Snap<wbr>Cell<wbr>Spot</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="DraggingOptions.html#gridSnapOrigin" class="tsd-kind-icon">grid<wbr>Snap<wbr>Origin</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="DraggingOptions.html#groupsAlwaysMove" class="tsd-kind-icon">groups<wbr>Always<wbr>Move</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="DraggingOptions.html#groupsSnapMembers" class="tsd-kind-icon">groups<wbr>Snap<wbr>Members</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="DraggingOptions.html#isGridSnapEnabled" class="tsd-kind-icon">is<wbr>Grid<wbr>Snap<wbr>Enabled</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="DraggingOptions.html#isGridSnapRealtime" class="tsd-kind-icon">is<wbr>Grid<wbr>Snap<wbr>Realtime</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>
constructor
</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Dragging<wbr>Options<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="DraggingOptions.html" class="tsd-signature-type" data-tsd-kind="Class">DraggingOptions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="DraggingOptions.html" class="tsd-signature-type" data-tsd-kind="Class">DraggingOptions</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="dragsLink" class="tsd-anchor"></a>
<h3>
drags<wbr>Link
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="dragsMembers" class="tsd-anchor"></a>
<h3>
drags<wbr>Members
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="dragsTree" class="tsd-anchor"></a>
<h3>
drags<wbr>Tree
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="gridSnapCellSize" class="tsd-anchor"></a>
<h3>
grid<wbr>Snap<wbr>Cell<wbr>Size
<span class="tsd-signature-symbol">: </span><a href="Size.html" class="tsd-signature-type" data-tsd-kind="Class">Size</a> </h3>
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="gridSnapCellSpot" class="tsd-anchor"></a>
<h3>
grid<wbr>Snap<wbr>Cell<wbr>Spot
<span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type" data-tsd-kind="Class">Spot</a> </h3>
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="gridSnapOrigin" class="tsd-anchor"></a>
<h3>
grid<wbr>Snap<wbr>Origin
<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a> </h3>
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="groupsAlwaysMove" class="tsd-anchor"></a>
<h3>
groups<wbr>Always<wbr>Move
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="groupsSnapMembers" class="tsd-anchor"></a>
<h3>
groups<wbr>Snap<wbr>Members
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="isGridSnapEnabled" class="tsd-anchor"></a>
<h3>
is<wbr>Grid<wbr>Snap<wbr>Enabled
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="isGridSnapRealtime" class="tsd-anchor"></a>
<h3>
is<wbr>Grid<wbr>Snap<wbr>Realtime
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
<div class="tsd-comment tsd-typography">
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">GoJS <wbr>Class <wbr>Index</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">
<a href="DraggingOptions.html" class="tsd-kind-icon">Dragging<wbr>Options</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="DraggingOptions.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="DraggingOptions.html#dragsLink" class="tsd-kind-icon">drags<wbr>Link</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="DraggingOptions.html#dragsMembers" class="tsd-kind-icon">drags<wbr>Members</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="DraggingOptions.html#dragsTree" class="tsd-kind-icon">drags<wbr>Tree</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="DraggingOptions.html#gridSnapCellSize" class="tsd-kind-icon">grid<wbr>Snap<wbr>Cell<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="DraggingOptions.html#gridSnapCellSpot" class="tsd-kind-icon">grid<wbr>Snap<wbr>Cell<wbr>Spot</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="DraggingOptions.html#gridSnapOrigin" class="tsd-kind-icon">grid<wbr>Snap<wbr>Origin</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="DraggingOptions.html#groupsAlwaysMove" class="tsd-kind-icon">groups<wbr>Always<wbr>Move</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="DraggingOptions.html#groupsSnapMembers" class="tsd-kind-icon">groups<wbr>Snap<wbr>Members</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="DraggingOptions.html#isGridSnapEnabled" class="tsd-kind-icon">is<wbr>Grid<wbr>Snap<wbr>Enabled</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="DraggingOptions.html#isGridSnapRealtime" class="tsd-kind-icon">is<wbr>Grid<wbr>Snap<wbr>Realtime</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<div class="tsd w-full max-w-screen-xl mx-auto px-2">
<div class="bottom-copyright">Copyright © 1998-2021 by Northwoods Software Corporation.</div>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<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>
</body>
</html>