zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/docs/api/classes/PanningManager.html

11 lines
33 KiB
HTML
Raw Normal View History

Finish converting core to ts, JSDoc conversion, consistency+convention changes, example bugfixes (#70) * reorganised directories; removed mx prefix * reduced directory hierarchies; removed mx prefix; type fixes * convert remaining javascript to ts * fix/add types * add type defs * type updates; moved codecs to where they're used * reorganise constants into enums+type additions * removed "Function:" and "Variable:" prefixes from comments, as they aren't needed in JSDoc * removed "Function:", "Variable:" and "Class:" prefixes from comments, as they aren't needed in JSDoc * removed "Function:" prefixes from comments, as they aren't needed in JSDoc * minor changes * convert code example blocks to markdown * module casing updates * converted parameter function documentation to JSDoc * documentation+type updates * removed react subdir (for now) * reorganised various `utils` functions into different files * type updates/bugfixes/workarounds * rename Rubberband and CellEditor to be *Handler to match the other plugins * move codec classes to where they're used to reduce cyclic dependencies * move codec classes to where they're used to reduce cyclic dependencies * type updates/reorganize layout file structure * renamed various files for consistency * import fixes * renamed GraphHandler SelectionHander and various fixes * convert EventObject parameters to objects * add basic better-docs config * update better-docs config * bugfix for shared variables in Graph persisting across instances * fixed accessing handlers in examples; renamed Model to GraphModel * fixed accessing handlers in examples; renamed Model to GraphModel * restored selection model * bugfix * renamed getModel to getDataModel * changed to use graph.batchUpdate() to reduce lines of code * changed to use graph.batchUpdate() to reduce lines of code * finished annotations+added TypeDoc * convert remaining Cell[] instances to CellArray * convert NaturalDocs links to JSDoc
2022-01-08 01:49:35 +00:00
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PanningManager | @maxgraph/core</title><meta name="description" content="Documentation for @maxgraph/core"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@maxgraph/core</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> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></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"><ul class="tsd-breadcrumb"><li><a href="../index.html">@maxgraph/core</a></li><li><a href="PanningManager.html">PanningManager</a></li></ul><h1>Class PanningManager</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Implements a handler for panning.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">PanningManager</span></li></ul></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="PanningManager.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="PanningManager.html#active" class="tsd-kind-icon">active</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#border" class="tsd-kind-icon">border</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#damper" class="tsd-kind-icon">damper</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#delay" class="tsd-kind-icon">delay</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#dx" class="tsd-kind-icon">dx</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#dy" class="tsd-kind-icon">dy</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#getDx" class="tsd-kind-icon">get<wbr/>Dx</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#getDy" class="tsd-kind-icon">get<wbr/>Dy</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#handleMouseOut" class="tsd-kind-icon">handle<wbr/>Mouse<wbr/>Out</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#isActive" class="tsd-kind-icon">is<wbr/>Active</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#mouseListener" class="tsd-kind-icon">mouse<wbr/>Listener</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#mouseUpListener" class="tsd-kind-icon">mouse<wbr/>Up<wbr/>Listener</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#panTo" class="tsd-kind-icon">pan<wbr/>To</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#scrollLeft" class="tsd-kind-icon">scroll<wbr/>Left</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#scrollTop" class="tsd-kind-icon">scroll<wbr/>Top</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#scrollbars" class="tsd-kind-icon">scrollbars</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#stop" class="tsd-kind-icon">stop</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#t0x" class="tsd-kind-icon">t0x</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#t0y" class="tsd-kind-icon">t0y</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#tdx" class="tsd-kind-icon">tdx</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#tdy" class="tsd-kind-icon">tdy</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningManager.html#thread" class="tsd-kind-icon">thread</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 id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature t
<p>Border to handle automatic panning inside the component. Default is 0 (disabled).</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="damper" class="tsd-anchor"></a><h3>damper</h3><div class="tsd-signature tsd-kind-icon">damper<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/PanningManager.ts#L201">view/other/PanningManager.ts:201</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Damper value for the panning. Default is 1/6.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="delay" class="tsd-anchor"></a><h3>delay</h3><div class="tsd-signature tsd-kind-icon">delay<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/PanningManager.ts#L206">view/other/PanningManager.ts:206</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Delay in milliseconds for the panning. Default is 10.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="destroy" class="tsd-anchor"></a><h3>destroy</h3><div class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/PanningManager.ts#L242">view/other/PanningManager.ts:242</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="dx" class="tsd-anchor"></a><h3>dx</h3><div class="tsd-signature tsd-kind-icon">dx<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/PanningManager.ts#L226">view/other/PanningManager.ts:226</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="dy" class="tsd-anchor"></a><h3>dy</h3><div class="tsd-signature tsd-kind-icon">dy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/PanningManager.ts#L227">view/other/PanningManager.ts:227</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="getDx" class="tsd-anchor"></a><h3>get<wbr/>Dx</h3><div class="tsd-signature tsd-kind-icon">get<wbr/>Dx<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/PanningManager.ts#L238">view/other/PanningManager.ts:238</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="getDy" class="tsd-anchor"></a><h3>get<wbr/>Dy</h3><div class="tsd-signature tsd-kind-icon">get<wbr/>Dy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/P
<p>Specifies if mouse events outside of the component should be handled. Default is true.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="isActive" class="tsd-anchor"></a><h3>is<wbr/>Active</h3><div class="tsd-signature tsd-kind-icon">is<wbr/>Active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/PanningManager.ts#L237">view/other/PanningManager.ts:237</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="mouseListener" class="tsd-anchor"></a><h3>mouse<wbr/>Listener</h3><div class="tsd-signature tsd-kind-icon">mouse<wbr/>Listener<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MouseListenerSet</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/PanningManager.ts#L232">view/other/PanningManager.ts:232</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="mouseUpListener" class="tsd-anchor"></a><h3>mouse<wbr/>Up<wbr/>Listener</h3><div class="tsd-signature tsd-kind-icon">mouse<wbr/>Up<wbr/>Listener<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MouseEventListener</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/PanningManager.ts#L234">view/other/PanningManager.ts:234</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="panTo" class="tsd-anchor"></a><h3>pan<wbr/>To</h3><div class="tsd-signature tsd-kind-icon">pan<wbr/>To<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, w<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, h<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/PanningManager.ts#L241">view/other/PanningManager.ts:241</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, w<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, h<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol