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

121 lines
70 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>mxCellMarker</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 -->
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxCellMarker"></a>mxCellMarker</h1><div class=CBody><p>A helper class to process mouse locations and highlight cells.</p><p>Helper class to highlight cells.&nbsp; To add a cell marker to an existing graph for highlighting all cells, the following code is used:</p><blockquote><pre class="prettyprint">var marker = new mxCellMarker(graph);
graph.addMouseListener({
mouseDown: function() {},
mouseMove: function(sender, me)
{
marker.process(me);
},
mouseUp: function() {}
2014-07-25 06:48:01 +00:00
});</pre></blockquote><!--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="#mxCellMarker" >mxCellMarker</a></td><td class=SDescription>A helper class to process mouse locations and highlight cells.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxCellMarker.Events" >Events</a></td><td class=SDescription></td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#mxCellMarker.mxEvent.MARK" >mxEvent.MARK</a></td><td class=SDescription>Fires after a cell has been marked or unmarked. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxCellMarker.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxCellMarker.mxCellMarker" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxCellMarker</a></td><td class=SDescription>Constructs a new cell marker.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxCellMarker.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCellMarker.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="#mxCellMarker.enabled" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">enabled</a></td><td class=SDescription>Specifies if the marker is enabled. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCellMarker.hotspot" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">hotspot</a></td><td class=SDescription>Specifies the portion of the width and height that should trigger a highlight. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCellMarker.hotspotEnabled" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">hotspotEnabled</a></td><td class=SDescription>Specifies if the hotspot is enabled. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCellMarker.validColor" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">validColor</a></td><td class=SDescription>Holds the valid marker color.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCellMarker.invalidColor" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">invalidColor</a></td><td class=SDescription>Holds the invalid marker color.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCellMarker.currentColor" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">currentColor</a></td><td class=SDescription>Holds the current marker color.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCellMarker.validState" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">validState</a></td><td class=SDescription>Holds the marked <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">mxCellState</a> if it is valid.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCellMarker.markedState" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">markedState</a></td><td class=SDescription>Holds the marked <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link13 onMouseOver="ShowTip(event, 'tt11', 'link13')" onMouseOut="HideTip('tt11')">mxCellState</a>.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxCellMarker.Functions" >Functions</a></td><td class=SDescri
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxCellMarker.Events"></a>Events</h3></div></div>
2014-07-25 06:48:01 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxCellMarker.mxEvent.MARK"></a>mxEvent.MARK</h3><div class=CBody><p>Fires after a cell has been marked or unmarked.&nbsp; The &lt;code&gt;state&lt;/code&gt; property contains the marked <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link58 onMouseOver="ShowTip(event, 'tt11', 'link58')" onMouseOut="HideTip('tt11')">mxCellState</a> or null if no state is marked.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxCellMarker.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="mxCellMarker.mxCellMarker"></a>mxCellMarker</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 mxCellMarker(</td><td class="PParameter prettyprint " nowrap>graph,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>validColor,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>invalidColor,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>hotspot</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new cell marker.</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=link59 onMouseOver="ShowTip(event, 'tt3', 'link59')" onMouseOut="HideTip('tt3')">mxGraph</a>.</td></tr><tr><td class=CDLEntry>validColor</td><td class=CDLDescription>Optional marker color for valid states.&nbsp; Default is <a href="../util/mxConstants-js.html#mxConstants.DEFAULT_VALID_COLOR" class=LVariable id=link60 onMouseOver="ShowTip(event, 'tt37', 'link60')" onMouseOut="HideTip('tt37')">mxConstants.DEFAULT_VALID_COLOR</a>.</td></tr><tr><td class=CDLEntry>invalidColor</td><td class=CDLDescription>Optional marker color for invalid states.&nbsp; Default is <a href="../util/mxConstants-js.html#mxConstants.DEFAULT_INVALID_COLOR" class=LVariable id=link61 onMouseOver="ShowTip(event, 'tt38', 'link61')" onMouseOut="HideTip('tt38')">mxConstants.DEFAULT_INVALID_COLOR</a>.</td></tr><tr><td class=CDLEntry>hotspot</td><td class=CDLDescription>Portion of the width and hight where a state intersects a given coordinate pair.&nbsp; A value of 0 means always highlight.&nbsp; Default is <a href="../util/mxConstants-js.html#mxConstants.DEFAULT_HOTSPOT" class=LVariable id=link62 onMouseOver="ShowTip(event, 'tt39', 'link62')" onMouseOut="HideTip('tt39')">mxConstants.DEFAULT_HOTSPOT</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="mxCellMarker.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="mxCellMarker.graph"></a>graph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.graph</td></tr></table></blockquote><p>Reference to the enclosing <a href="../view/mxGraph-js.html#mxGraph" class=LClass id=link63 onMouseOver="ShowTip(event, 'tt3', 'link63')" 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="mxCellMarker.enabled"></a>enabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.enabled</td></tr></table></blockquote><p>Specifies if the marker 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="mxCellMarker.hotspot"></a>hotspot</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.hotspot</td></tr></table></blockquote><p>Specifies the portion of the width and height that should trigger a highlight.&nbsp; The area around the center of the cell to be marked is used as the hotspot.&nbsp; Possible values are between 0 and 1.&nbsp; Default is mxConstants.DEFAULT_HOTSPOT.</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="mxCellMarker.hotspotEnabled"></a>hotspotEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.hotspotEnabled</td></tr></table></blockquote><p>Specifies if the hotspot is enabled.&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="mxCellMarker.validColor"></a>validColor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.validColor</td></tr></table></blockquote><p>Holds the valid marker color.</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="mxCellMarker.invalidColor"></a>invalidColor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.invalidColor</td></tr></table></blockquote><p>Holds the invalid marker color.</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="mxCellMarker.currentColor"></a>currentColor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.currentColor</td></tr></table></blockquote><p>Holds the current marker color.</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="mxCellMarker.validState"></a>validState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.validState</td></tr></table></blockquote><p>Holds the marked <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link64 onMouseOver="ShowTip(event, 'tt11', 'link64')" onMouseOut="HideTip('tt11')">mxCellState</a> if it is valid.</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="mxCellMarker.markedState"></a>markedState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.markedState</td></tr></table></blockquote><p>Holds the marked <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link65 onMouseOver="ShowTip(event, 'tt11', 'link65')" onMouseOut="HideTip('tt11')">mxCellState</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxCellMarker.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="mxCellMarker.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>mxCellMarker.prototype.setEnabled = function(</td><td class="PParameter prettyprint " nowrap>enabled</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Enables or disables event handling.&nbsp; This implementation updates <a href="#mxCellMarker.enabled" class=LVariable id=link66 onMouseOver="ShowTip(event, 'tt4', 'link66')" onMouseOut="HideTip('tt4')">enabled</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>enabled</td><td class=CDLDescription>Boolean that specifies the new enabled state.</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="mxCellMarker.isEnabled"></a>isEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.isEnabled = function()</td></tr></table></blockquote><p>Returns true if events are handled.&nbsp; This implementation returns <a href="#mxCellMarker.enabled" class=LVariable id=link67 onMouseOver="ShowTip(event, 'tt4', 'link67')" onMouseOut="HideTip('tt4')">enabled</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="mxCellMarker.setHotspot"></a>setHotspot</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>mxCellMarker.prototype.setHotspot = function(</td><td class="PParameter prettyprint " nowrap>hotspot</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the <a href="#mxCellMarker.hotspot" class=LVariable id=link68 onMouseOver="ShowTip(event, 'tt5', 'link68')" onMouseOut="HideTip('tt5')">hotspot</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="mxCellMarker.getHotspot"></a>getHotspot</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.getHotspot = function()</td></tr></table></blockquote><p>Returns the <a href="#mxCellMarker.hotspot" class=LVariable id=link69 onMouseOver="ShowTip(event, 'tt5', 'link69')" onMouseOut="HideTip('tt5')">hotspot</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="mxCellMarker.setHotspotEnabled"></a>setHotspotEnabled</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>mxCellMarker.prototype.setHotspotEnabled = function(</td><td class="PParameter prettyprint " nowrap>enabled</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies whether the hotspot should be used in <a href="#mxCellMarker.intersects" class=LFunction id=link70 onMouseOver="ShowTip(event, 'tt18', 'link70')" onMouseOut="HideTip('tt18')">intersects</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="mxCellMarker.isHotspotEnabled"></a>isHotspotEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.isHotspotEnabled = function()</td></tr></table></blockquote><p>Returns true if hotspot is used in <a href="#mxCellMarker.intersects" class=LFunction id=link71 onMouseOver="ShowTip(event, 'tt18', 'link71')" onMouseOut="HideTip('tt18')">intersects</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="mxCellMarker.hasValidState"></a>hasValidState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.hasValidState = function()</td></tr></table></blockquote><p>Returns true if <a href="#mxCellMarker.validState" class=LVariable id=link72 onMouseOver="ShowTip(event, 'tt10', 'link72')" onMouseOut="HideTip('tt10')">validState</a> is not null.</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="mxCellMarker.getValidState"></a>getValidState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.getValidState = function()</td></tr></table></blockquote><p>Returns the <a href="#mxCellMarker.validState" class=LVariable id=link73 onMouseOver="ShowTip(event, 'tt10', 'link73')" onMouseOut="HideTip('tt10')">validState</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="mxCellMarker.getMarkedState"></a>getMarkedState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.getMarkedState = function()</td></tr></table></blockquote><p>Returns the <a href="#mxCellMarker.markedState" class=LVariable id=link74 onMouseOver="ShowTip(event, 'tt12', 'link74')" onMouseOut="HideTip('tt12')">markedState</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="mxCellMarker.reset"></a>reset</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.reset = function()</td></tr></table></blockquote><p>Resets the state of the cell marker.</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="mxCellMarker.process"></a>process</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>mxCellMarker.prototype.process = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Processes the given event and cell and marks the state returned by <a href="#mxCellMarker.getState" class=LFunction id=link75 onMouseOver="ShowTip(event, 'tt25', 'link75')" onMouseOut="HideTip('tt25')">getState</a> with the color returned by <a href="#mxCellMarker.getMarkerColor" class=LFunction id=link76 onMouseOver="ShowTip(event, 'tt26', 'link76')" onMouseOut="HideTip('tt26')">getMarkerColor</a>.&nbsp; If the markerColor is not null, then the state is stored in <a href="#mxCellMarker.markedState" class=LVariable id=link77 onMouseOver="ShowTip(event, 'tt12', 'link77')" onMouseOut="HideTip('tt12')">markedState</a>.&nbsp; If <a href="#mxCellMarker.isValidState" class=LFunction id=link78 onMouseOver="ShowTip(event, 'tt31', 'link78')" onMouseOut="HideTip('tt31')">isValidState</a> returns true, then the state is stored in <a href="#mxCellMarker.validState" class=LVariable id=link79 onMouseOver="ShowTip(event, 'tt10', 'link79')" onMouseOut="HideTip('tt10')">validState</a> regardless of the marker color.&nbsp; The state is returned regardless of the marker color and valid state.</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="mxCellMarker.setCurrentState"></a>setCurrentState</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>mxCellMarker.prototype.setCurrentState = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>me,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>color</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets and marks the current valid state.</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="mxCellMarker.markCell"></a>markCell</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>mxCellMarker.prototype.markCell = function(</td><td class="PParameter prettyprint " nowrap>cell,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>color</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Marks the given cell using the given color, or <a href="#mxCellMarker.validColor" class=LVariable id=link80 onMouseOver="ShowTip(event, 'tt7', 'link80')" onMouseOut="HideTip('tt7')">validColor</a> if no color is specified.</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="mxCellMarker.mark"></a>mark</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.mark = function()</td></tr></table></blockquote><p>Marks the <a href="#mxCellMarker.markedState" class=LVariable id=link81 onMouseOver="ShowTip(event, 'tt12', 'link81')" onMouseOut="HideTip('tt12')">markedState</a> and fires a <a href="#mxCellMarker.mark" class=LFunction id=link82 onMouseOver="ShowTip(event, 'tt29', 'link82')" onMouseOut="HideTip('tt29')">mark</a> 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="mxCellMarker.unmark"></a>unmark</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.unmark = function()</td></tr></table></blockquote><p>Hides the marker and fires a <a href="#mxCellMarker.mark" class=LFunction id=link83 onMouseOver="ShowTip(event, 'tt29', 'link83')" onMouseOut="HideTip('tt29')">mark</a> 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="mxCellMarker.isValidState"></a>isValidState</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>mxCellMarker.prototype.isValidState = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link84 onMouseOver="ShowTip(event, 'tt11', 'link84')" onMouseOut="HideTip('tt11')">mxCellState</a> is a valid state.&nbsp; If this returns true, then the state is stored in <a href="#mxCellMarker.validState" class=LVariable id=link85 onMouseOver="ShowTip(event, 'tt10', 'link85')" onMouseOut="HideTip('tt10')">validState</a>.&nbsp; The return value of this method is used as the argument for <a href="#mxCellMarker.getMarkerColor" class=LFunction id=link86 onMouseOver="ShowTip(event, 'tt26', 'link86')" onMouseOut="HideTip('tt26')">getMarkerColor</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="mxCellMarker.getMarkerColor"></a>getMarkerColor</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>mxCellMarker.prototype.getMarkerColor = function(</td><td class="PParameter prettyprint " nowrap>evt,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>isValid</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the valid- or invalidColor depending on the value of isValid.&nbsp; The given <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link87 onMouseOver="ShowTip(event, 'tt11', 'link87')" onMouseOut="HideTip('tt11')">mxCellState</a> is ignored by this implementation.</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="mxCellMarker.getState"></a>getState</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>mxCellMarker.prototype.getState = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Uses <a href="#mxCellMarker.getCell" class=LFunction id=link88 onMouseOver="ShowTip(event, 'tt32', 'link88')" onMouseOut="HideTip('tt32')">getCell</a>, <a href="#mxCellMarker.getStateToMark" class=LFunction id=link89 onMouseOver="ShowTip(event, 'tt33', 'link89')" onMouseOut="HideTip('tt33')">getStateToMark</a> and <a href="#mxCellMarker.intersects" class=LFunction id=link90 onMouseOver="ShowTip(event, 'tt18', 'link90')" onMouseOut="HideTip('tt18')">intersects</a> to return the <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link91 onMouseOver="ShowTip(event, 'tt11', 'link91')" onMouseOut="HideTip('tt11')">mxCellState</a> for the given <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link92 onMouseOver="ShowTip(event, 'tt34', 'link92')" onMouseOut="HideTip('tt34')">mxMouseEvent</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="mxCellMarker.getCell"></a>getCell</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>mxCellMarker.prototype.getCell = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the <a href="../model/mxCell-js.html#mxCell" class=LClass id=link93 onMouseOver="ShowTip(event, 'tt35', 'link93')" onMouseOut="HideTip('tt35')">mxCell</a> for the given event and cell.&nbsp; This returns the given cell.</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="mxCellMarker.getStateToMark"></a>getStateToMark</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>mxCellMarker.prototype.getStateToMark = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link94 onMouseOver="ShowTip(event, 'tt11', 'link94')" onMouseOut="HideTip('tt11')">mxCellState</a> to be marked for the given <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link95 onMouseOver="ShowTip(event, 'tt11', 'link95')" onMouseOut="HideTip('tt11')">mxCellState</a> under the mouse.&nbsp; This returns the given state.</p></div></div></div>
2014-07-25 06:48:01 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellMarker.intersects"></a>intersects</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>mxCellMarker.prototype.intersects = function(</td><td class="PParameter prettyprint " nowrap>state,</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>Returns true if the given coordinate pair intersects the given state.&nbsp; This returns true if the <a href="#mxCellMarker.hotspot" class=LVariable id=link96 onMouseOver="ShowTip(event, 'tt5', 'link96')" onMouseOut="HideTip('tt5')">hotspot</a> is 0 or the coordinates are inside the hotspot for the given cell state.</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="mxCellMarker.destroy"></a>destroy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.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-->
2017-04-12 12:48:34 +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 id=MSelected>mxCellMarker</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><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-->
2017-06-27 11:43:19 +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 mxCellMarker(</td><td class="PParameter prettyprint " nowrap>graph,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>validColor,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>invalidColor,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>hotspot</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new cell marker.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.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">mxCellMarker.prototype.enabled</td></tr></table></blockquote>Specifies if the marker is enabled. </div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.hotspot</td></tr></table></blockquote>Specifies the portion of the width and height that should trigger a highlight. </div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.hotspotEnabled</td></tr></table></blockquote>Specifies if the hotspot is 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">mxCellMarker.prototype.validColor</td></tr></table></blockquote>Holds the valid marker color.</div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.invalidColor</td></tr></table></blockquote>Holds the invalid marker color.</div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.currentColor</td></tr></table></blockquote>Holds the current marker color.</div></div><div class=CToolTip id="tt10"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.validState</td></tr></table></blockquote>Holds the marked mxCellState if it is valid.</div></div><div class=CToolTip id="tt11"><div class=CClass>Represents the current state of a cell in a given mxGraphView.</div></div><div class=CToolTip id="tt12"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.markedState</td></tr></table></blockquote>Holds the marked mxCellState.</div></div><div class=CToolTip id="tt13"><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>mxCellMarker.prototype.setEnabled = function(</td><td class="PParameter prettyprint " nowrap>enabled</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Enables or disables event handling. </div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellMarker.prototype.isEnabled = function()</td></tr></table></blockquote>Returns true if events are handled. </div></
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>