129 lines
80 KiB
HTML
129 lines
80 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PanningHandler | @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="PanningHandler.html">PanningHandler</a></li></ul><h1>Class PanningHandler</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>Event handler that pans and creates popupmenus. To use the left
|
|
mousebutton for panning without interfering with cell moving and
|
|
resizing, use <isUseLeftButton> and <isIgnoreCell>. For grid size
|
|
steps while panning, use <useGrid>. This handler is built-into
|
|
{@link Graph#panningHandler} and enabled using {@link Graph#setPanning}.</p>
|
|
</div><div><p>Constructor: mxPanningHandler</p>
|
|
<p>Constructs an event handler that creates a {@link PopupMenu}
|
|
and pans the graph.</p>
|
|
<p>Event: mxEvent.PAN_START</p>
|
|
<p>Fires when the panning handler changes its <active> state to true. The
|
|
<code>event</code> property contains the corresponding {@link MouseEvent}.</p>
|
|
<p>Event: mxEvent.PAN</p>
|
|
<p>Fires while handle is processing events. The <code>event</code> property contains
|
|
the corresponding {@link MouseEvent}.</p>
|
|
<p>Event: mxEvent.PAN_END</p>
|
|
<p>Fires when the panning handler changes its <active> state to false. The
|
|
<code>event</code> property contains the corresponding {@link MouseEvent}.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a><ul class="tsd-hierarchy"><li><span class="target">PanningHandler</span></li></ul></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">GraphPlugin</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 tsd-is-overwrite"><a href="PanningHandler.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="PanningHandler.html#active" class="tsd-kind-icon">active</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#dx" class="tsd-kind-icon">dx</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#dx0" class="tsd-kind-icon">dx0</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#dy" class="tsd-kind-icon">dy</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#dy0" class="tsd-kind-icon">dy0</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#eventListeners" class="tsd-kind-icon">event<wbr/>Listeners</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#eventSource" class="tsd-kind-icon">event<wbr/>Source</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#eventsEnabled" class="tsd-kind-icon">events<wbr/>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#forcePanningHandler" class="tsd-kind-icon">force<wbr/>Panning<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#gestureHandler" class="tsd-kind-icon">gesture<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#graph" class="tsd-kind-icon">graph</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#ignoreCell" class="tsd-kind-icon">ignore<wbr/>Cell</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#initialScale" class="tsd-kind-icon">initial<wbr/>Scale</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#maxScale" class="tsd-kind-icon">max<wbr/>Scale</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#minScale" class="tsd-kind-icon">min<wbr/>Scale</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#mouseDownEvent" class="tsd-kind-icon">mouse<wbr/>Down<wbr/>Event</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#mouseUpListener" class="tsd-kind-icon">mouse<wbr/>Up<wbr/>Listener</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#panningEnabled" class="tsd-kind-icon">panning<wbr/>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#panningManager" class="tsd-kind-icon">panning<wbr/>Manager</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#panningTrigger" class="tsd-kind-icon">panning<wbr/>Trigger</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#pinchEnabled" class="tsd-kind-icon">pinch<wbr/>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#previewEnabled" class="tsd-kind-icon">preview<wbr/>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#startX" class="tsd-kind-icon">startX</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#startY" class="tsd-kind-icon">startY</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#useGrid" class="tsd-kind-icon">use<wbr/>Grid</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#useLeftButtonForPanning" class="tsd-kind-icon">use<wbr/>Left<wbr/>Button<wbr/>For<wbr/>Panning</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#usePopupTrigger" class="tsd-kind-icon">use<wbr/>Popup<wbr/>Trigger</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="PanningHandler.html#pluginId" class="tsd-kind-icon">plugin<wbr/>Id</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 tsd-is-inherited"><a href="PanningHandler.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#consumePanningTrigger" class="tsd-kind-icon">consume<wbr/>Panning<wbr/>Trigger</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#fireEvent" class="tsd-kind-icon">fire<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#getEventSource" class="tsd-kind-icon">get<wbr/>Event<wbr/>Source</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#getPanningManager" class="tsd-kind-icon">get<wbr/>Panning<wbr/>Manager</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#isActive" class="tsd-kind-icon">is<wbr/>Active</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#isEventsEnabled" class="tsd-kind-icon">is<wbr/>Events<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#isForcePanningEvent" class="tsd-kind-icon">is<wbr/>Force<wbr/>Panning<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#isPanningEnabled" class="tsd-kind-icon">is<wbr/>Panning<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#isPanningTrigger" class="tsd-kind-icon">is<wbr/>Panning<wbr/>Trigger</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#isPinchEnabled" class="tsd-kind-icon">is<wbr/>Pinch<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#mouseDown" class="tsd-kind-icon">mouse<wbr/>Down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#mouseMove" class="tsd-kind-icon">mouse<wbr/>Move</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#mouseUp" class="tsd-kind-icon">mouse<wbr/>Up</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#onDestroy" class="tsd-kind-icon">on<wbr/>Destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#panGraph" class="tsd-kind-icon">pan<wbr/>Graph</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#reset" class="tsd-kind-icon">reset</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#setEventSource" class="tsd-kind-icon">set<wbr/>Event<wbr/>Source</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#setEventsEnabled" class="tsd-kind-icon">set<wbr/>Events<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#setPanningEnabled" class="tsd-kind-icon">set<wbr/>Panning<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#setPinchEnabled" class="tsd-kind-icon">set<wbr/>Pinch<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#zoomGraph" class="tsd-kind-icon">zoom<wbr/>Graph</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 tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Panning<wbr/>Handler<span class="tsd-signature-symbol">(</span>graph<span class="tsd-signature-symbol">: </span><a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PanningHandler.html" class="tsd-signature-type" data-tsd-kind="Class">PanningHandler</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="EventSource.html">EventSource</a>.<a href="EventSource.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L55">view/handler/PanningHandler.ts:55</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>graph: <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="PanningHandler.html" class="tsd-signature-type" data-tsd-kind="Class">PanningHandler</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 id="active" class="tsd-anchor"></a><h3>active</h3><div class="tsd-signature tsd-kind-icon">active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L197">view/handler/PanningHandler.ts:197</a></li></ul></aside></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/handler/PanningHandler.ts#L175">view/handler/PanningHandler.ts:175</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Holds the current horizontal offset.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="dx0" class="tsd-anchor"></a><h3>dx0</h3><div class="tsd-signature tsd-kind-icon">dx0<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/handler/PanningHandler.ts#L192">view/handler/PanningHandler.ts:192</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/handler/PanningHandler.ts#L180">view/handler/PanningHandler.ts:180</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Holds the current vertical offset.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="dy0" class="tsd-anchor"></a><h3>dy0</h3><div class="tsd-signature tsd-kind-icon">dy0<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/handler/PanningHandler.ts#L193">view/handler/PanningHandler.ts:193</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="eventListeners" class="tsd-anchor"></a><h3>event<wbr/>Listeners</h3><div class="tsd-signature tsd-kind-icon">event<wbr/>Listeners<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventListenerObject</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><p>Inherited from <a href="EventSource.html">EventSource</a>.<a href="EventSource.html#eventListeners">eventListeners</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventSource.ts#L45">view/event/EventSource.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Holds the event names and associated listeners in an array. The array
|
|
contains the event name followed by the respective listener for each
|
|
registered listener.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="eventSource" class="tsd-anchor"></a><h3>event<wbr/>Source</h3><div class="tsd-signature tsd-kind-icon">event<wbr/>Source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventTarget</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><p>Inherited from <a href="EventSource.html">EventSource</a>.<a href="EventSource.html#eventSource">eventSource</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventSource.ts#L55">view/event/EventSource.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional source for events. Default is null.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="eventsEnabled" class="tsd-anchor"></a><h3>events<wbr/>Enabled</h3><div class="tsd-signature tsd-kind-icon">events<wbr/>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><p>Inherited from <a href="EventSource.html">EventSource</a>.<a href="EventSource.html#eventsEnabled">eventsEnabled</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventSource.ts#L50">view/event/EventSource.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if events can be fired. Default is true.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="forcePanningHandler" class="tsd-anchor"></a><h3>force<wbr/>Panning<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">force<wbr/>Panning<wbr/>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a>, evt<span class="tsd-signature-symbol">: </span><a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </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/handler/PanningHandler.ts#L199">view/handler/PanningHandler.ts:199</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>sender<span class="tsd-signature-symbol">: </span><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a>, evt<span class="tsd-signature-symbol">: </span><a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</a><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-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sender: <a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a></h5></li><li><h5>evt: <a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</a></h5></li></ul><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="gestureHandler" class="tsd-anchor"></a><h3>gesture<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">gesture<wbr/>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a>, evt<span class="tsd-signature-symbol">: </span><a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </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/handler/PanningHandler.ts#L200">view/handler/PanningHandler.ts:200</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>sender<span class="tsd-signature-symbol">: </span><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a>, evt<span class="tsd-signature-symbol">: </span><a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</a><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-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sender: <a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a></h5></li><li><h5>evt: <a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</a></h5></li></ul><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="graph" class="tsd-anchor"></a><h3>graph</h3><div class="tsd-signature tsd-kind-icon">graph<span class="tsd-signature-symbol">:</span> <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L116">view/handler/PanningHandler.ts:116</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Reference to the enclosing <a href="Graph.html">Graph</a>.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="ignoreCell" class="tsd-anchor"></a><h3>ignore<wbr/>Cell</h3><div class="tsd-signature tsd-kind-icon">ignore<wbr/>Cell<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L137">view/handler/PanningHandler.ts:137</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if panning should be active even if there is a cell under the
|
|
mousepointer. Default is false.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="initialScale" class="tsd-anchor"></a><h3>initial<wbr/>Scale</h3><div class="tsd-signature tsd-kind-icon">initial<wbr/>Scale<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/handler/PanningHandler.ts#L160">view/handler/PanningHandler.ts:160</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="maxScale" class="tsd-anchor"></a><h3>max<wbr/>Scale</h3><div class="tsd-signature tsd-kind-icon">max<wbr/>Scale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 8</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L165">view/handler/PanningHandler.ts:165</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies the maximum scale. Default is 8.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="minScale" class="tsd-anchor"></a><h3>min<wbr/>Scale</h3><div class="tsd-signature tsd-kind-icon">min<wbr/>Scale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.01</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L170">view/handler/PanningHandler.ts:170</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies the minimum scale. Default is 0.01.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="mouseDownEvent" class="tsd-anchor"></a><h3>mouse<wbr/>Down<wbr/>Event</h3><div class="tsd-signature tsd-kind-icon">mouse<wbr/>Down<wbr/>Event<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L204">view/handler/PanningHandler.ts:204</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/handler/PanningHandler.ts#L202">view/handler/PanningHandler.ts:202</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="panningEnabled" class="tsd-anchor"></a><h3>panning<wbr/>Enabled</h3><div class="tsd-signature tsd-kind-icon">panning<wbr/>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L153">view/handler/PanningHandler.ts:153</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if panning should be enabled. Default is false.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="panningManager" class="tsd-anchor"></a><h3>panning<wbr/>Manager</h3><div class="tsd-signature tsd-kind-icon">panning<wbr/>Manager<span class="tsd-signature-symbol">:</span> <a href="PanningManager.html" class="tsd-signature-type" data-tsd-kind="Class">PanningManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L118">view/handler/PanningHandler.ts:118</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="panningTrigger" class="tsd-anchor"></a><h3>panning<wbr/>Trigger</h3><div class="tsd-signature tsd-kind-icon">panning<wbr/>Trigger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L195">view/handler/PanningHandler.ts:195</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="pinchEnabled" class="tsd-anchor"></a><h3>pinch<wbr/>Enabled</h3><div class="tsd-signature tsd-kind-icon">pinch<wbr/>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L158">view/handler/PanningHandler.ts:158</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if pinch gestures should be handled as zoom. Default is true.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="previewEnabled" class="tsd-anchor"></a><h3>preview<wbr/>Enabled</h3><div class="tsd-signature tsd-kind-icon">preview<wbr/>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L142">view/handler/PanningHandler.ts:142</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if the panning should be previewed. Default is true.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="startX" class="tsd-anchor"></a><h3>startX</h3><div class="tsd-signature tsd-kind-icon">startX<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/handler/PanningHandler.ts#L185">view/handler/PanningHandler.ts:185</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Holds the x-coordinate of the start point.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="startY" class="tsd-anchor"></a><h3>startY</h3><div class="tsd-signature tsd-kind-icon">startY<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/handler/PanningHandler.ts#L190">view/handler/PanningHandler.ts:190</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Holds the y-coordinate of the start point.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="useGrid" class="tsd-anchor"></a><h3>use<wbr/>Grid</h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Grid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L148">view/handler/PanningHandler.ts:148</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if the panning steps should be aligned to the grid size.
|
|
Default is false.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="useLeftButtonForPanning" class="tsd-anchor"></a><h3>use<wbr/>Left<wbr/>Button<wbr/>For<wbr/>Panning</h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Left<wbr/>Button<wbr/>For<wbr/>Panning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L126">view/handler/PanningHandler.ts:126</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if panning should be active for the left mouse button.
|
|
Setting this to true may conflict with {@link Rubberband}. Default is false.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="usePopupTrigger" class="tsd-anchor"></a><h3>use<wbr/>Popup<wbr/>Trigger</h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Popup<wbr/>Trigger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L131">view/handler/PanningHandler.ts:131</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if {@link Event#isPopupTrigger} should also be used for panning.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="pluginId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> plugin<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">plugin<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'PanningHandler'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L53">view/handler/PanningHandler.ts:53</a></li></ul></aside></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 tsd-is-inherited"><a id="addListener" class="tsd-anchor"></a><h3>add<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, funct<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</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"><aside class="tsd-sources"><p>Inherited from <a href="EventSource.html">EventSource</a>.<a href="EventSource.html#addListener">addListener</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventSource.ts#L91">view/event/EventSource.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Binds the specified function to the given event name. If no event name
|
|
is given, then the listener is registered for all events.</p>
|
|
</div><div><p>The parameters of the listener are the sender and an <a href="EventObject.html">EventObject</a>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5></li><li><h5>funct: <span class="tsd-signature-type">Function</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 id="consumePanningTrigger" class="tsd-anchor"></a><h3>consume<wbr/>Panning<wbr/>Trigger</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">consume<wbr/>Panning<wbr/>Trigger<span class="tsd-signature-symbol">(</span>me<span class="tsd-signature-symbol">: </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L325">view/handler/PanningHandler.ts:325</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Consumes the given {@link MouseEvent} if it was a panning trigger in
|
|
{@link ouseDown}. The default is to invoke {@link MouseEvent#consume}. Note that this
|
|
will block any further event processing. If you haven't disabled built-in
|
|
context menus and require immediate selection of the cell on mouseDown in
|
|
Safari and/or on the Mac, then use the following code:</p>
|
|
</div><div><pre><code class="language-javascript"><span class="hl-2">consumePanningTrigger</span><span class="hl-1">(</span><span class="hl-0">me</span><span class="hl-1">)</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (</span><span class="hl-0">me</span><span class="hl-1">.</span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-0">preventDefault</span><span class="hl-1">)</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">me</span><span class="hl-1">.</span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-2">preventDefault</span><span class="hl-1">();</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-4">// Stops event processing in IE</span><br/><span class="hl-1"> </span><span class="hl-0">me</span><span class="hl-1">.</span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-0">returnValue</span><span class="hl-1"> = </span><span class="hl-3">false</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-4">// Sets local consumed state</span><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (!</span><span class="hl-0">Client</span><span class="hl-1">.</span><span class="hl-7">IS_SF</span><span class="hl-1"> && !</span><span class="hl-0">Client</span><span class="hl-1">.</span><span class="hl-7">IS_MAC</span><span class="hl-1">)</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">me</span><span class="hl-1">.</span><span class="hl-0">consumed</span><span class="hl-1"> = </span><span class="hl-3">true</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">};</span>
|
|
</code></pre>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>me: <a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a></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 tsd-is-inherited"><a id="fireEvent" class="tsd-anchor"></a><h3>fire<wbr/>Event</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">fire<wbr/>Event<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</a>, sender<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventTarget</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"><aside class="tsd-sources"><p>Inherited from <a href="EventSource.html">EventSource</a>.<a href="EventSource.html#fireEvent">fireEvent</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventSource.ts#L125">view/event/EventSource.ts:125</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Dispatches the given event to the listeners which are registered for
|
|
the event. The sender argument is optional. The current execution scope
|
|
("this") is used for the listener invocation (see {@link Utils#bind}).</p>
|
|
</div><div><p>Example:</p>
|
|
<pre><code class="language-javascript"><span class="hl-2">fireEvent</span><span class="hl-1">(</span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-2">mxEventObject</span><span class="hl-1">(</span><span class="hl-6">"eventName"</span><span class="hl-1">, </span><span class="hl-0">key1</span><span class="hl-1">, </span><span class="hl-0">val1</span><span class="hl-1">, .., </span><span class="hl-0">keyN</span><span class="hl-1">, </span><span class="hl-0">valN</span><span class="hl-1">))</span>
|
|
</code></pre>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><a href="EventObject.html">EventObject</a> that represents the event.</p>
|
|
</div></div></li><li><h5>sender: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventTarget</span><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional sender to be passed to the listener. Default value is
|
|
the return value of <getEventSource>.</p>
|
|
</div></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 tsd-is-inherited"><a id="getEventSource" class="tsd-anchor"></a><h3>get<wbr/>Event<wbr/>Source</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Event<wbr/>Source<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventTarget</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="EventSource.html">EventSource</a>.<a href="EventSource.html#getEventSource">getEventSource</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventSource.ts#L74">view/event/EventSource.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns <eventSource>.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventTarget</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPanningManager" class="tsd-anchor"></a><h3>get<wbr/>Panning<wbr/>Manager</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Panning<wbr/>Manager<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PanningManager.html" class="tsd-signature-type" data-tsd-kind="Class">PanningManager</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L120">view/handler/PanningHandler.ts:120</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="PanningManager.html" class="tsd-signature-type" data-tsd-kind="Class">PanningManager</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isActive" class="tsd-anchor"></a><h3>is<wbr/>Active</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li 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-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L209">view/handler/PanningHandler.ts:209</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the handler is currently active.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="isEventsEnabled" class="tsd-anchor"></a><h3>is<wbr/>Events<wbr/>Enabled</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Events<wbr/>Enabled<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"><aside class="tsd-sources"><p>Inherited from <a href="EventSource.html">EventSource</a>.<a href="EventSource.html#isEventsEnabled">isEventsEnabled</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventSource.ts#L60">view/event/EventSource.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns <eventsEnabled>.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isForcePanningEvent" class="tsd-anchor"></a><h3>is<wbr/>Force<wbr/>Panning<wbr/>Event</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Force<wbr/>Panning<wbr/>Event<span class="tsd-signature-symbol">(</span>me<span class="tsd-signature-symbol">: </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L261">view/handler/PanningHandler.ts:261</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the given {@link MouseEvent} should start panning. This
|
|
implementation always returns true if <ignoreCell> is true or for
|
|
multi touch events.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>me: <a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isPanningEnabled" class="tsd-anchor"></a><h3>is<wbr/>Panning<wbr/>Enabled</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Panning<wbr/>Enabled<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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L216">view/handler/PanningHandler.ts:216</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns <panningEnabled>.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isPanningTrigger" class="tsd-anchor"></a><h3>is<wbr/>Panning<wbr/>Trigger</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Panning<wbr/>Trigger<span class="tsd-signature-symbol">(</span>me<span class="tsd-signature-symbol">: </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L246">view/handler/PanningHandler.ts:246</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the given event is a panning trigger for the optional
|
|
given cell. This returns true if control-shift is pressed or if
|
|
<usePopupTrigger> is true and the event is a popup trigger.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>me: <a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isPinchEnabled" class="tsd-anchor"></a><h3>is<wbr/>Pinch<wbr/>Enabled</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Pinch<wbr/>Enabled<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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L230">view/handler/PanningHandler.ts:230</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns <pinchEnabled>.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="mouseDown" class="tsd-anchor"></a><h3>mouse<wbr/>Down</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">mouse<wbr/>Down<span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a>, me<span class="tsd-signature-symbol">: </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L269">view/handler/PanningHandler.ts:269</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Handles the event by initiating the panning. By consuming the event all
|
|
subsequent events of the gesture are redirected to this handler.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sender: <a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a></h5></li><li><h5>me: <a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a></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 id="mouseMove" class="tsd-anchor"></a><h3>mouse<wbr/>Move</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">mouse<wbr/>Move<span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a>, me<span class="tsd-signature-symbol">: </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L332">view/handler/PanningHandler.ts:332</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Handles the event by updating the panning on the graph.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sender: <a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a></h5></li><li><h5>me: <a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a></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 id="mouseUp" class="tsd-anchor"></a><h3>mouse<wbr/>Up</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">mouse<wbr/>Up<span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a>, me<span class="tsd-signature-symbol">: </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L371">view/handler/PanningHandler.ts:371</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Handles the event by setting the translation on the view or showing the
|
|
popupmenu.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sender: <a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a></h5></li><li><h5>me: <a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a></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 id="onDestroy" class="tsd-anchor"></a><h3>on<wbr/>Destroy</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">on<wbr/>Destroy<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"><aside class="tsd-sources"><p>Implementation of GraphPlugin.onDestroy</p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L431">view/handler/PanningHandler.ts:431</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Destroys the handler and all its resources and DOM nodes.</p>
|
|
</div></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 id="panGraph" class="tsd-anchor"></a><h3>pan<wbr/>Graph</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">pan<wbr/>Graph<span class="tsd-signature-symbol">(</span>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, dy<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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L424">view/handler/PanningHandler.ts:424</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Pans <graph> by the given amount.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dx: <span class="tsd-signature-type">number</span></h5></li><li><h5>dy: <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 tsd-is-inherited"><a id="removeListener" class="tsd-anchor"></a><h3>remove<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>funct<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</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"><aside class="tsd-sources"><p>Inherited from <a href="EventSource.html">EventSource</a>.<a href="EventSource.html#removeListener">removeListener</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventSource.ts#L98">view/event/EventSource.ts:98</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Removes all occurrences of the given listener from <eventListeners>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>funct: <span class="tsd-signature-type">Function</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 id="reset" class="tsd-anchor"></a><h3>reset</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">reset<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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L413">view/handler/PanningHandler.ts:413</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Handles the event by setting the translation on the view or showing the
|
|
popupmenu.</p>
|
|
</div></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 tsd-is-inherited"><a id="setEventSource" class="tsd-anchor"></a><h3>set<wbr/>Event<wbr/>Source</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">set<wbr/>Event<wbr/>Source<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventTarget</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"><aside class="tsd-sources"><p>Inherited from <a href="EventSource.html">EventSource</a>.<a href="EventSource.html#setEventSource">setEventSource</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventSource.ts#L81">view/event/EventSource.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets <eventSource>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EventTarget</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 tsd-is-inherited"><a id="setEventsEnabled" class="tsd-anchor"></a><h3>set<wbr/>Events<wbr/>Enabled</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">set<wbr/>Events<wbr/>Enabled<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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"><aside class="tsd-sources"><p>Inherited from <a href="EventSource.html">EventSource</a>.<a href="EventSource.html#setEventsEnabled">setEventsEnabled</a></p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/event/EventSource.ts#L67">view/event/EventSource.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets <eventsEnabled>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">boolean</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 id="setPanningEnabled" class="tsd-anchor"></a><h3>set<wbr/>Panning<wbr/>Enabled</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Panning<wbr/>Enabled<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L223">view/handler/PanningHandler.ts:223</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets <panningEnabled>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">boolean</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 id="setPinchEnabled" class="tsd-anchor"></a><h3>set<wbr/>Pinch<wbr/>Enabled</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Pinch<wbr/>Enabled<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L237">view/handler/PanningHandler.ts:237</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets <pinchEnabled>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">boolean</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 id="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>me<span class="tsd-signature-symbol">: </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L286">view/handler/PanningHandler.ts:286</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Starts panning at the given event.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>me: <a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a></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 id="zoomGraph" class="tsd-anchor"></a><h3>zoom<wbr/>Graph</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">zoom<wbr/>Graph<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Event</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"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/PanningHandler.ts#L397">view/handler/PanningHandler.ts:397</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Zooms the graph to the given value and consumed the event if needed.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <span class="tsd-signature-type">Event</span></h5></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=""><a href="../index.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/DomHelpers.html">Dom<wbr/>Helpers</a></li><li class=" tsd-kind-namespace"><a href="../modules/cloneUtils.html">clone<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/constants.html">constants</a></li><li class=" tsd-kind-namespace"><a href="../modules/domUtils.html">dom<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/eventUtils.html">event<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/gestureUtils.html">gesture<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/mathUtils.html">math<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/stringUtils.html">string<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/styleUtils.html">style<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/xmlUtils.html">xml<wbr/>Utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="PanningHandler.html" class="tsd-kind-icon">Panning<wbr/>Handler</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="PanningHandler.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#active" class="tsd-kind-icon">active</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#dx" class="tsd-kind-icon">dx</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#dx0" class="tsd-kind-icon">dx0</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#dy" class="tsd-kind-icon">dy</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#dy0" class="tsd-kind-icon">dy0</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#eventListeners" class="tsd-kind-icon">event<wbr/>Listeners</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#eventSource" class="tsd-kind-icon">event<wbr/>Source</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#eventsEnabled" class="tsd-kind-icon">events<wbr/>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#forcePanningHandler" class="tsd-kind-icon">force<wbr/>Panning<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#gestureHandler" class="tsd-kind-icon">gesture<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#graph" class="tsd-kind-icon">graph</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#ignoreCell" class="tsd-kind-icon">ignore<wbr/>Cell</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#initialScale" class="tsd-kind-icon">initial<wbr/>Scale</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#maxScale" class="tsd-kind-icon">max<wbr/>Scale</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#minScale" class="tsd-kind-icon">min<wbr/>Scale</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#mouseDownEvent" class="tsd-kind-icon">mouse<wbr/>Down<wbr/>Event</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#mouseUpListener" class="tsd-kind-icon">mouse<wbr/>Up<wbr/>Listener</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#panningEnabled" class="tsd-kind-icon">panning<wbr/>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#panningManager" class="tsd-kind-icon">panning<wbr/>Manager</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#panningTrigger" class="tsd-kind-icon">panning<wbr/>Trigger</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#pinchEnabled" class="tsd-kind-icon">pinch<wbr/>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#previewEnabled" class="tsd-kind-icon">preview<wbr/>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#startX" class="tsd-kind-icon">startX</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#startY" class="tsd-kind-icon">startY</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#useGrid" class="tsd-kind-icon">use<wbr/>Grid</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#useLeftButtonForPanning" class="tsd-kind-icon">use<wbr/>Left<wbr/>Button<wbr/>For<wbr/>Panning</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PanningHandler.html#usePopupTrigger" class="tsd-kind-icon">use<wbr/>Popup<wbr/>Trigger</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="PanningHandler.html#pluginId" class="tsd-kind-icon">plugin<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#consumePanningTrigger" class="tsd-kind-icon">consume<wbr/>Panning<wbr/>Trigger</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#fireEvent" class="tsd-kind-icon">fire<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#getEventSource" class="tsd-kind-icon">get<wbr/>Event<wbr/>Source</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#getPanningManager" class="tsd-kind-icon">get<wbr/>Panning<wbr/>Manager</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#isActive" class="tsd-kind-icon">is<wbr/>Active</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#isEventsEnabled" class="tsd-kind-icon">is<wbr/>Events<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#isForcePanningEvent" class="tsd-kind-icon">is<wbr/>Force<wbr/>Panning<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#isPanningEnabled" class="tsd-kind-icon">is<wbr/>Panning<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#isPanningTrigger" class="tsd-kind-icon">is<wbr/>Panning<wbr/>Trigger</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#isPinchEnabled" class="tsd-kind-icon">is<wbr/>Pinch<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#mouseDown" class="tsd-kind-icon">mouse<wbr/>Down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#mouseMove" class="tsd-kind-icon">mouse<wbr/>Move</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#mouseUp" class="tsd-kind-icon">mouse<wbr/>Up</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#onDestroy" class="tsd-kind-icon">on<wbr/>Destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#panGraph" class="tsd-kind-icon">pan<wbr/>Graph</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#reset" class="tsd-kind-icon">reset</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#setEventSource" class="tsd-kind-icon">set<wbr/>Event<wbr/>Source</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="PanningHandler.html#setEventsEnabled" class="tsd-kind-icon">set<wbr/>Events<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#setPanningEnabled" class="tsd-kind-icon">set<wbr/>Panning<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#setPinchEnabled" class="tsd-kind-icon">set<wbr/>Pinch<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="PanningHandler.html#zoomGraph" class="tsd-kind-icon">zoom<wbr/>Graph</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |