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

195 lines
122 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>mxGraphHandler</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 -->
2020-03-31 14:07:32 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxGraphHandler"></a>mxGraphHandler</h1><div class=CBody><p>Graph event handler that handles selection.&nbsp; Individual cells are handled separately using <a href="mxVertexHandler-js.html#mxVertexHandler" class=LClass id=link94 onMouseOver="ShowTip(event, 'tt83', 'link94')" onMouseOut="HideTip('tt83')">mxVertexHandler</a> or one of the edge handlers.&nbsp; These handlers are created using <a href="../view/mxGraph-js.html#mxGraph.createHandler" class=LFunction id=link95 onMouseOver="ShowTip(event, 'tt84', 'link95')" onMouseOut="HideTip('tt84')">mxGraph.createHandler</a> in <a href="../view/mxGraphSelectionModel-js.html#mxGraphSelectionModel.cellAdded" class=LFunction id=link96 onMouseOver="ShowTip(event, 'tt85', 'link96')" onMouseOut="HideTip('tt85')">mxGraphSelectionModel.cellAdded</a>.</p><p>To avoid the container to scroll a moved cell into view, set &lt;scrollAfterMove&gt; to false.</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="#mxGraphHandler" >mxGraphHandler</a></td><td class=SDescription>Graph event handler that handles selection. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraphHandler.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxGraphHandler.mxGraphHandler" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxGraphHandler</a></td><td class=SDescription>Constructs an event handler that creates handles for the selection cells.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraphHandler.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraphHandler.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="#mxGraphHandler.maxCells" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">maxCells</a></td><td class=SDescription>Defines the maximum number of cells to paint subhandles for. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraphHandler.enabled" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">enabled</a></td><td class=SDescription>Specifies if events are handled. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxGraphHandler.highlightEnabled" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">highlightEnabled</a></td><td class=SDescription>Specifies if drop targets under the mouse should be enabled. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraphHandler.cloneEnabled" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">cloneEnabled</a></td><td class=SDescription>Specifies if cloning by control-drag is enabled. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxGraphHandler.moveEnabled" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">moveEnabled</a></td><td class=SDescription>Specifies if moving is enabled. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraphHandler.guidesEnabled" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">guidesEnabled</a></td><td class=SDescription>Specifies if other cells should be used for snapping the right, center or left side of the current selection. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxGraphHandler.handlesVisible" id=link10 onMouseOver="ShowTip(even
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.Functions"></a>Functions</h3></div></div>
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.mxGraphHandler"></a>mxGraphHandler</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>function mxGraphHandler(</td><td class="PParameter prettyprint " nowrap>graph</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs an event handler that creates handles for the selection cells.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>graph</td><td class=CDLDescription>Reference to the enclosing <a href="../view/mxGraph-js.html#mxGraph" class=LClass id=link97 onMouseOver="ShowTip(event, 'tt3', 'link97')" onMouseOut="HideTip('tt3')">mxGraph</a>.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.Variables"></a>Variables</h3></div></div>
2020-03-31 14:07:32 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.graph"></a>graph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.graph</td></tr></table></blockquote><p>Reference to the enclosing <a href="../view/mxGraph-js.html#mxGraph" class=LClass id=link98 onMouseOver="ShowTip(event, 'tt3', 'link98')" 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="mxGraphHandler.maxCells"></a>maxCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.maxCells</td></tr></table></blockquote><p>Defines the maximum number of cells to paint subhandles for.&nbsp; Default is 50 for Firefox and 20 for IE.&nbsp; Set this to 0 if you want an unlimited number of handles to be displayed.&nbsp; This is only recommended if the number of cells in the graph is limited to a small number, eg.&nbsp; 500.</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="mxGraphHandler.enabled"></a>enabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.enabled</td></tr></table></blockquote><p>Specifies if events are handled.&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="mxGraphHandler.highlightEnabled"></a>highlightEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.highlightEnabled</td></tr></table></blockquote><p>Specifies if drop targets under the mouse 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="mxGraphHandler.cloneEnabled"></a>cloneEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.cloneEnabled</td></tr></table></blockquote><p>Specifies if cloning by control-drag is 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="mxGraphHandler.moveEnabled"></a>moveEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.moveEnabled</td></tr></table></blockquote><p>Specifies if moving is 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="mxGraphHandler.guidesEnabled"></a>guidesEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.guidesEnabled</td></tr></table></blockquote><p>Specifies if other cells should be used for snapping the right, center or left side of the current selection.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.handlesVisible"></a>handlesVisible</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.handlesVisible</td></tr></table></blockquote><p>Whether the handles of the selection are currently visible.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.guide"></a>guide</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.guide</td></tr></table></blockquote><p>Holds the <a href="../util/mxGuide-js.html#mxGuide" class=LClass id=link99 onMouseOver="ShowTip(event, 'tt12', 'link99')" onMouseOut="HideTip('tt12')">mxGuide</a> instance that is used for alignment.</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="mxGraphHandler.currentDx"></a>currentDx</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.currentDx</td></tr></table></blockquote><p>Stores the x-coordinate of the current mouse move.</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="mxGraphHandler.currentDy"></a>currentDy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.currentDy</td></tr></table></blockquote><p>Stores the y-coordinate of the current mouse move.</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="mxGraphHandler.updateCursor"></a>updateCursor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.updateCursor</td></tr></table></blockquote><p>Specifies if a move cursor should be shown if the mouse is over a movable cell.&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="mxGraphHandler.selectEnabled"></a>selectEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.selectEnabled</td></tr></table></blockquote><p>Specifies if selecting is 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="mxGraphHandler.removeCellsFromParent"></a>removeCellsFromParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.removeCellsFromParent</td></tr></table></blockquote><p>Specifies if cells may be moved out of their parents.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2019-07-15 10:46:53 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.removeEmptyParents"></a>removeEmptyParents</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.removeEmptyParents</td></tr></table></blockquote><p>If empty parents should be removed from the model after all child cells have been moved out.&nbsp; Default is true.</p></div></div></div>
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.connectOnDrop"></a>connectOnDrop</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.connectOnDrop</td></tr></table></blockquote><p>Specifies if drop events are interpreted as new connections if no other drop action is defined.&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="mxGraphHandler.scrollOnMove"></a>scrollOnMove</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.scrollOnMove</td></tr></table></blockquote><p>Specifies if the view should be scrolled so that a moved cell is visible.&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="mxGraphHandler.minimumSize"></a>minimumSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.minimumSize</td></tr></table></blockquote><p>Specifies the minimum number of pixels for the width and height of a selection border.&nbsp; Default is 6.</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="mxGraphHandler.previewColor"></a>previewColor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.previewColor</td></tr></table></blockquote><p>Specifies the color of the preview shape.&nbsp; Default is black.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.htmlPreview"></a>htmlPreview</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.htmlPreview</td></tr></table></blockquote><p>Specifies if the graph container should be used for preview.&nbsp; If this is used then drop target detection relies entirely on <a href="../view/mxGraph-js.html#mxGraph.getCellAt" class=LFunction id=link100 onMouseOver="ShowTip(event, 'tt86', 'link100')" onMouseOut="HideTip('tt86')">mxGraph.getCellAt</a> because the HTML preview does not &ldquo;let events through&rdquo;.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.shape"></a>shape</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.shape</td></tr></table></blockquote><p>Reference to the <a href="../shape/mxShape-js.html#mxShape" class=LClass id=link101 onMouseOver="ShowTip(event, 'tt25', 'link101')" onMouseOut="HideTip('tt25')">mxShape</a> that represents the preview.</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="mxGraphHandler.scaleGrid"></a>scaleGrid</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.scaleGrid</td></tr></table></blockquote><p>Specifies if the grid should be scaled.&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="mxGraphHandler.rotationEnabled"></a>rotationEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.rotationEnabled</td></tr></table></blockquote><p>Specifies if the bounding box should allow for rotation.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2019-10-17 08:36:14 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.maxLivePreview"></a>maxLivePreview</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.maxLivePreview</td></tr></table></blockquote><p>Maximum number of cells for which live preview should be used.&nbsp; Default is 0 which means no live preview.</p></div></div></div>
2019-11-08 14:59:37 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.allowLivePreview"></a>allowLivePreview</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.allowLivePreview</td></tr></table></blockquote><p>If live preview is allowed on this system.&nbsp; Default is true for systems with SVG support.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.Functions"></a>Functions</h3></div></div>
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.isEnabled"></a>isEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.isEnabled = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraphHandler.enabled" class=LVariable id=link102 onMouseOver="ShowTip(event, 'tt5', 'link102')" onMouseOut="HideTip('tt5')">enabled</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.setEnabled"></a>setEnabled</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>mxGraphHandler.prototype.setEnabled = 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="#mxGraphHandler.enabled" class=LVariable id=link103 onMouseOver="ShowTip(event, 'tt5', 'link103')" onMouseOut="HideTip('tt5')">enabled</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.isCloneEnabled"></a>isCloneEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.isCloneEnabled = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraphHandler.cloneEnabled" class=LVariable id=link104 onMouseOver="ShowTip(event, 'tt7', 'link104')" onMouseOut="HideTip('tt7')">cloneEnabled</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.setCloneEnabled"></a>setCloneEnabled</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>mxGraphHandler.prototype.setCloneEnabled = 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="#mxGraphHandler.cloneEnabled" class=LVariable id=link105 onMouseOver="ShowTip(event, 'tt7', 'link105')" onMouseOut="HideTip('tt7')">cloneEnabled</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Boolean that specifies the new clone enabled state.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.isMoveEnabled"></a>isMoveEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.isMoveEnabled = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraphHandler.moveEnabled" class=LVariable id=link106 onMouseOver="ShowTip(event, 'tt8', 'link106')" onMouseOut="HideTip('tt8')">moveEnabled</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.setMoveEnabled"></a>setMoveEnabled</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>mxGraphHandler.prototype.setMoveEnabled = 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="#mxGraphHandler.moveEnabled" class=LVariable id=link107 onMouseOver="ShowTip(event, 'tt8', 'link107')" onMouseOut="HideTip('tt8')">moveEnabled</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.isSelectEnabled"></a>isSelectEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.isSelectEnabled = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraphHandler.selectEnabled" class=LVariable id=link108 onMouseOver="ShowTip(event, 'tt16', 'link108')" onMouseOut="HideTip('tt16')">selectEnabled</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.setSelectEnabled"></a>setSelectEnabled</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>mxGraphHandler.prototype.setSelectEnabled = 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="#mxGraphHandler.selectEnabled" class=LVariable id=link109 onMouseOver="ShowTip(event, 'tt16', 'link109')" onMouseOut="HideTip('tt16')">selectEnabled</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.isRemoveCellsFromParent"></a>isRemoveCellsFromParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.isRemoveCellsFromParent = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraphHandler.removeCellsFromParent" class=LVariable id=link110 onMouseOver="ShowTip(event, 'tt17', 'link110')" onMouseOut="HideTip('tt17')">removeCellsFromParent</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.setRemoveCellsFromParent"></a>setRemoveCellsFromParent</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>mxGraphHandler.prototype.setRemoveCellsFromParent = 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="#mxGraphHandler.removeCellsFromParent" class=LVariable id=link111 onMouseOver="ShowTip(event, 'tt17', 'link111')" onMouseOut="HideTip('tt17')">removeCellsFromParent</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="mxGraphHandler.getInitialCellForEvent"></a>getInitialCellForEvent</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>mxGraphHandler.prototype.getInitialCellForEvent = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hook to return initial cell for the given event.</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="mxGraphHandler.isDelayedSelection"></a>isDelayedSelection</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>mxGraphHandler.prototype.isDelayedSelection = function(</td><td class="PParameter prettyprint " nowrap>cell,</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>Hook to return true for delayed selections.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2019-07-02 06:45:58 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.consumeMouseEvent"></a>consumeMouseEvent</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>mxGraphHandler.prototype.consumeMouseEvent = function(</td><td class="PParameter prettyprint " nowrap>evtName,</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>Consumes the given mouse event.&nbsp; NOTE: This may be used to enable click events for links in labels on iOS as follows as consuming the initial touchStart disables firing the subsequent click event on the link.</p><p>&lt;code&gt; mxGraphHandler.prototype.consumeMouseEvent = function(evtName, me) { var source = mxEvent.getSource(me.getEvent());</p><p>if (!mxEvent.isTouchEvent(me.getEvent()) || source.nodeName != &lsquo;A&rsquo;) { me.consume(); } } &lt;/code&gt;</p></div></div></div>
2017-01-16 08:36:34 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.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>mxGraphHandler.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 selecing the given cell and creating a handle for it.&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="mxGraphHandler.getGuideStates"></a>getGuideStates</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.getGuideStates = function()</td></tr></table></blockquote><p>Creates an array of cell states which should be used as guides.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.getCells"></a>getCells</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>mxGraphHandler.prototype.getCells = function(</td><td class="PParameter prettyprint " nowrap>initialCell</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cells to be modified by this handler.&nbsp; This implementation returns all selection cells that are movable, or the given initial cell if the given cell is not selected and movable.&nbsp; This handles the case of moving unselectable or unselected cells.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>initialCell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link112 onMouseOver="ShowTip(event, 'tt50', 'link112')" onMouseOut="HideTip('tt50')">mxCell</a> that triggered this handler.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.getPreviewBounds"></a>getPreviewBounds</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>mxGraphHandler.prototype.getPreviewBounds = function(</td><td class="PParameter prettyprint " nowrap>cells</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the <a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link113 onMouseOver="ShowTip(event, 'tt47', 'link113')" onMouseOut="HideTip('tt47')">mxRectangle</a> used as the preview bounds for moving the given cells.</p></div></div></div>
2013-05-23 16:14:48 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.getBoundingBox"></a>getBoundingBox</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>mxGraphHandler.prototype.getBoundingBox = function(</td><td class="PParameter prettyprint " nowrap>cells</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the union of the <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link114 onMouseOver="ShowTip(event, 'tt49', 'link114')" onMouseOut="HideTip('tt49')">mxCellStates</a> for the given array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link115 onMouseOver="ShowTip(event, 'tt50', 'link115')" onMouseOut="HideTip('tt50')">mxCells</a>.&nbsp; For vertices, this method uses the bounding box of the corresponding shape if one exists.&nbsp; The bounding box of the corresponding text label and all controls and overlays are ignored.&nbsp; See also: <a href="../view/mxGraphView-js.html#mxGraphView.getBounds" class=LFunction id=link116 onMouseOver="ShowTip(event, 'tt87', 'link116')" onMouseOut="HideTip('tt87')">mxGraphView.getBounds</a> and <a href="../view/mxGraph-js.html#mxGraph.getBoundingBox" class=LFunction id=link117 onMouseOver="ShowTip(event, 'tt88', 'link117')" onMouseOut="HideTip('tt88')">mxGraph.getBoundingBox</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cells</td><td class=CDLDescription>Array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link118 onMouseOver="ShowTip(event, 'tt50', 'link118')" onMouseOut="HideTip('tt50')">mxCells</a> whose bounding box should be returned.</td></tr></table></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="mxGraphHandler.createPreviewShape"></a>createPreviewShape</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>mxGraphHandler.prototype.createPreviewShape = function(</td><td class="PParameter prettyprint " nowrap>bounds</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates the shape used to draw the preview for the given bounds.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-01-24 13:32:03 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.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>mxGraphHandler.prototype.start = function(</td><td class="PParameter prettyprint " nowrap>cell,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>x,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>y,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>cells</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Starts the handling of the mouse gesture.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2019-10-17 08:36:14 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.addStates"></a>addStates</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>mxGraphHandler.prototype.addStates = function(</td><td class="PParameter prettyprint " nowrap>cell,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>dict</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the states for the given cell recursively to the given dictionary.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.isCellMoving"></a>isCellMoving</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>mxGraphHandler.prototype.isCellMoving = function(</td><td class="PParameter prettyprint " nowrap>cell</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is currently being moved.</p></div></div></div>
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.useGuidesForEvent"></a>useGuidesForEvent</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>mxGraphHandler.prototype.useGuidesForEvent = 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 guides should be used for the given <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link119 onMouseOver="ShowTip(event, 'tt56', 'link119')" onMouseOut="HideTip('tt56')">mxMouseEvent</a>.&nbsp; This implementation returns <a href="../util/mxGuide-js.html#mxGuide.isEnabledForEvent" class=LFunction id=link120 onMouseOver="ShowTip(event, 'tt89', 'link120')" onMouseOut="HideTip('tt89')">mxGuide.isEnabledForEvent</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="mxGraphHandler.snap"></a>snap</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>mxGraphHandler.prototype.snap = function(</td><td class="PParameter prettyprint " nowrap>vector</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Snaps the given vector to the grid and returns the given mxPoint instance.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.getDelta"></a>getDelta</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>mxGraphHandler.prototype.getDelta = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns an <a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link121 onMouseOver="ShowTip(event, 'tt59', 'link121')" onMouseOut="HideTip('tt59')">mxPoint</a> that represents the vector for moving the cells for the given <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link122 onMouseOver="ShowTip(event, 'tt56', 'link122')" onMouseOut="HideTip('tt56')">mxMouseEvent</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="mxGraphHandler.updateHint"></a>updateHint</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>mxGraphHandler.prototype.updateHint = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hook for subclassers do show details while the handler is 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="mxGraphHandler.removeHint"></a>removeHint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.removeHint = function()</td></tr></table></blockquote><p>Hooks for subclassers to hide details when the handler gets inactive.</p></div></div></div>
2014-05-12 09:58:11 +00:00
2020-01-24 13:32:03 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.roundLength"></a>roundLength</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>mxGraphHandler.prototype.roundLength = function(</td><td class="PParameter prettyprint " nowrap>length</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hook for rounding the unscaled vector.&nbsp; Allows for half steps in the raster so numbers coming in should be rounded if no half steps are allowed (ie for non aligned standard moving where pixel steps should be preferred).</p></div></div></div>
2013-10-16 13:41:20 +00:00
2020-03-31 14:07:32 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.isValidDropTarget"></a>isValidDropTarget</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>mxGraphHandler.prototype.isValidDropTarget = function(</td><td class="PParameter prettyprint " nowrap>target</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is a valid drop target.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.checkPreview"></a>checkPreview</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.checkPreview = function()</td></tr></table></blockquote><p>Updates the preview if cloning state has changed.</p></div></div></div>
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.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>mxGraphHandler.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 highlighting possible drop targets and updating the preview.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2019-10-17 08:36:14 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.updatePreview"></a>updatePreview</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>mxGraphHandler.prototype.updatePreview = function(</td><td class="PParameter prettyprint " nowrap>remote</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the bounds of the preview shape.</p></div></div></div>
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.updatePreviewShape"></a>updatePreviewShape</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.updatePreviewShape = function()</td></tr></table></blockquote><p>Updates the bounds of the preview shape.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2019-10-17 08:36:14 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.updateLivePreview"></a>updateLivePreview</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>mxGraphHandler.prototype.updateLivePreview = 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>Updates the bounds of the preview shape.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.redrawHandles"></a>redrawHandles</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>mxGraphHandler.prototype.redrawHandles = function(</td><td class="PParameter prettyprint " nowrap>states</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Redraws the preview shape for the given states array.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.resetPreviewStates"></a>resetPreviewStates</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>mxGraphHandler.prototype.resetPreviewStates = function(</td><td class="PParameter prettyprint " nowrap>states</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Resets the given preview states array.</p></div></div></div>
2020-01-24 13:32:03 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.suspend"></a>suspend</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.suspend = function()</td></tr></table></blockquote><p>Suspends the livew preview.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.resume"></a>resume</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.resume = function()</td></tr></table></blockquote><p>Suspends the livew preview.</p></div></div></div>
2019-10-17 08:36:14 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.resetLivePreview"></a>resetLivePreview</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.resetLivePreview = function()</td></tr></table></blockquote><p>Resets the livew preview.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.reset"></a>reset</h3><div class=CBody><p>Resets the state of this handler.</p></div></div></div>
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.setHighlightColor"></a>setHighlightColor</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>mxGraphHandler.prototype.setHighlightColor = function(</td><td class="PParameter prettyprint " nowrap>color</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the color of the rectangle used to highlight drop targets.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>color</td><td class=CDLDescription>String that represents the new highlight color.</td></tr></table></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="mxGraphHandler.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>mxGraphHandler.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 applying the changes to the selection cells.</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="mxGraphHandler.selectDelayed"></a>selectDelayed</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>mxGraphHandler.prototype.selectDelayed = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Implements the delayed selection for the given mouse event.</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="mxGraphHandler.reset"></a>reset</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.reset = function()</td></tr></table></blockquote><p>Resets the state of 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="mxGraphHandler.shouldRemoveCellsFromParent"></a>shouldRemoveCellsFromParent</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>mxGraphHandler.prototype.shouldRemoveCellsFromParent = function(</td><td class="PParameter prettyprint " nowrap>parent,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>cells,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>evt</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cells should be removed from the parent for the specified mousereleased event.</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="mxGraphHandler.moveCells"></a>moveCells</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>mxGraphHandler.prototype.moveCells = function(</td><td class="PParameter prettyprint " nowrap>cells,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>dx,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>dy,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>clone,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>target,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>evt</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Moves the given cells by the specified amount.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2020-01-24 13:32:03 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.shouldRemoveParent"></a>shouldRemoveParent</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>mxGraphHandler.prototype.shouldRemoveParent = function(</td><td class="PParameter prettyprint " nowrap>parent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given parent should be removed after removal of child cells.</p></div></div></div>
2019-07-15 10:46:53 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHandler.destroyShapes"></a>destroyShapes</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.destroyShapes = function()</td></tr></table></blockquote><p>Destroy the preview and highlight shapes.</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="mxGraphHandler.destroy"></a>destroy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.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-->
2020-03-31 14:07:32 +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 id=MSelected>mxGraphHandler</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><a href="mxPanningHandler-js.html">mxPanningHandler</a></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><
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-->
2020-03-31 14:07:32 +00:00
<div class=CToolTip id="tt1"><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>function mxGraphHandler(</td><td class="PParameter prettyprint " nowrap>graph</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs an event handler that creates handles for the selection cells.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.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">mxGraphHandler.prototype.maxCells</td></tr></table></blockquote>Defines the maximum number of cells to paint subhandles for. </div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.enabled</td></tr></table></blockquote>Specifies if events are handled. </div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.highlightEnabled</td></tr></table></blockquote>Specifies if drop targets under the mouse should be enabled. </div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.cloneEnabled</td></tr></table></blockquote>Specifies if cloning by control-drag is enabled. </div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.moveEnabled</td></tr></table></blockquote>Specifies if moving is enabled. </div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.guidesEnabled</td></tr></table></blockquote>Specifies if other cells should be used for snapping the right, center or left side of the current selection. </div></div><div class=CToolTip id="tt10"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.handlesVisible</td></tr></table></blockquote>Whether the handles of the selection are currently visible.</div></div><div class=CToolTip id="tt11"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.guide</td></tr></table></blockquote>Holds the mxGuide instance that is used for alignment.</div></div><div class=CToolTip id="tt12"><div class=CClass>Implements the alignment of selection cells to other cells in the graph.</div></div><div class=CToolTip id="tt13"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.currentDx</td></tr></table></blockquote>Stores the x-coordinate of the current mouse move.</div></div><div class=CToolTip id="tt14"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.currentDy</td></tr></table></blockquote>Stores the y-coordinate of the current mouse move.</div></div><div class=CToolTip id="tt15"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphHandler.prototype.updateCursor</td></tr></table></
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>