maxGraph/docs/js-api/files/handler/mxPanningHandler-js.html

128 lines
62 KiB
HTML
Raw Normal View History

2012-05-21 20:32:26 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
2017-06-27 11:43:19 +00:00
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>mxPanningHandler</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/prettify.js"></script><script language=JavaScript src="../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
2012-05-21 20:32:26 +00:00
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
2017-06-27 11:43:19 +00:00
<!-- Generated by Natural Docs, version 1.51 -->
2012-05-21 20:32:26 +00:00
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
2018-01-19 15:30:59 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxPanningHandler"></a>mxPanningHandler</h1><div class=CBody><p>Event handler that pans and creates popupmenus.&nbsp; To use the left mousebutton for panning without interfering with cell moving and resizing, use &lt;isUseLeftButton&gt; and &lt;isIgnoreCell&gt;.&nbsp; For grid size steps while panning, use <a href="#mxPanningHandler.useGrid" class=LVariable id=link40 onMouseOver="ShowTip(event, 'tt9', 'link40')" onMouseOut="HideTip('tt9')">useGrid</a>.&nbsp; This handler is built-into &lt;mxGraph.panningHandler&gt; and enabled using <a href="../view/mxGraph-js.html#mxGraph.setPanning" class=LFunction id=link41 onMouseOver="ShowTip(event, 'tt33', 'link41')" onMouseOut="HideTip('tt33')">mxGraph.setPanning</a>.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#mxPanningHandler" >mxPanningHandler</a></td><td class=SDescription>Event handler that pans and creates popupmenus. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxPanningHandler.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxPanningHandler.mxPanningHandler" >mxPanningHandler</a></td><td class=SDescription>Constructs an event handler that creates a <a href="../util/mxPopupMenu-js.html#mxPopupMenu" class=LClass id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxPopupMenu</a> and pans the graph.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxPanningHandler.Events" >Events</a></td><td class=SDescription></td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#mxPanningHandler.mxEvent.PAN_START" >mxEvent.<wbr>PAN_START</a></td><td class=SDescription>Fires when the panning handler changes its &lt;active&gt; state to true. </td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#mxPanningHandler.mxEvent.PAN" >mxEvent.PAN</a></td><td class=SDescription>Fires while handle is processing events. </td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#mxPanningHandler.mxEvent.PAN_END" >mxEvent.<wbr>PAN_END</a></td><td class=SDescription>Fires when the panning handler changes its &lt;active&gt; state to false. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxPanningHandler.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxPanningHandler.graph" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">graph</a></td><td class=SDescription>Reference to the enclosing <a href="../view/mxGraph-js.html#mxGraph" class=LClass id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">mxGraph</a>.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxPanningHandler.useLeftButtonForPanning" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">useLeftButtonForPanning</a></td><td class=SDescription>Specifies if panning should be active for the left mouse button. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxPanningHandler.usePopupTrigger" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">usePopupTrigger</a></td><td class=SDescription>Specifies if <a href="../util/mxEvent-js.html#mxEvent.isPopupTrigger" class=LFunction id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">mxEvent.isPopupTrigger</a> should also be used for panning.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxPanningHandler.ignoreCell" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">ignoreCell</a></td><td class=SDescription>Specifies if panning should be active even if there is a cell under the mousepointer. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=S
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.Functions"></a>Functions</h3></div></div>
2014-05-15 19:58:36 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.mxPanningHandler"></a>mxPanningHandler</h3><div class=CBody><p>Constructs an event handler that creates a <a href="../util/mxPopupMenu-js.html#mxPopupMenu" class=LClass id=link42 onMouseOver="ShowTip(event, 'tt1', 'link42')" onMouseOut="HideTip('tt1')">mxPopupMenu</a> and pans the graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.Events"></a>Events</h3></div></div>
2014-05-15 19:58:36 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.mxEvent.PAN_START"></a>mxEvent.<wbr>PAN_START</h3><div class=CBody><p>Fires when the panning handler changes its &lt;active&gt; state to true.&nbsp; The &lt;code&gt;event&lt;/code&gt; property contains the corresponding <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link43 onMouseOver="ShowTip(event, 'tt25', 'link43')" onMouseOut="HideTip('tt25')">mxMouseEvent</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2014-05-15 19:58:36 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.mxEvent.PAN"></a>mxEvent.PAN</h3><div class=CBody><p>Fires while handle is processing events.&nbsp; The &lt;code&gt;event&lt;/code&gt; property contains the corresponding <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link44 onMouseOver="ShowTip(event, 'tt25', 'link44')" onMouseOut="HideTip('tt25')">mxMouseEvent</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2014-05-15 19:58:36 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.mxEvent.PAN_END"></a>mxEvent.<wbr>PAN_END</h3><div class=CBody><p>Fires when the panning handler changes its &lt;active&gt; state to false.&nbsp; The &lt;code&gt;event&lt;/code&gt; property contains the corresponding <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link45 onMouseOver="ShowTip(event, 'tt25', 'link45')" onMouseOut="HideTip('tt25')">mxMouseEvent</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.Variables"></a>Variables</h3></div></div>
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.graph"></a>graph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.graph</td></tr></table></blockquote><p>Reference to the enclosing <a href="../view/mxGraph-js.html#mxGraph" class=LClass id=link46 onMouseOver="ShowTip(event, 'tt3', 'link46')" onMouseOut="HideTip('tt3')">mxGraph</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.useLeftButtonForPanning"></a>useLeftButtonForPanning</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.useLeftButtonForPanning</td></tr></table></blockquote><p>Specifies if panning should be active for the left mouse button.&nbsp; Setting this to true may conflict with <a href="mxRubberband-js.html#mxRubberband" class=LClass id=link47 onMouseOver="ShowTip(event, 'tt34', 'link47')" onMouseOut="HideTip('tt34')">mxRubberband</a>.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.usePopupTrigger"></a>usePopupTrigger</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.usePopupTrigger</td></tr></table></blockquote><p>Specifies if <a href="../util/mxEvent-js.html#mxEvent.isPopupTrigger" class=LFunction id=link48 onMouseOver="ShowTip(event, 'tt6', 'link48')" onMouseOut="HideTip('tt6')">mxEvent.isPopupTrigger</a> should also be used for panning.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.ignoreCell"></a>ignoreCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.ignoreCell</td></tr></table></blockquote><p>Specifies if panning should be active even if there is a cell under the mousepointer.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.previewEnabled"></a>previewEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.previewEnabled</td></tr></table></blockquote><p>Specifies if the panning should be previewed.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.useGrid"></a>useGrid</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.useGrid</td></tr></table></blockquote><p>Specifies if the panning steps should be aligned to the grid size.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.panningEnabled"></a>panningEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.panningEnabled</td></tr></table></blockquote><p>Specifies if panning should be enabled.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.pinchEnabled"></a>pinchEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.pinchEnabled</td></tr></table></blockquote><p>Specifies if pinch gestures should be handled as zoom.&nbsp; Default is true.</p></div></div></div>
2014-05-12 09:58:11 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.maxScale"></a>maxScale</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.maxScale</td></tr></table></blockquote><p>Specifies the maximum scale.&nbsp; Default is 8.</p></div></div></div>
2014-05-12 09:58:11 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.minScale"></a>minScale</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.minScale</td></tr></table></blockquote><p>Specifies the minimum scale.&nbsp; Default is 0.01.</p></div></div></div>
2014-05-12 09:58:11 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.dx"></a>dx</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.dx</td></tr></table></blockquote><p>Holds the current horizontal offset.</p></div></div></div>
2014-05-15 19:58:36 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.dy"></a>dy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.dy</td></tr></table></blockquote><p>Holds the current vertical offset.</p></div></div></div>
2014-05-15 19:58:36 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.startX"></a>startX</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.startX</td></tr></table></blockquote><p>Holds the x-coordinate of the start point.</p></div></div></div>
2014-05-15 19:58:36 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.startY"></a>startY</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.startY</td></tr></table></blockquote><p>Holds the y-coordinate of the start point.</p></div></div></div>
2014-05-15 19:58:36 +00:00
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.Functions"></a>Functions</h3></div></div>
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.isActive"></a>isActive</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.isActive = function()</td></tr></table></blockquote><p>Returns true if the handler is currently active.</p></div></div></div>
2014-05-12 09:58:11 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.isPanningEnabled"></a>isPanningEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.isPanningEnabled = function()</td></tr></table></blockquote><p>Returns <a href="#mxPanningHandler.panningEnabled" class=LVariable id=link49 onMouseOver="ShowTip(event, 'tt10', 'link49')" onMouseOut="HideTip('tt10')">panningEnabled</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.setPanningEnabled"></a>setPanningEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxPanningHandler.prototype.setPanningEnabled = function(</td><td class="PParameter prettyprint " nowrap>value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxPanningHandler.panningEnabled" class=LVariable id=link50 onMouseOver="ShowTip(event, 'tt10', 'link50')" onMouseOut="HideTip('tt10')">panningEnabled</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.isPinchEnabled"></a>isPinchEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.isPinchEnabled = function()</td></tr></table></blockquote><p>Returns <a href="#mxPanningHandler.pinchEnabled" class=LVariable id=link51 onMouseOver="ShowTip(event, 'tt11', 'link51')" onMouseOut="HideTip('tt11')">pinchEnabled</a>.</p></div></div></div>
2013-07-26 16:59:11 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.setPinchEnabled"></a>setPinchEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxPanningHandler.prototype.setPinchEnabled = function(</td><td class="PParameter prettyprint " nowrap>value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxPanningHandler.pinchEnabled" class=LVariable id=link52 onMouseOver="ShowTip(event, 'tt11', 'link52')" onMouseOut="HideTip('tt11')">pinchEnabled</a>.</p></div></div></div>
2014-05-12 09:58:11 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.isPanningTrigger"></a>isPanningTrigger</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxPanningHandler.prototype.isPanningTrigger = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given event is a panning trigger for the optional given cell.&nbsp; This returns true if control-shift is pressed or if <a href="#mxPanningHandler.usePopupTrigger" class=LVariable id=link53 onMouseOver="ShowTip(event, 'tt5', 'link53')" onMouseOut="HideTip('tt5')">usePopupTrigger</a> is true and the event is a popup trigger.</p></div></div></div>
2014-05-12 09:58:11 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.isForcePanningEvent"></a>isForcePanningEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxPanningHandler.prototype.isForcePanningEvent = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link54 onMouseOver="ShowTip(event, 'tt25', 'link54')" onMouseOut="HideTip('tt25')">mxMouseEvent</a> should start panning.&nbsp; This implementation always returns true if <a href="#mxPanningHandler.ignoreCell" class=LVariable id=link55 onMouseOver="ShowTip(event, 'tt7', 'link55')" onMouseOut="HideTip('tt7')">ignoreCell</a> is true or for multi touch events.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.mouseDown"></a>mouseDown</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxPanningHandler.prototype.mouseDown = function(</td><td class="PParameter prettyprint " nowrap>sender,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles the event by initiating the panning.&nbsp; By consuming the event all subsequent events of the gesture are redirected to this handler.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.start"></a>start</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxPanningHandler.prototype.start = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Starts panning at the given event.</p></div></div></div>
2013-07-26 16:59:11 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.consumePanningTrigger"></a>consumePanningTrigger</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxPanningHandler.prototype.consumePanningTrigger = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Consumes the given <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link56 onMouseOver="ShowTip(event, 'tt25', 'link56')" onMouseOut="HideTip('tt25')">mxMouseEvent</a> if it was a panning trigger in <a href="#mxPanningHandler.mouseDown" class=LFunction id=link57 onMouseOver="ShowTip(event, 'tt26', 'link57')" onMouseOut="HideTip('tt26')">mouseDown</a>.&nbsp; The default is to invoke <a href="../util/mxMouseEvent-js.html#mxMouseEvent.consume" class=LFunction id=link58 onMouseOver="ShowTip(event, 'tt35', 'link58')" onMouseOut="HideTip('tt35')">mxMouseEvent.consume</a>.&nbsp; Note that this will block any further event processing.&nbsp; If you haven&rsquo;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><blockquote><pre class="prettyprint">mxPanningHandler.prototype.consumePanningTrigger = function(me)
2012-07-20 10:35:30 +00:00
{
if (me.evt.preventDefault)
{
me.evt.preventDefault();
}
// Stops event processing in IE
me.evt.returnValue = false;
// Sets local consumed state
if (!mxClient.IS_SF &amp;&amp; !mxClient.IS_MAC)
{
me.consumed = true;
}
};</pre></blockquote></div></div></div>
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.mouseMove"></a>mouseMove</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxPanningHandler.prototype.mouseMove = function(</td><td class="PParameter prettyprint " nowrap>sender,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles the event by updating the panning on the graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.mouseUp"></a>mouseUp</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxPanningHandler.prototype.mouseUp = function(</td><td class="PParameter prettyprint " nowrap>sender,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles the event by setting the translation on the view or showing the popupmenu.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2018-01-19 15:30:59 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.mouseUp"></a>mouseUp</h3><div class=CBody><p>Handles the event by setting the translation on the view or showing the popupmenu.</p></div></div></div>
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.panGraph"></a>panGraph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxPanningHandler.prototype.panGraph = function(</td><td class="PParameter prettyprint " nowrap>dx,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>dy</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Pans <a href="#mxPanningHandler.graph" class=LVariable id=link59 onMouseOver="ShowTip(event, 'tt2', 'link59')" onMouseOut="HideTip('tt2')">graph</a> by the given amount.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxPanningHandler.destroy"></a>destroy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.destroy = function()</td></tr></table></blockquote><p>Destroys the handler and all its resources and DOM nodes.</p></div></div></div>
2012-05-21 20:32:26 +00:00
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
2018-05-17 07:19:42 +00:00
<div id=Menu><div class=MEntry><div class=MFile><a href="../index-txt.html">API Specification</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Editor</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../editor/mxDefaultKeyHandler-js.html">mxDefaultKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxDefaultPopupMenu-js.html">mxDefaultPopupMenu</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxDefaultToolbar-js.html">mxDefaultToolbar</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxEditor-js.html">mxEditor</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Handler</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="mxCellHighlight-js.html">mxCellHighlight</a></div></div><div class=MEntry><div class=MFile><a href="mxCellMarker-js.html">mxCellMarker</a></div></div><div class=MEntry><div class=MFile><a href="mxCellTracker-js.html">mxCellTracker</a></div></div><div class=MEntry><div class=MFile><a href="mxConnectionHandler-js.html">mxConnectionHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxConstraintHandler-js.html">mxConstraintHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxEdgeHandler-js.html">mxEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxEdgeSegmentHandler-js.html">mxEdgeSegmentHandler.js</a></div></div><div class=MEntry><div class=MFile><a href="mxElbowEdgeHandler-js.html">mxElbowEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxGraphHandler-js.html">mxGraphHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxHandle-js.html">mxHandle</a></div></div><div class=MEntry><div class=MFile><a href="mxKeyHandler-js.html">mxKeyHandler</a></div></div><div class=MEntry><div class=MFile id=MSelected>mxPanningHandler</div></div><div class=MEntry><div class=MFile><a href="mxPopupMenuHandler-js.html">mxPopupMenuHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxRubberband-js.html">mxRubberband</a></div></div><div class=MEntry><div class=MFile><a href="mxSelectionCellsHandler-js.html">mxSelectionCellsHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxTooltipHandler-js.html">mxTooltipHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxVertexHandler-js.html">mxVertexHandler</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Io</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../io/mxCellCodec-js.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxChildChangeCodec-js.html">mxChildChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodec-js.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodecRegistry-js.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultKeyHandlerCodec-js.html">mxDefaultKeyHandlerCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultPopupMenuCodec-js.html">mxDefaultPopupMenuCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultToolbarCodec-js.html">mxDefaultToolbarCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxEditorCodec-js.html">mxEditorCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGenericChangeCodec-js.html">mxGenericChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGraphCodec-js.html">mxGraphCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGraphViewCodec-js.html">mxGraphViewCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxModelCodec-js.html">mxModelCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxObjectCodec-js.html">mxObjectCodec</a></div></div><di
2012-05-21 20:32:26 +00:00
var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Cookies">Cookies</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([2], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
2017-06-27 11:43:19 +00:00
<div class=CToolTip id="tt1"><div class=CClass>Basic popup menu. </div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.graph</td></tr></table></blockquote>Reference to the enclosing mxGraph.</div></div><div class=CToolTip id="tt3"><div class=CClass>Extends mxEventSource to implement a graph component for the browser. </div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.useLeftButtonForPanning</td></tr></table></blockquote>Specifies if panning should be active for the left mouse button. </div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.usePopupTrigger</td></tr></table></blockquote>Specifies if mxEvent.isPopupTrigger should also be used for panning.</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>isPopupTrigger: function(</td><td class="PParameter prettyprint " nowrap>evt</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns true if the event is a popup trigger. </div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.ignoreCell</td></tr></table></blockquote>Specifies if panning should be active even if there is a cell under the mousepointer. </div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.previewEnabled</td></tr></table></blockquote>Specifies if the panning should be previewed. </div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.useGrid</td></tr></table></blockquote>Specifies if the panning steps should be aligned to the grid size. </div></div><div class=CToolTip id="tt10"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.panningEnabled</td></tr></table></blockquote>Specifies if panning should be enabled. </div></div><div class=CToolTip id="tt11"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.pinchEnabled</td></tr></table></blockquote>Specifies if pinch gestures should be handled as zoom. </div></div><div class=CToolTip id="tt12"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.maxScale</td></tr></table></blockquote>Specifies the maximum scale. </div></div><div class=CToolTip id="tt13"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.minScale</td></tr></table></blockquote>Specifies the minimum scale. </div></div><div class=CToolTip id="tt14"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.dx</td></tr></table></blockquote>Holds the current horizontal offset.</div></div><div class=CToolTip id="tt15"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPanningHandler.prototype.dy</td></tr></table></blockquote>Holds the current vertical offset.</div></div><div class=CToolTip id="tt16"><div class
2012-05-21 20:32:26 +00:00
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>