maxGraph/docs/js-api/files/view/mxGraph-js.html

1369 lines
925 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">
<html><head><title>mxGraph</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><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.5 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
2015-04-23 20:18:31 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxGraph"></a>mxGraph</h1><div class=CBody><p>Extends <a href="../util/mxEventSource-js.html#mxEventSource" class=LClass id=link714 onMouseOver="ShowTip(event, 'tt1', 'link714')" onMouseOut="HideTip('tt1')">mxEventSource</a> to implement a graph component for the browser.&nbsp; This is the main class of the package.&nbsp; To activate panning and connections use <a href="#mxGraph.setPanning" class=LFunction id=link715 onMouseOver="ShowTip(event, 'tt417', 'link715')" onMouseOut="HideTip('tt417')">setPanning</a> and <a href="#mxGraph.setConnectable" class=LFunction id=link716 onMouseOver="ShowTip(event, 'tt414', 'link716')" onMouseOut="HideTip('tt414')">setConnectable</a>.&nbsp; For rubberband selection you must create a new instance of <a href="../handler/mxRubberband-js.html#mxRubberband" class=LClass id=link717 onMouseOver="ShowTip(event, 'tt505', 'link717')" onMouseOut="HideTip('tt505')">mxRubberband</a>.&nbsp; The following listeners are added to <a href="#mxGraph.mouseListeners" class=LVariable id=link718 onMouseOver="ShowTip(event, 'tt38', 'link718')" onMouseOut="HideTip('tt38')">mouseListeners</a> by default:</p><ul><li>&lt;tooltipHandler&gt;: <a href="../handler/mxTooltipHandler-js.html#mxTooltipHandler" class=LClass id=link719 onMouseOver="ShowTip(event, 'tt187', 'link719')" onMouseOut="HideTip('tt187')">mxTooltipHandler</a> that displays tooltips</li><li>&lt;panningHandler&gt;: <a href="../handler/mxPanningHandler-js.html#mxPanningHandler" class=LClass id=link720 onMouseOver="ShowTip(event, 'tt194', 'link720')" onMouseOut="HideTip('tt194')">mxPanningHandler</a> for panning and popup menus</li><li>&lt;connectionHandler&gt;: <a href="../handler/mxConnectionHandler-js.html#mxConnectionHandler" class=LClass id=link721 onMouseOver="ShowTip(event, 'tt190', 'link721')" onMouseOut="HideTip('tt190')">mxConnectionHandler</a> for creating connections</li><li>&lt;graphHandler&gt;: <a href="../handler/mxGraphHandler-js.html#mxGraphHandler" class=LClass id=link722 onMouseOver="ShowTip(event, 'tt192', 'link722')" onMouseOut="HideTip('tt192')">mxGraphHandler</a> for moving and cloning cells</li></ul><p>These listeners will be called in the above order if they are enabled.</p><h4 class=CHeading>Background Images</h4><p>To display a background image, set the image, image width and image height using <a href="#mxGraph.setBackgroundImage" class=LFunction id=link723 onMouseOver="ShowTip(event, 'tt325', 'link723')" onMouseOut="HideTip('tt325')">setBackgroundImage</a>.&nbsp; If one of the above values has changed then the <a href="#mxGraph.view" class=LVariable id=link724 onMouseOver="ShowTip(event, 'tt42', 'link724')" onMouseOut="HideTip('tt42')">view</a>&rsquo;s <a href="mxGraphView-js.html#mxGraphView.validate" class=LFunction id=link725 onMouseOver="ShowTip(event, 'tt506', 'link725')" onMouseOut="HideTip('tt506')">mxGraphView.validate</a> should be invoked.</p><h4 class=CHeading>Cell Images</h4><p>To use images in cells, a shape must be specified in the default vertex style (or any named style).&nbsp; Possible shapes are <a href="../util/mxConstants-js.html#mxConstants.SHAPE_IMAGE" class=LVariable id=link726 onMouseOver="ShowTip(event, 'tt507', 'link726')" onMouseOut="HideTip('tt507')">mxConstants.SHAPE_IMAGE</a> and <a href="../util/mxConstants-js.html#mxConstants.SHAPE_LABEL" class=LVariable id=link727 onMouseOver="ShowTip(event, 'tt508', 'link727')" onMouseOut="HideTip('tt508')">mxConstants.SHAPE_LABEL</a>.&nbsp; The code to change the shape used in the default vertex style, the following code is used:</p><blockquote><pre class="prettyprint">var style = graph.getStylesheet().getDefaultVertexStyle();
style[mxConstants.STYLE_SHAPE] = mxConstants.SHAPE_IMAGE;</pre></blockquote><p>For the default vertex style, the image to be displayed can be specified in a cell&rsquo;s style using the <a href="../util/mxConstants-js.html#mxConstants.STYLE_IMAGE" class=LVariable id=link728 onMouseOver="ShowTip(event, 'tt509', 'link728')" onMouseOut="HideTip('tt509')">mxConstants.STYLE_IMAGE</a> key and the image URL as a value, for example:</p><blockquote><pre class="prettyprint">image=http://www.example.com/image.gif</pre></blockquote><p>For a named style, the the stylename must be the first element of the cell style:</p><blockquote><pre class="prettyprint">stylename;image=http://www.example.com/image.gif</pre></blockquote><p>A cell style can have any number of key=value pairs added, divided by a semicolon as follows:</p><blockquote><pre class="prettyprint">[stylename;|key=value;]</pre></blockquote><h4 class=CHeading>Labels</h4><p>The cell labels are defined by <a href="#mxGraph.getLabel" class=LFunction id=link729 onMouseOver="ShowTip(event, 'tt328', 'link729')" onMouseOut="HideTip('tt328')">getLabel</a> which uses <a href="#mxGraph.convertValueToString" class=LFunction id=link730 onMouseOver="ShowTip(event, 'tt327', 'link730')" onMouseOut="HideTip('tt327')">convertValueToString</a> if <a href="#mxGraph.labelsVisible" class=LVariable id=link731 onMouseOver="ShowTip(event, 'tt166', 'link731')" onMouseOut="HideTip('tt166')">labelsVisible</a> is true.&nbsp; If a label must be rendered as HTML markup, then <a href="#mxGraph.isHtmlLabel" class=LFunction id=link732 onMouseOver="ShowTip(event, 'tt168', 'link732')" onMouseOut="HideTip('tt168')">isHtmlLabel</a> should return true for the respective cell.&nbsp; If all labels contain HTML markup, <a href="#mxGraph.htmlLabels" class=LVariable id=link733 onMouseOver="ShowTip(event, 'tt167', 'link733')" onMouseOut="HideTip('tt167')">htmlLabels</a> can be set to true.&nbsp; NOTE: Enabling HTML labels carries a possible security risk (see the section on security in the manual).</p><p>If wrapping is needed for a label, then <a href="#mxGraph.isHtmlLabel" class=LFunction id=link734 onMouseOver="ShowTip(event, 'tt168', 'link734')" onMouseOut="HideTip('tt168')">isHtmlLabel</a> and <a href="#mxGraph.isWrapping" class=LFunction id=link735 onMouseOver="ShowTip(event, 'tt331', 'link735')" onMouseOut="HideTip('tt331')">isWrapping</a> must return true for the cell whose label should be wrapped.&nbsp; See <a href="#mxGraph.isWrapping" class=LFunction id=link736 onMouseOver="ShowTip(event, 'tt331', 'link736')" onMouseOut="HideTip('tt331')">isWrapping</a> for an example.</p><p>If clipping is needed to keep the rendering of a HTML label inside the bounds of its vertex, then &lt;isClipping&gt; should return true for the respective cell.</p><p>By default, edge labels are movable and vertex labels are fixed.&nbsp; This can be changed by setting <a href="#mxGraph.edgeLabelsMovable" class=LVariable id=link737 onMouseOver="ShowTip(event, 'tt111', 'link737')" onMouseOut="HideTip('tt111')">edgeLabelsMovable</a> and <a href="#mxGraph.vertexLabelsMovable" class=LVariable id=link738 onMouseOver="ShowTip(event, 'tt113', 'link738')" onMouseOut="HideTip('tt113')">vertexLabelsMovable</a>, or by overriding <a href="#mxGraph.isLabelMovable" class=LFunction id=link739 onMouseOver="ShowTip(event, 'tt112', 'link739')" onMouseOut="HideTip('tt112')">isLabelMovable</a>.</p><h4 class=CHeading>In-place Editing</h4><p>In-place editing is started with a doubleclick or by typing F2.&nbsp; Programmatically, &lt;edit&gt; is used to check if the cell is editable (<a href="#mxGraph.isCellEditable" class=LFunction id=link740 onMouseOver="ShowTip(event, 'tt106', 'link740')" onMouseOut="HideTip('tt106')">isCellEditable</a>) and call <a href="#mxGraph.startEditingAtCell" class=LFunction id=link741 onMouseOver="ShowTip(event, 'tt30', 'link741')" onMouseOut="HideTip('tt30')">startEditingAtCell</a>, which invokes <a href="mxCellEditor-js.html#mxCellEditor.startEditing" class=LFunction id=link742 onMouseOver="ShowTip(event, 'tt218', 'link742')" onMouse
2012-05-21 20:32:26 +00:00
{
var label = this.convertValueToString(cell);
return 'Tooltip for '+label;
}</pre></blockquote><p>When using a config file, the function is overridden in the mxGraph section using the following entry:</p><blockquote><pre class="prettyprint">&lt;add as=&quot;getTooltipForCell&quot;&gt;&lt;![CDATA[
function(cell)
{
var label = this.convertValueToString(cell);
return 'Tooltip for '+label;
}
2015-04-23 20:18:31 +00:00
]]&gt;&lt;/add&gt;</pre></blockquote><p>&rdquo;this&rdquo; refers to the graph in the implementation, so for example to check if a cell is an edge, you use this.getModel().isEdge(cell)</p><p>For replacing the default implementation of <a href="#mxGraph.getTooltipForCell" class=LFunction id=link752 onMouseOver="ShowTip(event, 'tt334', 'link752')" onMouseOut="HideTip('tt334')">getTooltipForCell</a> (rather than replacing the function on a specific instance), the following code should be used after loading the JavaScript files, but before creating a new mxGraph instance using <a href="#mxGraph.mxGraph" class=LFunction id=link753 onMouseOver="ShowTip(event, 'tt36', 'link753')" onMouseOut="HideTip('tt36')">mxGraph</a>:</p><blockquote><pre class="prettyprint">mxGraph.prototype.getTooltipForCell = function(cell)
2012-05-21 20:32:26 +00:00
{
var label = this.convertValueToString(cell);
return 'Tooltip for '+label;
2015-04-23 20:18:31 +00:00
}</pre></blockquote><h4 class=CHeading>Shapes &amp; Styles</h4><p>The implementation of new shapes is demonstrated in the examples.&nbsp; We&rsquo;ll assume that we have implemented a custom shape with the name BoxShape which we want to use for drawing vertices.&nbsp; To use this shape, it must first be registered in the cell renderer as follows:</p><blockquote><pre class="prettyprint">mxCellRenderer.registerShape('box', BoxShape);</pre></blockquote><p>The code registers the BoxShape constructor under the name box in the cell renderer of the graph.&nbsp; The shape can now be referenced using the shape-key in a style definition.&nbsp; (The cell renderer contains a set of additional shapes, namely one for each constant with a SHAPE-prefix in <a href="../util/mxConstants-js.html#mxConstants" class=LClass id=link754 onMouseOver="ShowTip(event, 'tt513', 'link754')" onMouseOut="HideTip('tt513')">mxConstants</a>.)</p><p>Styles are a collection of key, value pairs and a stylesheet is a collection of named styles.&nbsp; The names are referenced by the cellstyle, which is stored in <a href="../model/mxCell-js.html#mxCell.style" class=LVariable id=link755 onMouseOver="ShowTip(event, 'tt514', 'link755')" onMouseOut="HideTip('tt514')">mxCell.style</a> with the following format: [stylename;|key=value;].&nbsp; The string is resolved to a collection of key, value pairs, where the keys are overridden with the values in the string.</p><p>When introducing a new shape, the name under which the shape is registered must be used in the stylesheet.&nbsp; There are three ways of doing this:</p><ul><li>By changing the default style, so that all vertices will use the new shape</li><li>By defining a new style, so that only vertices with the respective cellstyle will use the new shape</li><li>By using shape=box in the cellstyle&rsquo;s optional list of key, value pairs to be overridden</li></ul><p>In the first case, the code to fetch and modify the default style for vertices is as follows:</p><blockquote><pre class="prettyprint">var style = graph.getStylesheet().getDefaultVertexStyle();
2012-05-21 20:32:26 +00:00
style[mxConstants.STYLE_SHAPE] = 'box';</pre></blockquote><p>The code takes the default vertex style, which is used for all vertices that do not have a specific cellstyle, and modifies the value for the shape-key in-place to use the new BoxShape for drawing vertices.&nbsp; This is done by assigning the box value in the second line, which refers to the name of the BoxShape in the cell renderer.</p><p>In the second case, a collection of key, value pairs is created and then added to the stylesheet under a new name.&nbsp; In order to distinguish the shapename and the stylename we&rsquo;ll use boxstyle for the stylename:</p><blockquote><pre class="prettyprint">var style = new Object();
style[mxConstants.STYLE_SHAPE] = 'box';
style[mxConstants.STYLE_STROKECOLOR] = '#000000';
style[mxConstants.STYLE_FONTCOLOR] = '#000000';
graph.getStylesheet().putCellStyle('boxstyle', style);</pre></blockquote><p>The code adds a new style with the name boxstyle to the stylesheet.&nbsp; To use this style with a cell, it must be referenced from the cellstyle as follows:</p><blockquote><pre class="prettyprint">var vertex = graph.insertVertex(parent, null, 'Hello, World!', 20, 20, 80, 20,
2015-04-23 20:18:31 +00:00
'boxstyle');</pre></blockquote><p>To summarize, each new shape must be registered in the <a href="mxCellRenderer-js.html#mxCellRenderer" class=LClass id=link756 onMouseOver="ShowTip(event, 'tt52', 'link756')" onMouseOut="HideTip('tt52')">mxCellRenderer</a> with a unique name.&nbsp; That name is then used as the value of the shape-key in a default or custom style.&nbsp; If there are multiple custom shapes, then there should be a separate style for each shape.</p><h4 class=CHeading>Inheriting Styles</h4><p>For fill-, stroke-, gradient- and indicatorColors special keywords can be used.&nbsp; The inherit keyword for one of these colors will inherit the color for the same key from the parent cell.&nbsp; The swimlane keyword does the same, but inherits from the nearest swimlane in the ancestor hierarchy.&nbsp; Finally, the indicated keyword will use the color of the indicator as the color for the given key.</p><h4 class=CHeading>Scrollbars</h4><p>The &lt;containers&gt; overflow CSS property defines if scrollbars are used to display the graph.&nbsp; For values of &lsquo;auto&rsquo; or &lsquo;scroll&rsquo;, the scrollbars will be shown.&nbsp; Note that the <a href="#mxGraph.resizeContainer" class=LVariable id=link757 onMouseOver="ShowTip(event, 'tt136', 'link757')" onMouseOut="HideTip('tt136')">resizeContainer</a> flag is normally not used together with scrollbars, as it will resize the container to match the size of the graph after each change.</p><h4 class=CHeading>Multiplicities and Validation</h4><p>To control the possible connections in mxGraph, <a href="#mxGraph.getEdgeValidationError" class=LFunction id=link758 onMouseOver="ShowTip(event, 'tt320', 'link758')" onMouseOut="HideTip('tt320')">getEdgeValidationError</a> is used.&nbsp; The default implementation of the function uses <a href="#mxGraph.multiplicities" class=LVariable id=link759 onMouseOver="ShowTip(event, 'tt53', 'link759')" onMouseOut="HideTip('tt53')">multiplicities</a>, which is an array of <a href="mxMultiplicity-js.html#mxMultiplicity" class=LClass id=link760 onMouseOver="ShowTip(event, 'tt54', 'link760')" onMouseOut="HideTip('tt54')">mxMultiplicity</a>.&nbsp; Using this class allows to establish simple multiplicities, which are enforced by the graph.</p><p>The <a href="mxMultiplicity-js.html#mxMultiplicity" class=LClass id=link761 onMouseOver="ShowTip(event, 'tt54', 'link761')" onMouseOut="HideTip('tt54')">mxMultiplicity</a> uses &lt;mxCell.is&gt; to determine for which terminals it applies.&nbsp; The default implementation of &lt;mxCell.is&gt; works with DOM nodes (XML nodes) and checks if the given type parameter matches the nodeName of the node (case insensitive).&nbsp; Optionally, an attributename and value can be specified which are also checked.</p><p><a href="#mxGraph.getEdgeValidationError" class=LFunction id=link762 onMouseOver="ShowTip(event, 'tt320', 'link762')" onMouseOut="HideTip('tt320')">getEdgeValidationError</a> is called whenever the connectivity of an edge changes.&nbsp; It returns an empty string or an error message if the edge is invalid or null if the edge is valid.&nbsp; If the returned string is not empty then it is displayed as an error message.</p><p><a href="mxMultiplicity-js.html#mxMultiplicity" class=LClass id=link763 onMouseOver="ShowTip(event, 'tt54', 'link763')" onMouseOut="HideTip('tt54')">mxMultiplicity</a> allows to specify the multiplicity between a terminal and its possible neighbors.&nbsp; For example, if any rectangle may only be connected to, say, a maximum of two circles you can add the following rule to <a href="#mxGraph.multiplicities" class=LVariable id=link764 onMouseOver="ShowTip(event, 'tt53', 'link764')" onMouseOut="HideTip('tt53')">multiplicities</a>:</p><blockquote><pre class="prettyprint">graph.multiplicities.push(new mxMultiplicity(
2012-05-21 20:32:26 +00:00
true, 'rectangle', null, null, 0, 2, ['circle'],
'Only 2 targets allowed',
2013-07-12 07:09:46 +00:00
'Only shape targets allowed'));</pre></blockquote><p>This will display the first error message whenever a rectangle is connected to more than two circles and the second error message if a rectangle is connected to anything but a circle.</p><p>For certain multiplicities, such as a minimum of 1 connection, which cannot be enforced at cell creation time (unless the cell is created together with the connection), mxGraph offers &lt;validate&gt; which checks all multiplicities for all cells and displays the respective error messages in an overlay icon on the cells.</p><p>If a cell is collapsed and contains validation errors, a respective warning icon is attached to the collapsed cell.</p><h4 class=CHeading>Auto-Layout</h4><p>For automatic layout, the &lt;getLayout&gt; hook is provided in <a href="mxLayoutManager-js.html#mxLayoutManager" class=LClass >mxLayoutManager</a>.&nbsp; It can be overridden to return a layout algorithm for the children of a given cell.</p><h4 class=CHeading>Unconnected edges</h4><p>The default values for all switches are designed to meet the requirements of general diagram drawing applications.&nbsp; A very typical set of settings to avoid edges that are not connected is the following:</p><blockquote><pre class="prettyprint">graph.setAllowDanglingEdges(false);
2015-04-23 20:18:31 +00:00
graph.setDisconnectOnMove(false);</pre></blockquote><p>Setting the <a href="#mxGraph.cloneInvalidEdges" class=LVariable id=link765 onMouseOver="ShowTip(event, 'tt164', 'link765')" onMouseOut="HideTip('tt164')">cloneInvalidEdges</a> switch to true is optional.&nbsp; This switch controls if edges are inserted after a copy, paste or clone-drag if they are invalid.&nbsp; For example, edges are invalid if copied or control-dragged without having selected the corresponding terminals and allowDanglingEdges is false, in which case the edges will not be cloned if the switch is false.</p><h4 class=CHeading>Output</h4><p>To produce an XML representation for a diagram, the following code can be used.</p><blockquote><pre class="prettyprint">var enc = new mxCodec(mxUtils.createXmlDocument());
2012-05-21 20:32:26 +00:00
var node = enc.encode(graph.getModel());</pre></blockquote><p>This will produce an XML node than can be handled using the DOM API or turned into a string representation using the following code:</p><blockquote><pre class="prettyprint">var xml = mxUtils.getXml(node);</pre></blockquote><p>To obtain a formatted string, mxUtils.getPrettyXml can be used instead.</p><p>This string can now be stored in a local persistent storage (for example using Google Gears) or it can be passed to a backend using mxUtils.post as follows.&nbsp; The url variable is the URL of the Java servlet, PHP page or HTTP handler, depending on the server.</p><blockquote><pre class="prettyprint">var xmlString = encodeURIComponent(mxUtils.getXml(node));
mxUtils.post(url, 'xml='+xmlString, function(req)
{
// Process server response using req of type mxXmlRequest
});</pre></blockquote><h4 class=CHeading>Input</h4><p>To load an XML representation of a diagram into an existing graph object mxUtils.load can be used as follows.&nbsp; The url variable is the URL of the Java servlet, PHP page or HTTP handler that produces the XML string.</p><blockquote><pre class="prettyprint">var xmlDoc = mxUtils.load(url).getXml();
var node = xmlDoc.documentElement;
var dec = new mxCodec(node.ownerDocument);
2015-04-23 20:18:31 +00:00
dec.decode(node, graph.getModel());</pre></blockquote><p>For creating a page that loads the client and a diagram using a single request please refer to the deployment examples in the backends.</p><h4 class=CHeading>Functional dependencies</h4><img src="../../images/images/callgraph.png" width="963" height="448"><h4 class=CHeading>Resources</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>resources/graph</td><td class=CDLDescription>Language resources for mxGraph</td></tr></table><!--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="#mxGraph" >mxGraph</a></td><td class=SDescription>Extends <a href="../util/mxEventSource-js.html#mxEventSource" class=LClass id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxEventSource</a> to implement a graph component for the browser. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraph.Events" >Events</a></td><td class=SDescription></td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#mxGraph.mxEvent.ROOT" >mxEvent.ROOT</a></td><td class=SDescription>Fires if the root in the model has changed. </td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#mxGraph.mxEvent.ALIGN_CELLS" >mxEvent.<wbr>ALIGN_CELLS</a></td><td class=SDescription>Fires between begin- and endUpdate in <a href="#mxGraph.alignCells" class=LFunction id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">alignCells</a>. </td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#mxGraph.mxEvent.FLIP_EDGE" >mxEvent.<wbr>FLIP_EDGE</a></td><td class=SDescription>Fires between begin- and endUpdate in <a href="#mxGraph.flipEdge" class=LFunction id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">flipEdge</a>. </td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#mxGraph.mxEvent.ORDER_CELLS" >mxEvent.<wbr>ORDER_CELLS</a></td><td class=SDescription>Fires between begin- and endUpdate in <a href="#mxGraph.orderCells" class=LFunction id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">orderCells</a>. </td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#mxGraph.mxEvent.CELLS_ORDERED" >mxEvent.<wbr>CELLS_ORDERED</a></td><td class=SDescription>Fires between begin- and endUpdate in <a href="#mxGraph.cellsOrdered" class=LFunction id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">cellsOrdered</a>. </td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#mxGraph.mxEvent.GROUP_CELLS" >mxEvent.<wbr>GROUP_CELLS</a></td><td class=SDescription>Fires between begin- and endUpdate in <a href="#mxGraph.groupCells" class=LFunction id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">groupCells</a>. </td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#mxGraph.mxEvent.UNGROUP_CELLS" >mxEvent.<wbr>UNGROUP_CELLS</a></td><td class=SDescription>Fires between begin- and endUpdate in <a href="#mxGraph.ungroupCells" class=LFunction id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">ungroupCells</a>. </td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#mxGraph.mxEvent.REMOVE_CELLS_FROM_PARENT" >mxEvent.<wbr>REMOVE_CELLS_FROM_PARENT</a></td><td class=SDescription>Fires between begin- and endUpdate in <a href="#mxGraph.removeCellsFromParent" class=LFunction id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">removeCellsFromParent</a>. </td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#mxGraph.mxEvent.ADD_CELLS" >mxEvent.<wbr>ADD_CELLS</a></td><td class=SDescription>Fires between begin- and endUpdate in <a href="#mxGraph.addCells" class=LFunction id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">addCells</a>. </td></tr><tr class="SEvent SIndent2"><td class=SEnt
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraph.Events"></a>Events</h3></div></div>
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.ROOT"></a>mxEvent.ROOT</h3><div class=CBody><p>Fires if the root in the model has changed.&nbsp; This event has no properties.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.ALIGN_CELLS"></a>mxEvent.<wbr>ALIGN_CELLS</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.alignCells" class=LFunction id=link766 onMouseOver="ShowTip(event, 'tt2', 'link766')" onMouseOut="HideTip('tt2')">alignCells</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt; and &lt;code&gt;align&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.alignCells" class=LFunction id=link767 onMouseOver="ShowTip(event, 'tt2', 'link767')" onMouseOut="HideTip('tt2')">alignCells</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.FLIP_EDGE"></a>mxEvent.<wbr>FLIP_EDGE</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.flipEdge" class=LFunction id=link768 onMouseOver="ShowTip(event, 'tt3', 'link768')" onMouseOut="HideTip('tt3')">flipEdge</a>.&nbsp; The &lt;code&gt;edge&lt;/code&gt; property contains the edge passed to <a href="#mxGraph.flipEdge" class=LFunction id=link769 onMouseOver="ShowTip(event, 'tt3', 'link769')" onMouseOut="HideTip('tt3')">flipEdge</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.ORDER_CELLS"></a>mxEvent.<wbr>ORDER_CELLS</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.orderCells" class=LFunction id=link770 onMouseOver="ShowTip(event, 'tt4', 'link770')" onMouseOut="HideTip('tt4')">orderCells</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt; and &lt;code&gt;back&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.orderCells" class=LFunction id=link771 onMouseOver="ShowTip(event, 'tt4', 'link771')" onMouseOut="HideTip('tt4')">orderCells</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.CELLS_ORDERED"></a>mxEvent.<wbr>CELLS_ORDERED</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.cellsOrdered" class=LFunction id=link772 onMouseOver="ShowTip(event, 'tt5', 'link772')" onMouseOut="HideTip('tt5')">cellsOrdered</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt; and &lt;code&gt;back&lt;/code&gt; arguments contain the respective arguments that were passed to <a href="#mxGraph.cellsOrdered" class=LFunction id=link773 onMouseOver="ShowTip(event, 'tt5', 'link773')" onMouseOut="HideTip('tt5')">cellsOrdered</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.GROUP_CELLS"></a>mxEvent.<wbr>GROUP_CELLS</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.groupCells" class=LFunction id=link774 onMouseOver="ShowTip(event, 'tt6', 'link774')" onMouseOut="HideTip('tt6')">groupCells</a>.&nbsp; The &lt;code&gt;group&lt;/code&gt;, &lt;code&gt;cells&lt;/code&gt; and &lt;code&gt;border&lt;/code&gt; arguments contain the respective arguments that were passed to <a href="#mxGraph.groupCells" class=LFunction id=link775 onMouseOver="ShowTip(event, 'tt6', 'link775')" onMouseOut="HideTip('tt6')">groupCells</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.UNGROUP_CELLS"></a>mxEvent.<wbr>UNGROUP_CELLS</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.ungroupCells" class=LFunction id=link776 onMouseOver="ShowTip(event, 'tt7', 'link776')" onMouseOut="HideTip('tt7')">ungroupCells</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt; property contains the array of cells that was passed to <a href="#mxGraph.ungroupCells" class=LFunction id=link777 onMouseOver="ShowTip(event, 'tt7', 'link777')" onMouseOut="HideTip('tt7')">ungroupCells</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.REMOVE_CELLS_FROM_PARENT"></a>mxEvent.<wbr>REMOVE_CELLS_FROM_PARENT</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.removeCellsFromParent" class=LFunction id=link778 onMouseOver="ShowTip(event, 'tt8', 'link778')" onMouseOut="HideTip('tt8')">removeCellsFromParent</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt; property contains the array of cells that was passed to <a href="#mxGraph.removeCellsFromParent" class=LFunction id=link779 onMouseOver="ShowTip(event, 'tt8', 'link779')" onMouseOut="HideTip('tt8')">removeCellsFromParent</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.ADD_CELLS"></a>mxEvent.<wbr>ADD_CELLS</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.addCells" class=LFunction id=link780 onMouseOver="ShowTip(event, 'tt9', 'link780')" onMouseOut="HideTip('tt9')">addCells</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt;, &lt;code&gt;parent&lt;/code&gt;, &lt;code&gt;index&lt;/code&gt;, &lt;code&gt;source&lt;/code&gt; and &lt;code&gt;target&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.addCells" class=LFunction id=link781 onMouseOver="ShowTip(event, 'tt9', 'link781')" onMouseOut="HideTip('tt9')">addCells</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.CELLS_ADDED"></a>mxEvent.<wbr>CELLS_ADDED</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.cellsAdded" class=LFunction id=link782 onMouseOver="ShowTip(event, 'tt10', 'link782')" onMouseOut="HideTip('tt10')">cellsAdded</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt;, &lt;code&gt;parent&lt;/code&gt;, &lt;code&gt;index&lt;/code&gt;, &lt;code&gt;source&lt;/code&gt;, &lt;code&gt;target&lt;/code&gt; and &lt;code&gt;absolute&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.cellsAdded" class=LFunction id=link783 onMouseOver="ShowTip(event, 'tt10', 'link783')" onMouseOut="HideTip('tt10')">cellsAdded</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.REMOVE_CELLS"></a>mxEvent.<wbr>REMOVE_CELLS</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.removeCells" class=LFunction id=link784 onMouseOver="ShowTip(event, 'tt11', 'link784')" onMouseOut="HideTip('tt11')">removeCells</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt; and &lt;code&gt;includeEdges&lt;/code&gt; arguments contain the respective arguments that were passed to <a href="#mxGraph.removeCells" class=LFunction id=link785 onMouseOver="ShowTip(event, 'tt11', 'link785')" onMouseOut="HideTip('tt11')">removeCells</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.CELLS_REMOVED"></a>mxEvent.<wbr>CELLS_REMOVED</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.cellsRemoved" class=LFunction id=link786 onMouseOver="ShowTip(event, 'tt12', 'link786')" onMouseOut="HideTip('tt12')">cellsRemoved</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt; argument contains the array of cells that was removed.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.SPLIT_EDGE"></a>mxEvent.<wbr>SPLIT_EDGE</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.splitEdge" class=LFunction id=link787 onMouseOver="ShowTip(event, 'tt13', 'link787')" onMouseOut="HideTip('tt13')">splitEdge</a>.&nbsp; The &lt;code&gt;edge&lt;/code&gt; property contains the edge to be splitted, the &lt;code&gt;cells&lt;/code&gt;, &lt;code&gt;newEdge&lt;/code&gt;, &lt;code&gt;dx&lt;/code&gt; and &lt;code&gt;dy&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.splitEdge" class=LFunction id=link788 onMouseOver="ShowTip(event, 'tt13', 'link788')" onMouseOut="HideTip('tt13')">splitEdge</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.TOGGLE_CELLS"></a>mxEvent.<wbr>TOGGLE_CELLS</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.toggleCells" class=LFunction id=link789 onMouseOver="ShowTip(event, 'tt14', 'link789')" onMouseOut="HideTip('tt14')">toggleCells</a>.&nbsp; The &lt;code&gt;show&lt;/code&gt;, &lt;code&gt;cells&lt;/code&gt; and &lt;code&gt;includeEdges&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.toggleCells" class=LFunction id=link790 onMouseOver="ShowTip(event, 'tt14', 'link790')" onMouseOut="HideTip('tt14')">toggleCells</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.FOLD_CELLS"></a>mxEvent.<wbr>FOLD_CELLS</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.foldCells" class=LFunction id=link791 onMouseOver="ShowTip(event, 'tt15', 'link791')" onMouseOut="HideTip('tt15')">foldCells</a>.&nbsp; The &lt;code&gt;collapse&lt;/code&gt;, &lt;code&gt;cells&lt;/code&gt; and &lt;code&gt;recurse&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.foldCells" class=LFunction id=link792 onMouseOver="ShowTip(event, 'tt15', 'link792')" onMouseOut="HideTip('tt15')">foldCells</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.CELLS_FOLDED"></a>mxEvent.<wbr>CELLS_FOLDED</h3><div class=CBody><p>Fires between begin- and endUpdate in cellsFolded.&nbsp; The &lt;code&gt;collapse&lt;/code&gt;, &lt;code&gt;cells&lt;/code&gt; and &lt;code&gt;recurse&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.cellsFolded" class=LFunction id=link793 onMouseOver="ShowTip(event, 'tt256', 'link793')" onMouseOut="HideTip('tt256')">cellsFolded</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.UPDATE_CELL_SIZE"></a>mxEvent.<wbr>UPDATE_CELL_SIZE</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.updateCellSize" class=LFunction id=link794 onMouseOver="ShowTip(event, 'tt16', 'link794')" onMouseOut="HideTip('tt16')">updateCellSize</a>.&nbsp; The &lt;code&gt;cell&lt;/code&gt; and &lt;code&gt;ignoreChildren&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.updateCellSize" class=LFunction id=link795 onMouseOver="ShowTip(event, 'tt16', 'link795')" onMouseOut="HideTip('tt16')">updateCellSize</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.RESIZE_CELLS"></a>mxEvent.<wbr>RESIZE_CELLS</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.resizeCells" class=LFunction id=link796 onMouseOver="ShowTip(event, 'tt17', 'link796')" onMouseOut="HideTip('tt17')">resizeCells</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt; and &lt;code&gt;bounds&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.resizeCells" class=LFunction id=link797 onMouseOver="ShowTip(event, 'tt17', 'link797')" onMouseOut="HideTip('tt17')">resizeCells</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.CELLS_RESIZED"></a>mxEvent.<wbr>CELLS_RESIZED</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.cellsResized" class=LFunction id=link798 onMouseOver="ShowTip(event, 'tt18', 'link798')" onMouseOut="HideTip('tt18')">cellsResized</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt; and &lt;code&gt;bounds&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.cellsResized" class=LFunction id=link799 onMouseOver="ShowTip(event, 'tt18', 'link799')" onMouseOut="HideTip('tt18')">cellsResized</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.MOVE_CELLS"></a>mxEvent.<wbr>MOVE_CELLS</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.moveCells" class=LFunction id=link800 onMouseOver="ShowTip(event, 'tt19', 'link800')" onMouseOut="HideTip('tt19')">moveCells</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt;, &lt;code&gt;dx&lt;/code&gt;, &lt;code&gt;dy&lt;/code&gt;, &lt;code&gt;clone&lt;/code&gt;, &lt;code&gt;target&lt;/code&gt; and &lt;code&gt;event&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.moveCells" class=LFunction id=link801 onMouseOver="ShowTip(event, 'tt19', 'link801')" onMouseOut="HideTip('tt19')">moveCells</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.CELLS_MOVED"></a>mxEvent.<wbr>CELLS_MOVED</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.cellsMoved" class=LFunction id=link802 onMouseOver="ShowTip(event, 'tt20', 'link802')" onMouseOut="HideTip('tt20')">cellsMoved</a>.&nbsp; The &lt;code&gt;cells&lt;/code&gt;, &lt;code&gt;dx&lt;/code&gt;, &lt;code&gt;dy&lt;/code&gt; and &lt;code&gt;disconnect&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.cellsMoved" class=LFunction id=link803 onMouseOver="ShowTip(event, 'tt20', 'link803')" onMouseOut="HideTip('tt20')">cellsMoved</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.CONNECT_CELL"></a>mxEvent.<wbr>CONNECT_CELL</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.connectCell" class=LFunction id=link804 onMouseOver="ShowTip(event, 'tt21', 'link804')" onMouseOut="HideTip('tt21')">connectCell</a>.&nbsp; The &lt;code&gt;edge&lt;/code&gt;, &lt;code&gt;terminal&lt;/code&gt; and &lt;code&gt;source&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.connectCell" class=LFunction id=link805 onMouseOver="ShowTip(event, 'tt21', 'link805')" onMouseOut="HideTip('tt21')">connectCell</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.CELL_CONNECTED"></a>mxEvent.<wbr>CELL_CONNECTED</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.cellConnected" class=LFunction id=link806 onMouseOver="ShowTip(event, 'tt22', 'link806')" onMouseOut="HideTip('tt22')">cellConnected</a>.&nbsp; The &lt;code&gt;edge&lt;/code&gt;, &lt;code&gt;terminal&lt;/code&gt; and &lt;code&gt;source&lt;/code&gt; properties contain the respective arguments that were passed to <a href="#mxGraph.cellConnected" class=LFunction id=link807 onMouseOver="ShowTip(event, 'tt22', 'link807')" onMouseOut="HideTip('tt22')">cellConnected</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.REFRESH"></a>mxEvent.<wbr>REFRESH</h3><div class=CBody><p>Fires after <a href="#mxGraph.refresh" class=LFunction id=link808 onMouseOver="ShowTip(event, 'tt23', 'link808')" onMouseOut="HideTip('tt23')">refresh</a> was executed.&nbsp; This event has no properties.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.CLICK"></a>mxEvent.<wbr>CLICK</h3><div class=CBody><p>Fires in <a href="#mxGraph.click" class=LFunction id=link809 onMouseOver="ShowTip(event, 'tt24', 'link809')" onMouseOut="HideTip('tt24')">click</a> after a click event.&nbsp; The &lt;code&gt;event&lt;/code&gt; property contains the original mouse event and &lt;code&gt;cell&lt;/code&gt; property contains the cell under the mouse or null if the background was clicked.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.DOUBLE_CLICK"></a>mxEvent.<wbr>DOUBLE_CLICK</h3><div class=CBody><p>Fires in <a href="#mxGraph.dblClick" class=LFunction id=link810 onMouseOver="ShowTip(event, 'tt25', 'link810')" onMouseOut="HideTip('tt25')">dblClick</a> after a double click.&nbsp; The &lt;code&gt;event&lt;/code&gt; property contains the original mouse event and the &lt;code&gt;cell&lt;/code&gt; property contains the cell under the mouse or null if the background was clicked.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.GESTURE"></a>mxEvent.<wbr>GESTURE</h3><div class=CBody><p>Fires in <a href="#mxGraph.fireGestureEvent" class=LFunction id=link811 onMouseOver="ShowTip(event, 'tt26', 'link811')" onMouseOut="HideTip('tt26')">fireGestureEvent</a> after a touch gesture.&nbsp; The &lt;code&gt;event&lt;/code&gt; property contains the original gesture end event and the &lt;code&gt;cell&lt;/code&gt; property contains the optional cell associated with the gesture.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.TAP_AND_HOLD"></a>mxEvent.<wbr>TAP_AND_HOLD</h3><div class=CBody><p>Fires in <a href="#mxGraph.tapAndHold" class=LFunction id=link812 onMouseOver="ShowTip(event, 'tt27', 'link812')" onMouseOut="HideTip('tt27')">tapAndHold</a> if a tap and hold event was detected.&nbsp; The &lt;code&gt;event&lt;/code&gt; property contains the initial touch event and the &lt;code&gt;cell&lt;/code&gt; property contains the cell under the mouse or null if the background was clicked.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.FIRE_MOUSE_EVENT"></a>mxEvent.<wbr>FIRE_MOUSE_EVENT</h3><div class=CBody><p>Fires in <a href="#mxGraph.fireMouseEvent" class=LFunction id=link813 onMouseOver="ShowTip(event, 'tt28', 'link813')" onMouseOut="HideTip('tt28')">fireMouseEvent</a> before the mouse listeners are invoked.&nbsp; The &lt;code&gt;eventName&lt;/code&gt; property contains the event name and the &lt;code&gt;event&lt;/code&gt; property contains the <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link814 onMouseOver="ShowTip(event, 'tt222', 'link814')" onMouseOut="HideTip('tt222')">mxMouseEvent</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.SIZE"></a>mxEvent.SIZE</h3><div class=CBody><p>Fires after <a href="#mxGraph.sizeDidChange" class=LFunction id=link815 onMouseOver="ShowTip(event, 'tt29', 'link815')" onMouseOut="HideTip('tt29')">sizeDidChange</a> was executed.&nbsp; The &lt;code&gt;bounds&lt;/code&gt; property contains the new graph bounds.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.START_EDITING"></a>mxEvent.<wbr>START_EDITING</h3><div class=CBody><p>Fires before the in-place editor starts in <a href="#mxGraph.startEditingAtCell" class=LFunction id=link816 onMouseOver="ShowTip(event, 'tt30', 'link816')" onMouseOut="HideTip('tt30')">startEditingAtCell</a>.&nbsp; The &lt;code&gt;cell&lt;/code&gt; property contains the cell that is being edited and the &lt;code&gt;event&lt;/code&gt; property contains the optional event argument that was passed to <a href="#mxGraph.startEditingAtCell" class=LFunction id=link817 onMouseOver="ShowTip(event, 'tt30', 'link817')" onMouseOut="HideTip('tt30')">startEditingAtCell</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.EDITING_STARTED"></a>mxEvent.<wbr>EDITING_STARTED</h3><div class=CBody><p>Fires after the in-place editor starts in <a href="#mxGraph.startEditingAtCell" class=LFunction id=link818 onMouseOver="ShowTip(event, 'tt30', 'link818')" onMouseOut="HideTip('tt30')">startEditingAtCell</a>.&nbsp; The &lt;code&gt;cell&lt;/code&gt; property contains the cell that is being edited and the &lt;code&gt;event&lt;/code&gt; property contains the optional event argument that was passed to <a href="#mxGraph.startEditingAtCell" class=LFunction id=link819 onMouseOver="ShowTip(event, 'tt30', 'link819')" onMouseOut="HideTip('tt30')">startEditingAtCell</a>.</p></div></div></div>
2013-06-28 19:07:06 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.EDITING_STOPPED"></a>mxEvent.<wbr>EDITING_STOPPED</h3><div class=CBody><p>Fires after the in-place editor stops in <a href="#mxGraph.stopEditing" class=LFunction id=link820 onMouseOver="ShowTip(event, 'tt31', 'link820')" onMouseOut="HideTip('tt31')">stopEditing</a>.</p></div></div></div>
2013-06-28 19:07:06 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.LABEL_CHANGED"></a>mxEvent.<wbr>LABEL_CHANGED</h3><div class=CBody><p>Fires between begin- and endUpdate in <a href="#mxGraph.cellLabelChanged" class=LFunction id=link821 onMouseOver="ShowTip(event, 'tt32', 'link821')" onMouseOut="HideTip('tt32')">cellLabelChanged</a>.&nbsp; The &lt;code&gt;cell&lt;/code&gt; property contains the cell, the &lt;code&gt;value&lt;/code&gt; property contains the new value for the cell, the &lt;code&gt;old&lt;/code&gt; property contains the old value and the optional &lt;code&gt;event&lt;/code&gt; property contains the mouse event that started the edit.</p></div></div></div>
2013-06-28 19:07:06 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.ADD_OVERLAY"></a>mxEvent.<wbr>ADD_OVERLAY</h3><div class=CBody><p>Fires after an overlay is added in <a href="#mxGraph.addCellOverlay" class=LFunction id=link822 onMouseOver="ShowTip(event, 'tt33', 'link822')" onMouseOut="HideTip('tt33')">addCellOverlay</a>.&nbsp; The &lt;code&gt;cell&lt;/code&gt; property contains the cell and the &lt;code&gt;overlay&lt;/code&gt; property contains the <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link823 onMouseOver="ShowTip(event, 'tt213', 'link823')" onMouseOut="HideTip('tt213')">mxCellOverlay</a> that was added.</p></div></div></div>
2015-01-05 14:01:01 +00:00
2015-04-23 20:18:31 +00:00
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxEvent.REMOVE_OVERLAY"></a>mxEvent.<wbr>REMOVE_OVERLAY</h3><div class=CBody><p>Fires after an overlay is removed in <a href="#mxGraph.removeCellOverlay" class=LFunction id=link824 onMouseOver="ShowTip(event, 'tt34', 'link824')" onMouseOut="HideTip('tt34')">removeCellOverlay</a> and <a href="#mxGraph.removeCellOverlays" class=LFunction id=link825 onMouseOver="ShowTip(event, 'tt35', 'link825')" onMouseOut="HideTip('tt35')">removeCellOverlays</a>.&nbsp; The &lt;code&gt;cell&lt;/code&gt; property contains the cell and the &lt;code&gt;overlay&lt;/code&gt; property contains the <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link826 onMouseOver="ShowTip(event, 'tt213', 'link826')" onMouseOut="HideTip('tt213')">mxCellOverlay</a> that was removed.</p></div></div></div>
2015-01-05 14:01:01 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxGraph"></a>mxGraph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function mxGraph(</td><td class=PParameter nowrap>container,</td></tr><tr><td></td><td class=PParameter nowrap>model,</td></tr><tr><td></td><td class=PParameter nowrap>renderHint,</td></tr><tr><td></td><td class=PParameter nowrap>stylesheet</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new mxGraph in the specified container.&nbsp; Model is an optional mxGraphModel.&nbsp; If no model is provided, a new mxGraphModel instance is used as the model.&nbsp; The container must have a valid owner document prior to calling this function in Internet Explorer.&nbsp; RenderHint is a string to affect the display performance and rendering in IE, but not in SVG-based browsers.&nbsp; The parameter is mapped to <a href="#mxGraph.dialect" class=LVariable id=link827 onMouseOver="ShowTip(event, 'tt56', 'link827')" onMouseOut="HideTip('tt56')">dialect</a>, which may be one of <a href="../util/mxConstants-js.html#mxConstants.DIALECT_SVG" class=LVariable id=link828 onMouseOver="ShowTip(event, 'tt515', 'link828')" onMouseOut="HideTip('tt515')">mxConstants.DIALECT_SVG</a> for SVG-based browsers, <a href="../util/mxConstants-js.html#mxConstants.DIALECT_STRICTHTML" class=LVariable id=link829 onMouseOver="ShowTip(event, 'tt516', 'link829')" onMouseOut="HideTip('tt516')">mxConstants.DIALECT_STRICTHTML</a> for fastest display mode, <a href="../util/mxConstants-js.html#mxConstants.DIALECT_PREFERHTML" class=LVariable id=link830 onMouseOver="ShowTip(event, 'tt517', 'link830')" onMouseOut="HideTip('tt517')">mxConstants.DIALECT_PREFERHTML</a> for faster display mode, <a href="../util/mxConstants-js.html#mxConstants.DIALECT_MIXEDHTML" class=LVariable id=link831 onMouseOver="ShowTip(event, 'tt518', 'link831')" onMouseOut="HideTip('tt518')">mxConstants.DIALECT_MIXEDHTML</a> for fast and <a href="../util/mxConstants-js.html#mxConstants.DIALECT_VML" class=LVariable id=link832 onMouseOver="ShowTip(event, 'tt519', 'link832')" onMouseOut="HideTip('tt519')">mxConstants.DIALECT_VML</a> for exact display mode (slowest).&nbsp; The dialects are defined in mxConstants.&nbsp; The default values are DIALECT_SVG for SVG-based browsers and DIALECT_MIXED for IE.</p><h4 class=CHeading>The possible values for the renderingHint parameter are explained below</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>fast</td><td class=CDLDescription>The parameter is based on the fact that the display performance is highly improved in IE if the VML is not contained within a VML group element.&nbsp; The lack of a group element only slightly affects the display while panning, but improves the performance by almost a factor of 2, while keeping the display sufficiently accurate.&nbsp; This also allows to render certain shapes as HTML if the display accuracy is not affected, which is implemented by &lt;mxShape.isMixedModeHtml&gt;.&nbsp; This is the default setting and is mapped to DIALECT_MIXEDHTML.</td></tr><tr><td class=CDLEntry>faster</td><td class=CDLDescription>Same as fast, but more expensive shapes are avoided.&nbsp; This is controlled by &lt;mxShape.preferModeHtml&gt;.&nbsp; The default implementation will avoid gradients and rounded rectangles, but more significant shapes, such as rhombus, ellipse, actor and cylinder will be rendered accurately.&nbsp; This setting is mapped to DIALECT_PREFERHTML.</td></tr><tr><td class=CDLEntry>fastest</td><td class=CDLDescription>Almost anything will be rendered in Html.&nbsp; This allows for rectangles, labels and images.&nbsp; This setting is mapped to DIALECT_STRICTHTML.</td></tr><tr><td class=CDLEntry>exact</td><td class=CDLDescription>If accurate panning is required and if the diagram is small (up to 100 cells), then this value should be used.&nbsp; In thi
var graph = new mxGraph(container);</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>container</td><td class=CDLDescription>Optional DOM node that acts as a container for the graph.&nbsp; If this is null then the container can be initialized later using <a href="#mxGraph.init" class=LFunction id=link833 onMouseOver="ShowTip(event, 'tt184', 'link833')" onMouseOut="HideTip('tt184')">init</a>.</td></tr><tr><td class=CDLEntry>model</td><td class=CDLDescription>Optional <a href="../model/mxGraphModel-js.html#mxGraphModel" class=LClass id=link834 onMouseOver="ShowTip(event, 'tt41', 'link834')" onMouseOut="HideTip('tt41')">mxGraphModel</a> that constitutes the graph data.</td></tr><tr><td class=CDLEntry>renderHint</td><td class=CDLDescription>Optional string that specifies the display accuracy and performance.&nbsp; Default is mxConstants.DIALECT_MIXEDHTML (for IE).</td></tr><tr><td class=CDLEntry>stylesheet</td><td class=CDLDescription>Optional <a href="mxStylesheet-js.html#mxStylesheet" class=LClass id=link835 onMouseOver="ShowTip(event, 'tt46', 'link835')" onMouseOut="HideTip('tt46')">mxStylesheet</a> to be used in the graph.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.EMPTY_ARRAY"></a>EMPTY_ARRAY</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.EMPTY_ARRAY</td></tr></table></blockquote><p>Immutable empty array instance.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraph.Variables"></a>Variables</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mouseListeners"></a>mouseListeners</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.mouseListeners</td></tr></table></blockquote><p>Holds the mouse event listeners.&nbsp; See <a href="#mxGraph.fireMouseEvent" class=LFunction id=link836 onMouseOver="ShowTip(event, 'tt28', 'link836')" onMouseOut="HideTip('tt28')">fireMouseEvent</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isMouseDown"></a>isMouseDown</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isMouseDown</td></tr></table></blockquote><p>Holds the state of the mouse button.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.model"></a>model</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.model</td></tr></table></blockquote><p>Holds the <a href="../model/mxGraphModel-js.html#mxGraphModel" class=LClass id=link837 onMouseOver="ShowTip(event, 'tt41', 'link837')" onMouseOut="HideTip('tt41')">mxGraphModel</a> that contains the cells to be displayed.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.view"></a>view</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.view</td></tr></table></blockquote><p>Holds the <a href="mxGraphView-js.html#mxGraphView" class=LClass id=link838 onMouseOver="ShowTip(event, 'tt43', 'link838')" onMouseOut="HideTip('tt43')">mxGraphView</a> that caches the <a href="mxCellState-js.html#mxCellState" class=LClass id=link839 onMouseOver="ShowTip(event, 'tt44', 'link839')" onMouseOut="HideTip('tt44')">mxCellStates</a> for the cells.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.stylesheet"></a>stylesheet</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.stylesheet</td></tr></table></blockquote><p>Holds the <a href="mxStylesheet-js.html#mxStylesheet" class=LClass id=link840 onMouseOver="ShowTip(event, 'tt46', 'link840')" onMouseOut="HideTip('tt46')">mxStylesheet</a> that defines the appearance of the cells.</p><h4 class=CHeading>Example</h4><p>Use the following code to read a stylesheet into an existing graph.</p><blockquote><pre class="prettyprint">var req = mxUtils.load('stylesheet.xml');
2012-05-21 20:32:26 +00:00
var root = req.getDocumentElement();
var dec = new mxCodec(root.ownerDocument);
dec.decode(root, graph.stylesheet);</pre></blockquote></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectionModel"></a>selectionModel</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.selectionModel</td></tr></table></blockquote><p>Holds the <a href="mxGraphSelectionModel-js.html#mxGraphSelectionModel" class=LClass id=link841 onMouseOver="ShowTip(event, 'tt48', 'link841')" onMouseOut="HideTip('tt48')">mxGraphSelectionModel</a> that models the current selection.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellEditor"></a>cellEditor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.cellEditor</td></tr></table></blockquote><p>Holds the <a href="mxCellEditor-js.html#mxCellEditor" class=LClass id=link842 onMouseOver="ShowTip(event, 'tt50', 'link842')" onMouseOut="HideTip('tt50')">mxCellEditor</a> that is used as the in-place editing.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellRenderer"></a>cellRenderer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.cellRenderer</td></tr></table></blockquote><p>Holds the <a href="mxCellRenderer-js.html#mxCellRenderer" class=LClass id=link843 onMouseOver="ShowTip(event, 'tt52', 'link843')" onMouseOut="HideTip('tt52')">mxCellRenderer</a> for rendering the cells in the graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.multiplicities"></a>multiplicities</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.multiplicities</td></tr></table></blockquote><p>An array of <a href="mxMultiplicity-js.html#mxMultiplicity" class=LClass id=link844 onMouseOver="ShowTip(event, 'tt54', 'link844')" onMouseOut="HideTip('tt54')">mxMultiplicities</a> describing the allowed connections in a graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.renderHint"></a>renderHint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.renderHint</td></tr></table></blockquote><p>RenderHint as it was passed to the constructor.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.dialect"></a>dialect</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.dialect</td></tr></table></blockquote><p>Dialect to be used for drawing the graph.&nbsp; Possible values are all constants in <a href="../util/mxConstants-js.html#mxConstants" class=LClass id=link845 onMouseOver="ShowTip(event, 'tt513', 'link845')" onMouseOut="HideTip('tt513')">mxConstants</a> with a DIALECT-prefix.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.gridSize"></a>gridSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.gridSize</td></tr></table></blockquote><p>Specifies the grid size.&nbsp; Default is 10.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.gridEnabled"></a>gridEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.gridEnabled</td></tr></table></blockquote><p>Specifies if the grid is enabled.&nbsp; This is used in <a href="#mxGraph.snap" class=LFunction id=link846 onMouseOver="ShowTip(event, 'tt300', 'link846')" onMouseOut="HideTip('tt300')">snap</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.portsEnabled"></a>portsEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.portsEnabled</td></tr></table></blockquote><p>Specifies if ports are enabled.&nbsp; This is used in <a href="#mxGraph.cellConnected" class=LFunction id=link847 onMouseOver="ShowTip(event, 'tt22', 'link847')" onMouseOut="HideTip('tt22')">cellConnected</a> to update the respective style.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.nativeDoubleClickEnabled"></a>nativeDoubleClickEnabled</h3><div class=CBody><p>Specifies if native double click events should be deteced.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-08-21 09:32:40 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.doubleTapEnabled"></a>doubleTapEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.doubleTapEnabled</td></tr></table></blockquote><p>Specifies if double taps on touch-based devices should be handled as a double click.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-08-21 09:32:40 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.doubleTapTimeout"></a>doubleTapTimeout</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.doubleTapTimeout</td></tr></table></blockquote><p>Specifies the timeout for double taps and non-native double clicks.&nbsp; Default is 500 ms.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.doubleTapTolerance"></a>doubleTapTolerance</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.doubleTapTolerance</td></tr></table></blockquote><p>Specifies the tolerance for double taps and double clicks in quirks mode.&nbsp; Default is 25 pixels.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.lastTouchX"></a>lastTouchX</h3><div class=CBody><p>Holds the x-coordinate of the last touch event for double tap detection.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.lastTouchX"></a>lastTouchX</h3><div class=CBody><p>Holds the y-coordinate of the last touch event for double tap detection.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.lastTouchTime"></a>lastTouchTime</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.lastTouchTime</td></tr></table></blockquote><p>Holds the time of the last touch event for double click detection.</p></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.tapAndHoldEnabled"></a>tapAndHoldEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.tapAndHoldEnabled</td></tr></table></blockquote><p>Specifies if tap and hold should be used for starting connections on touch-based devices.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.tapAndHoldDelay"></a>tapAndHoldDelay</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.tapAndHoldDelay</td></tr></table></blockquote><p>Specifies the time for a tap and hold.&nbsp; Default is 500 ms.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.tapAndHoldInProgress"></a>tapAndHoldInProgress</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.tapAndHoldInProgress</td></tr></table></blockquote><p>True if the timer for tap and hold events is running.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.tapAndHoldValid"></a>tapAndHoldValid</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.tapAndHoldValid</td></tr></table></blockquote><p>True as long as the timer is running and the touch events stay within the given &lt;tapAndHoldTolerance&gt;.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.initialTouchX"></a>initialTouchX</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.initialTouchX</td></tr></table></blockquote><p>Holds the x-coordinate of the intial touch event for tap and hold.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.initialTouchY"></a>initialTouchY</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.initialTouchY</td></tr></table></blockquote><p>Holds the y-coordinate of the intial touch event for tap and hold.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.tolerance"></a>tolerance</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.tolerance</td></tr></table></blockquote><p>Tolerance for a move to be handled as a single click.&nbsp; Default is 4 pixels.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.defaultOverlap"></a>defaultOverlap</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.defaultOverlap</td></tr></table></blockquote><p>Value returned by <a href="#mxGraph.getOverlap" class=LFunction id=link848 onMouseOver="ShowTip(event, 'tt72', 'link848')" onMouseOut="HideTip('tt72')">getOverlap</a> if <a href="#mxGraph.isAllowOverlapParent" class=LFunction id=link849 onMouseOver="ShowTip(event, 'tt73', 'link849')" onMouseOut="HideTip('tt73')">isAllowOverlapParent</a> returns true for the given cell.&nbsp; <a href="#mxGraph.getOverlap" class=LFunction id=link850 onMouseOver="ShowTip(event, 'tt72', 'link850')" onMouseOut="HideTip('tt72')">getOverlap</a> is used in <a href="#mxGraph.constrainChild" class=LFunction id=link851 onMouseOver="ShowTip(event, 'tt269', 'link851')" onMouseOut="HideTip('tt269')">constrainChild</a> if <a href="#mxGraph.isConstrainChild" class=LFunction id=link852 onMouseOver="ShowTip(event, 'tt276', 'link852')" onMouseOut="HideTip('tt276')">isConstrainChild</a> returns true.&nbsp; The value specifies the portion of the child which is allowed to overlap the parent.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.defaultParent"></a>defaultParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.defaultParent</td></tr></table></blockquote><p>Specifies the default parent to be used to insert new cells.&nbsp; This is used in <a href="#mxGraph.getDefaultParent" class=LFunction id=link853 onMouseOver="ShowTip(event, 'tt439', 'link853')" onMouseOut="HideTip('tt439')">getDefaultParent</a>.&nbsp; Default is null.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.alternateEdgeStyle"></a>alternateEdgeStyle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.alternateEdgeStyle</td></tr></table></blockquote><p>Specifies the alternate edge style to be used if the main control point on an edge is being doubleclicked.&nbsp; Default is null.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.backgroundImage"></a>backgroundImage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.backgroundImage</td></tr></table></blockquote><p>Specifies the <a href="../util/mxImage-js.html#mxImage" class=LClass id=link854 onMouseOver="ShowTip(event, 'tt77', 'link854')" onMouseOut="HideTip('tt77')">mxImage</a> to be returned by <a href="#mxGraph.getBackgroundImage" class=LFunction id=link855 onMouseOver="ShowTip(event, 'tt78', 'link855')" onMouseOut="HideTip('tt78')">getBackgroundImage</a>.&nbsp; Default is null.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">var img = new mxImage('http://www.example.com/maps/examplemap.jpg', 1024, 768);
2012-05-21 20:32:26 +00:00
graph.setBackgroundImage(img);
graph.view.validate();</pre></blockquote></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.pageVisible"></a>pageVisible</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.pageVisible</td></tr></table></blockquote><p>Specifies if the background page should be visible.&nbsp; Default is false.&nbsp; Not yet implemented.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.pageBreaksVisible"></a>pageBreaksVisible</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.pageBreaksVisible</td></tr></table></blockquote><p>Specifies if a dashed line should be drawn between multiple pages.&nbsp; Default is false.&nbsp; If you change this value while a graph is being displayed then you should call <a href="#mxGraph.sizeDidChange" class=LFunction id=link856 onMouseOver="ShowTip(event, 'tt29', 'link856')" onMouseOut="HideTip('tt29')">sizeDidChange</a> to force an update of the display.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.pageBreakColor"></a>pageBreakColor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.pageBreakColor</td></tr></table></blockquote><p>Specifies the color for page breaks.&nbsp; Default is &lsquo;gray&rsquo;.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.pageBreakDashed"></a>pageBreakDashed</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.pageBreakDashed</td></tr></table></blockquote><p>Specifies the page breaks should be dashed.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.minPageBreakDist"></a>minPageBreakDist</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.minPageBreakDist</td></tr></table></blockquote><p>Specifies the minimum distance for page breaks to be visible.&nbsp; Default is 20 (in pixels).</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.preferPageSize"></a>preferPageSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.preferPageSize</td></tr></table></blockquote><p>Specifies if the graph size should be rounded to the next page number in <a href="#mxGraph.sizeDidChange" class=LFunction id=link857 onMouseOver="ShowTip(event, 'tt29', 'link857')" onMouseOut="HideTip('tt29')">sizeDidChange</a>.&nbsp; This is only used if the graph container has scrollbars.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.pageFormat"></a>pageFormat</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.pageFormat</td></tr></table></blockquote><p>Specifies the page format for the background page.&nbsp; Default is <a href="../util/mxConstants-js.html#mxConstants.PAGE_FORMAT_A4_PORTRAIT" class=LVariable id=link858 onMouseOver="ShowTip(event, 'tt520', 'link858')" onMouseOut="HideTip('tt520')">mxConstants.PAGE_FORMAT_A4_PORTRAIT</a>.&nbsp; This is used as the default in <a href="mxPrintPreview-js.html#mxPrintPreview" class=LClass id=link859 onMouseOver="ShowTip(event, 'tt521', 'link859')" onMouseOut="HideTip('tt521')">mxPrintPreview</a> and for painting the background page if <a href="#mxGraph.pageVisible" class=LVariable id=link860 onMouseOver="ShowTip(event, 'tt79', 'link860')" onMouseOut="HideTip('tt79')">pageVisible</a> is true and the pagebreaks if <a href="#mxGraph.pageBreaksVisible" class=LVariable id=link861 onMouseOver="ShowTip(event, 'tt80', 'link861')" onMouseOut="HideTip('tt80')">pageBreaksVisible</a> is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.pageScale"></a>pageScale</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.pageScale</td></tr></table></blockquote><p>Specifies the scale of the background page.&nbsp; Default is 1.5.&nbsp; Not yet implemented.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.enabled"></a>enabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.enabled</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.isEnabled" class=LFunction id=link862 onMouseOver="ShowTip(event, 'tt88', 'link862')" onMouseOut="HideTip('tt88')">isEnabled</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.escapeEnabled"></a>escapeEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.escapeEnabled</td></tr></table></blockquote><p>Specifies if <a href="../handler/mxKeyHandler-js.html#mxKeyHandler" class=LClass id=link863 onMouseOver="ShowTip(event, 'tt90', 'link863')" onMouseOut="HideTip('tt90')">mxKeyHandler</a> should invoke <a href="#mxGraph.escape" class=LFunction id=link864 onMouseOver="ShowTip(event, 'tt91', 'link864')" onMouseOut="HideTip('tt91')">escape</a> when the escape key is pressed.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.invokesStopCellEditing"></a>invokesStopCellEditing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.invokesStopCellEditing</td></tr></table></blockquote><p>If true, when editing is to be stopped by way of selection changing, data in diagram changing or other means stopCellEditing is invoked, and changes are saved.&nbsp; This is implemented in a focus handler in <a href="mxCellEditor-js.html#mxCellEditor" class=LClass id=link865 onMouseOver="ShowTip(event, 'tt50', 'link865')" onMouseOut="HideTip('tt50')">mxCellEditor</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.enterStopsCellEditing"></a>enterStopsCellEditing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.enterStopsCellEditing</td></tr></table></blockquote><p>If true, pressing the enter key without pressing control or shift will stop editing and accept the new value.&nbsp; This is used in <a href="mxCellEditor-js.html#mxCellEditor" class=LClass id=link866 onMouseOver="ShowTip(event, 'tt50', 'link866')" onMouseOut="HideTip('tt50')">mxCellEditor</a> to stop cell editing.&nbsp; Note: You can always use F2 and escape to stop editing.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.useScrollbarsForPanning"></a>useScrollbarsForPanning</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.useScrollbarsForPanning</td></tr></table></blockquote><p>Specifies if scrollbars should be used for panning in <a href="#mxGraph.panGraph" class=LFunction id=link867 onMouseOver="ShowTip(event, 'tt95', 'link867')" onMouseOut="HideTip('tt95')">panGraph</a> if any scrollbars are available.&nbsp; If scrollbars are enabled in CSS, but no scrollbars appear because the graph is smaller than the container size, then no panning occurs if this is true.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.exportEnabled"></a>exportEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.exportEnabled</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.canExportCell" class=LFunction id=link868 onMouseOver="ShowTip(event, 'tt97', 'link868')" onMouseOut="HideTip('tt97')">canExportCell</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.importEnabled"></a>importEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.importEnabled</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.canImportCell" class=LFunction id=link869 onMouseOver="ShowTip(event, 'tt99', 'link869')" onMouseOut="HideTip('tt99')">canImportCell</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsLocked"></a>cellsLocked</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.cellsLocked</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.isCellLocked" class=LFunction id=link870 onMouseOver="ShowTip(event, 'tt101', 'link870')" onMouseOut="HideTip('tt101')">isCellLocked</a>.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsCloneable"></a>cellsCloneable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.cellsCloneable</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.isCellCloneable" class=LFunction id=link871 onMouseOver="ShowTip(event, 'tt103', 'link871')" onMouseOut="HideTip('tt103')">isCellCloneable</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.foldingEnabled"></a>foldingEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.foldingEnabled</td></tr></table></blockquote><p>Specifies if folding (collapse and expand via an image icon in the graph should be enabled).&nbsp; Default is true.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsEditable"></a>cellsEditable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.cellsEditable</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.isCellEditable" class=LFunction id=link872 onMouseOver="ShowTip(event, 'tt106', 'link872')" onMouseOut="HideTip('tt106')">isCellEditable</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsDeletable"></a>cellsDeletable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.cellsDeletable</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.isCellDeletable" class=LFunction id=link873 onMouseOver="ShowTip(event, 'tt108', 'link873')" onMouseOut="HideTip('tt108')">isCellDeletable</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsMovable"></a>cellsMovable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.cellsMovable</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.isCellMovable" class=LFunction id=link874 onMouseOver="ShowTip(event, 'tt110', 'link874')" onMouseOut="HideTip('tt110')">isCellMovable</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.edgeLabelsMovable"></a>edgeLabelsMovable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.edgeLabelsMovable</td></tr></table></blockquote><p>Specifies the return value for edges in <a href="#mxGraph.isLabelMovable" class=LFunction id=link875 onMouseOver="ShowTip(event, 'tt112', 'link875')" onMouseOut="HideTip('tt112')">isLabelMovable</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.vertexLabelsMovable"></a>vertexLabelsMovable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.vertexLabelsMovable</td></tr></table></blockquote><p>Specifies the return value for vertices in <a href="#mxGraph.isLabelMovable" class=LFunction id=link876 onMouseOver="ShowTip(event, 'tt112', 'link876')" onMouseOut="HideTip('tt112')">isLabelMovable</a>.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.dropEnabled"></a>dropEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.dropEnabled</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.isDropEnabled" class=LFunction id=link877 onMouseOver="ShowTip(event, 'tt115', 'link877')" onMouseOut="HideTip('tt115')">isDropEnabled</a>.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.splitEnabled"></a>splitEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.splitEnabled</td></tr></table></blockquote><p>Specifies if dropping onto edges should be enabled.&nbsp; This is ignored if <a href="#mxGraph.dropEnabled" class=LVariable id=link878 onMouseOver="ShowTip(event, 'tt114', 'link878')" onMouseOut="HideTip('tt114')">dropEnabled</a> is false.&nbsp; If enabled, it will call <a href="#mxGraph.splitEdge" class=LFunction id=link879 onMouseOver="ShowTip(event, 'tt13', 'link879')" onMouseOut="HideTip('tt13')">splitEdge</a> to carry out the drop operation.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsResizable"></a>cellsResizable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.cellsResizable</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.isCellResizable" class=LFunction id=link880 onMouseOver="ShowTip(event, 'tt118', 'link880')" onMouseOut="HideTip('tt118')">isCellResizable</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsBendable"></a>cellsBendable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.cellsBendable</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.isCellsBendable" class=LFunction id=link881 onMouseOver="ShowTip(event, 'tt120', 'link881')" onMouseOut="HideTip('tt120')">isCellsBendable</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsSelectable"></a>cellsSelectable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.cellsSelectable</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.isCellSelectable" class=LFunction id=link882 onMouseOver="ShowTip(event, 'tt122', 'link882')" onMouseOut="HideTip('tt122')">isCellSelectable</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsDisconnectable"></a>cellsDisconnectable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.cellsDisconnectable</td></tr></table></blockquote><p>Specifies the return value for &lt;isCellDisconntable&gt;.&nbsp; Default is true.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.autoSizeCells"></a>autoSizeCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.autoSizeCells</td></tr></table></blockquote><p>Specifies if the graph should automatically update the cell size after an edit.&nbsp; This is used in <a href="#mxGraph.isAutoSizeCell" class=LFunction id=link883 onMouseOver="ShowTip(event, 'tt419', 'link883')" onMouseOut="HideTip('tt419')">isAutoSizeCell</a>.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-10-22 11:05:54 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.autoSizeCellsOnAdd"></a>autoSizeCellsOnAdd</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.autoSizeCellsOnAdd</td></tr></table></blockquote><p>Specifies if autoSize style should be applied when cells are added.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.autoScroll"></a>autoScroll</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.autoScroll</td></tr></table></blockquote><p>Specifies if the graph should automatically scroll if the mouse goes near the container edge while dragging.&nbsp; This is only taken into account if the container has scrollbars.&nbsp; Default is true.</p><p>If you need this to work without scrollbars then set <a href="#mxGraph.ignoreScrollbars" class=LVariable id=link884 onMouseOver="ShowTip(event, 'tt130', 'link884')" onMouseOut="HideTip('tt130')">ignoreScrollbars</a> to true.</p></div></div></div>
2012-06-01 10:53:50 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.timerAutoScroll"></a>timerAutoScroll</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.timerAutoScroll</td></tr></table></blockquote><p>Specifies if timer-based autoscrolling should be used via mxPanningManager.&nbsp; Note that this disables the code in <a href="#mxGraph.scrollPointToVisible" class=LFunction id=link885 onMouseOver="ShowTip(event, 'tt129', 'link885')" onMouseOut="HideTip('tt129')">scrollPointToVisible</a> and uses code in mxPanningManager instead.&nbsp; Note that <a href="#mxGraph.autoExtend" class=LVariable id=link886 onMouseOver="ShowTip(event, 'tt131', 'link886')" onMouseOut="HideTip('tt131')">autoExtend</a> is disabled if this is true and that this should only be used with a scroll buffer or when scollbars are visible and scrollable in all directions.&nbsp; Default is false.</p></div></div></div>
2013-10-22 11:05:54 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.allowAutoPanning"></a>allowAutoPanning</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.allowAutoPanning</td></tr></table></blockquote><p>Specifies if panning via <a href="#mxGraph.panGraph" class=LFunction id=link887 onMouseOver="ShowTip(event, 'tt95', 'link887')" onMouseOut="HideTip('tt95')">panGraph</a> should be allowed to implement autoscroll if no scrollbars are available in <a href="#mxGraph.scrollPointToVisible" class=LFunction id=link888 onMouseOver="ShowTip(event, 'tt129', 'link888')" onMouseOut="HideTip('tt129')">scrollPointToVisible</a>.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.ignoreScrollbars"></a>ignoreScrollbars</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.ignoreScrollbars</td></tr></table></blockquote><p>Specifies if the graph should automatically scroll regardless of the scrollbars.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.autoExtend"></a>autoExtend</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.autoExtend</td></tr></table></blockquote><p>Specifies if the size of the graph should be automatically extended if the mouse goes near the container edge while dragging.&nbsp; This is only taken into account if the container has scrollbars.&nbsp; Default is true.&nbsp; See <a href="#mxGraph.autoScroll" class=LVariable id=link889 onMouseOver="ShowTip(event, 'tt126', 'link889')" onMouseOut="HideTip('tt126')">autoScroll</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.maximumGraphBounds"></a>maximumGraphBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.maximumGraphBounds</td></tr></table></blockquote><p><a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link890 onMouseOver="ShowTip(event, 'tt133', 'link890')" onMouseOut="HideTip('tt133')">mxRectangle</a> that specifies the area in which all cells in the diagram should be placed.&nbsp; Uses in <a href="#mxGraph.getMaximumGraphBounds" class=LFunction id=link891 onMouseOver="ShowTip(event, 'tt275', 'link891')" onMouseOut="HideTip('tt275')">getMaximumGraphBounds</a>.&nbsp; Use a width or height of 0 if you only want to give a upper, left corner.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.minimumGraphSize"></a>minimumGraphSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.minimumGraphSize</td></tr></table></blockquote><p><a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link892 onMouseOver="ShowTip(event, 'tt133', 'link892')" onMouseOut="HideTip('tt133')">mxRectangle</a> that specifies the minimum size of the graph.&nbsp; This is ignored if the graph container has no scrollbars.&nbsp; Default is null.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.minimumContainerSize"></a>minimumContainerSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.minimumContainerSize</td></tr></table></blockquote><p><a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link893 onMouseOver="ShowTip(event, 'tt133', 'link893')" onMouseOut="HideTip('tt133')">mxRectangle</a> that specifies the minimum size of the &lt;container&gt; if <a href="#mxGraph.resizeContainer" class=LVariable id=link894 onMouseOver="ShowTip(event, 'tt136', 'link894')" onMouseOut="HideTip('tt136')">resizeContainer</a> is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.maximumContainerSize"></a>maximumContainerSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.maximumContainerSize</td></tr></table></blockquote><p><a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link895 onMouseOver="ShowTip(event, 'tt133', 'link895')" onMouseOut="HideTip('tt133')">mxRectangle</a> that specifies the maximum size of the container if <a href="#mxGraph.resizeContainer" class=LVariable id=link896 onMouseOver="ShowTip(event, 'tt136', 'link896')" onMouseOut="HideTip('tt136')">resizeContainer</a> is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.resizeContainer"></a>resizeContainer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.resizeContainer</td></tr></table></blockquote><p>Specifies if the container should be resized to the graph size when the graph size has changed.&nbsp; Default is false.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.border"></a>border</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.border</td></tr></table></blockquote><p>Border to be added to the bottom and right side when the container is being resized after the graph has been changed.&nbsp; Default is 0.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.keepEdgesInForeground"></a>keepEdgesInForeground</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.keepEdgesInForeground</td></tr></table></blockquote><p>Specifies if edges should appear in the foreground regardless of their order in the model.&nbsp; If <a href="#mxGraph.keepEdgesInForeground" class=LVariable id=link897 onMouseOver="ShowTip(event, 'tt139', 'link897')" onMouseOut="HideTip('tt139')">keepEdgesInForeground</a> and <a href="#mxGraph.keepEdgesInBackground" class=LVariable id=link898 onMouseOver="ShowTip(event, 'tt140', 'link898')" onMouseOut="HideTip('tt140')">keepEdgesInBackground</a> are both true then the normal order is applied.&nbsp; Default is false.</p></div></div></div>
2014-05-05 08:30:00 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.keepEdgesInBackground"></a>keepEdgesInBackground</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.keepEdgesInBackground</td></tr></table></blockquote><p>Specifies if edges should appear in the background regardless of their order in the model.&nbsp; If <a href="#mxGraph.keepEdgesInForeground" class=LVariable id=link899 onMouseOver="ShowTip(event, 'tt139', 'link899')" onMouseOut="HideTip('tt139')">keepEdgesInForeground</a> and <a href="#mxGraph.keepEdgesInBackground" class=LVariable id=link900 onMouseOver="ShowTip(event, 'tt140', 'link900')" onMouseOut="HideTip('tt140')">keepEdgesInBackground</a> are both true then the normal order is applied.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.allowNegativeCoordinates"></a>allowNegativeCoordinates</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.allowNegativeCoordinates</td></tr></table></blockquote><p>Specifies if negative coordinates for vertices are allowed.&nbsp; Default is true.</p></div></div></div>
2013-09-19 07:24:45 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.constrainChildren"></a>constrainChildren</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.constrainChildren</td></tr></table></blockquote><p>Specifies if a child should be constrained inside the parent bounds after a move of the child.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.constrainChildrenOnResize"></a>constrainChildrenOnResize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.constrainChildrenOnResize</td></tr></table></blockquote><p>Specifies if children should be constrained according to the <a href="#mxGraph.constrainChildren" class=LVariable id=link901 onMouseOver="ShowTip(event, 'tt142', 'link901')" onMouseOut="HideTip('tt142')">constrainChildren</a> switch if cells are resized (including via <a href="#mxGraph.foldCells" class=LFunction id=link902 onMouseOver="ShowTip(event, 'tt15', 'link902')" onMouseOut="HideTip('tt15')">foldCells</a>).&nbsp; Default is false for backwards compatiblity.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.extendParents"></a>extendParents</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.extendParents</td></tr></table></blockquote><p>Specifies if a parent should contain the child bounds after a resize of the child.&nbsp; Default is true.&nbsp; This has precedence over <a href="#mxGraph.constrainChildren" class=LVariable id=link903 onMouseOver="ShowTip(event, 'tt142', 'link903')" onMouseOut="HideTip('tt142')">constrainChildren</a>.</p></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.extendParentsOnAdd"></a>extendParentsOnAdd</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.extendParentsOnAdd</td></tr></table></blockquote><p>Specifies if parents should be extended according to the <a href="#mxGraph.extendParents" class=LVariable id=link904 onMouseOver="ShowTip(event, 'tt144', 'link904')" onMouseOut="HideTip('tt144')">extendParents</a> switch if cells are added.&nbsp; Default is true.</p></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.extendParentsOnAdd"></a>extendParentsOnAdd</h3><div class=CBody><p>Specifies if parents should be extended according to the <a href="#mxGraph.extendParents" class=LVariable id=link905 onMouseOver="ShowTip(event, 'tt144', 'link905')" onMouseOut="HideTip('tt144')">extendParents</a> switch if cells are added.&nbsp; Default is false for backwards compatiblity.</p></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.recursiveResize"></a>recursiveResize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.recursiveResize</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.isRecursiveResize" class=LFunction id=link906 onMouseOver="ShowTip(event, 'tt147', 'link906')" onMouseOut="HideTip('tt147')">isRecursiveResize</a>.&nbsp; Default is false for backwards compatiblity.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.collapseToPreferredSize"></a>collapseToPreferredSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.collapseToPreferredSize</td></tr></table></blockquote><p>Specifies if the cell size should be changed to the preferred size when a cell is first collapsed.&nbsp; Default is true.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.zoomFactor"></a>zoomFactor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.zoomFactor</td></tr></table></blockquote><p>Specifies the factor used for <a href="#mxGraph.zoomIn" class=LFunction id=link907 onMouseOver="ShowTip(event, 'tt150', 'link907')" onMouseOut="HideTip('tt150')">zoomIn</a> and <a href="#mxGraph.zoomOut" class=LFunction id=link908 onMouseOver="ShowTip(event, 'tt151', 'link908')" onMouseOut="HideTip('tt151')">zoomOut</a>.&nbsp; Default is 1.2 (120%).</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.keepSelectionVisibleOnZoom"></a>keepSelectionVisibleOnZoom</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.keepSelectionVisibleOnZoom</td></tr></table></blockquote><p>Specifies if the viewport should automatically contain the selection cells after a zoom operation.&nbsp; Default is false.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.centerZoom"></a>centerZoom</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.centerZoom</td></tr></table></blockquote><p>Specifies if the zoom operations should go into the center of the actual diagram rather than going from top, left.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.resetViewOnRootChange"></a>resetViewOnRootChange</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.resetViewOnRootChange</td></tr></table></blockquote><p>Specifies if the scale and translate should be reset if the root changes in the model.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.resetEdgesOnResize"></a>resetEdgesOnResize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.resetEdgesOnResize</td></tr></table></blockquote><p>Specifies if edge control points should be reset after the resize of a connected cell.&nbsp; Default is false.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.resetEdgesOnMove"></a>resetEdgesOnMove</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.resetEdgesOnMove</td></tr></table></blockquote><p>Specifies if edge control points should be reset after the move of a connected cell.&nbsp; Default is false.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.resetEdgesOnConnect"></a>resetEdgesOnConnect</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.resetEdgesOnConnect</td></tr></table></blockquote><p>Specifies if edge control points should be reset after the the edge has been reconnected.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.allowLoops"></a>allowLoops</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.allowLoops</td></tr></table></blockquote><p>Specifies if loops (aka self-references) are allowed.&nbsp; Default is false.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.defaultLoopStyle"></a>defaultLoopStyle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.defaultLoopStyle</td></tr></table></blockquote><p><a href="mxEdgeStyle-js.html#mxEdgeStyle" class=LClass id=link909 onMouseOver="ShowTip(event, 'tt160', 'link909')" onMouseOut="HideTip('tt160')">mxEdgeStyle</a> to be used for loops.&nbsp; This is a fallback for loops if the <a href="../util/mxConstants-js.html#mxConstants.STYLE_LOOP" class=LVariable id=link910 onMouseOver="ShowTip(event, 'tt522', 'link910')" onMouseOut="HideTip('tt522')">mxConstants.STYLE_LOOP</a> is undefined.&nbsp; Default is <a href="mxEdgeStyle-js.html#mxEdgeStyle.Loop" class=LFunction id=link911 onMouseOver="ShowTip(event, 'tt523', 'link911')" onMouseOut="HideTip('tt523')">mxEdgeStyle.Loop</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.multigraph"></a>multigraph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.multigraph</td></tr></table></blockquote><p>Specifies if multiple edges in the same direction between the same pair of vertices are allowed.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.connectableEdges"></a>connectableEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.connectableEdges</td></tr></table></blockquote><p>Specifies if edges are connectable.&nbsp; Default is false.&nbsp; This overrides the connectable field in edges.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.allowDanglingEdges"></a>allowDanglingEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.allowDanglingEdges</td></tr></table></blockquote><p>Specifies if edges with disconnected terminals are allowed in the graph.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cloneInvalidEdges"></a>cloneInvalidEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.cloneInvalidEdges</td></tr></table></blockquote><p>Specifies if edges that are cloned should be validated and only inserted if they are valid.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.disconnectOnMove"></a>disconnectOnMove</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.disconnectOnMove</td></tr></table></blockquote><p>Specifies if edges should be disconnected from their terminals when they are moved.&nbsp; Default is true.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.labelsVisible"></a>labelsVisible</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.labelsVisible</td></tr></table></blockquote><p>Specifies if labels should be visible.&nbsp; This is used in <a href="#mxGraph.getLabel" class=LFunction id=link912 onMouseOver="ShowTip(event, 'tt328', 'link912')" onMouseOut="HideTip('tt328')">getLabel</a>.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.htmlLabels"></a>htmlLabels</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.htmlLabels</td></tr></table></blockquote><p>Specifies the return value for <a href="#mxGraph.isHtmlLabel" class=LFunction id=link913 onMouseOver="ShowTip(event, 'tt168', 'link913')" onMouseOut="HideTip('tt168')">isHtmlLabel</a>.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.swimlaneSelectionEnabled"></a>swimlaneSelectionEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.swimlaneSelectionEnabled</td></tr></table></blockquote><p>Specifies if swimlanes should be selectable via the content if the mouse is released.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.swimlaneNesting"></a>swimlaneNesting</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.swimlaneNesting</td></tr></table></blockquote><p>Specifies if nesting of swimlanes is allowed.&nbsp; Default is true.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.swimlaneIndicatorColorAttribute"></a>swimlaneIndicatorColorAttribute</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.swimlaneIndicatorColorAttribute</td></tr></table></blockquote><p>The attribute used to find the color for the indicator if the indicator color is set to &lsquo;swimlane&rsquo;.&nbsp; Default is <a href="../util/mxConstants-js.html#mxConstants.STYLE_FILLCOLOR" class=LVariable id=link914 onMouseOver="ShowTip(event, 'tt524', 'link914')" onMouseOut="HideTip('tt524')">mxConstants.STYLE_FILLCOLOR</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.imageBundles"></a>imageBundles</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.imageBundles</td></tr></table></blockquote><p>Holds the list of image bundles.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.minFitScale"></a>minFitScale</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.minFitScale</td></tr></table></blockquote><p>Specifies the minimum scale to be applied in <a href="#mxGraph.fit" class=LFunction id=link915 onMouseOver="ShowTip(event, 'tt174', 'link915')" onMouseOut="HideTip('tt174')">fit</a>.&nbsp; Default is 0.1.&nbsp; Set this to null to allow any value.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.maxFitScale"></a>maxFitScale</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.maxFitScale</td></tr></table></blockquote><p>Specifies the maximum scale to be applied in <a href="#mxGraph.fit" class=LFunction id=link916 onMouseOver="ShowTip(event, 'tt174', 'link916')" onMouseOut="HideTip('tt174')">fit</a>.&nbsp; Default is 8.&nbsp; Set this to null to allow any value.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.panDx"></a>panDx</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.panDx</td></tr></table></blockquote><p>Current horizontal panning value.&nbsp; Default is 0.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.panDy"></a>panDy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.panDy</td></tr></table></blockquote><p>Current vertical panning value.&nbsp; Default is 0.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.collapsedImage"></a>collapsedImage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.collapsedImage</td></tr></table></blockquote><p>Specifies the <a href="../util/mxImage-js.html#mxImage" class=LClass id=link917 onMouseOver="ShowTip(event, 'tt77', 'link917')" onMouseOut="HideTip('tt77')">mxImage</a> to indicate a collapsed state.&nbsp; Default value is mxClient.imageBasePath + &lsquo;/collapsed.gif&rsquo;</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.expandedImage"></a>expandedImage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.expandedImage</td></tr></table></blockquote><p>Specifies the <a href="../util/mxImage-js.html#mxImage" class=LClass id=link918 onMouseOver="ShowTip(event, 'tt77', 'link918')" onMouseOut="HideTip('tt77')">mxImage</a> to indicate a expanded state.&nbsp; Default value is mxClient.imageBasePath + &lsquo;/expanded.gif&rsquo;</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.warningImage"></a>warningImage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.warningImage</td></tr></table></blockquote><p>Specifies the <a href="../util/mxImage-js.html#mxImage" class=LClass id=link919 onMouseOver="ShowTip(event, 'tt77', 'link919')" onMouseOut="HideTip('tt77')">mxImage</a> for the image to be used to display a warning overlay.&nbsp; See <a href="#mxGraph.setCellWarning" class=LFunction id=link920 onMouseOver="ShowTip(event, 'tt216', 'link920')" onMouseOut="HideTip('tt216')">setCellWarning</a>.&nbsp; Default value is mxClient.imageBasePath + &lsquo;/warning&rsquo;.&nbsp; The extension for the image depends on the platform.&nbsp; It is &lsquo;.png&rsquo; on the Mac and &lsquo;.gif&rsquo; on all other platforms.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.alreadyConnectedResource"></a>alreadyConnectedResource</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.alreadyConnectedResource</td></tr></table></blockquote><p>Specifies the resource key for the error message to be displayed in non-multigraphs when two vertices are already connected.&nbsp; If the resource for this key does not exist then the value is used as the error message.&nbsp; Default is &lsquo;alreadyConnected&rsquo;.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.containsValidationErrorsResource"></a>containsValidationErrorsResource</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.containsValidationErrorsResource</td></tr></table></blockquote><p>Specifies the resource key for the warning message to be displayed when a collapsed cell contains validation errors.&nbsp; If the resource for this key does not exist then the value is used as the warning message.&nbsp; Default is &lsquo;containsValidationErrors&rsquo;.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraph.collapseExpandResource"></a>collapseExpandResource</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.collapseExpandResource</td></tr></table></blockquote><p>Specifies the resource key for the tooltip on the collapse/expand icon.&nbsp; If the resource for this key does not exist then the value is used as the tooltip.&nbsp; Default is &lsquo;collapse-expand&rsquo;.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.init"></a>init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.init = function(</td><td class=PParameter nowrap>container</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Initializes the &lt;container&gt; and creates the respective datastructures.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>container</td><td class=CDLDescription>DOM node that will contain the graph display.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createHandlers"></a>createHandlers</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createHandlers = function()</td></tr></table></blockquote><p>Creates the tooltip-, panning-, connection- and graph-handler (in this order).&nbsp; This is called in the constructor before <a href="#mxGraph.init" class=LFunction id=link921 onMouseOver="ShowTip(event, 'tt184', 'link921')" onMouseOut="HideTip('tt184')">init</a> is called.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createTooltipHandler"></a>createTooltipHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createTooltipHandler = function()</td></tr></table></blockquote><p>Creates and returns a new <a href="../handler/mxTooltipHandler-js.html#mxTooltipHandler" class=LClass id=link922 onMouseOver="ShowTip(event, 'tt187', 'link922')" onMouseOut="HideTip('tt187')">mxTooltipHandler</a> to be used in this graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createSelectionCellsHandler"></a>createSelectionCellsHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createSelectionCellsHandler = function()</td></tr></table></blockquote><p>Creates and returns a new <a href="../handler/mxTooltipHandler-js.html#mxTooltipHandler" class=LClass id=link923 onMouseOver="ShowTip(event, 'tt187', 'link923')" onMouseOut="HideTip('tt187')">mxTooltipHandler</a> to be used in this graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createConnectionHandler"></a>createConnectionHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createConnectionHandler = function()</td></tr></table></blockquote><p>Creates and returns a new <a href="../handler/mxConnectionHandler-js.html#mxConnectionHandler" class=LClass id=link924 onMouseOver="ShowTip(event, 'tt190', 'link924')" onMouseOut="HideTip('tt190')">mxConnectionHandler</a> to be used in this graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createGraphHandler"></a>createGraphHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createGraphHandler = function()</td></tr></table></blockquote><p>Creates and returns a new <a href="../handler/mxGraphHandler-js.html#mxGraphHandler" class=LClass id=link925 onMouseOver="ShowTip(event, 'tt192', 'link925')" onMouseOut="HideTip('tt192')">mxGraphHandler</a> to be used in this graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createPanningHandler"></a>createPanningHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createPanningHandler = function()</td></tr></table></blockquote><p>Creates and returns a new <a href="../handler/mxPanningHandler-js.html#mxPanningHandler" class=LClass id=link926 onMouseOver="ShowTip(event, 'tt194', 'link926')" onMouseOut="HideTip('tt194')">mxPanningHandler</a> to be used in this graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createPopupMenuHandler"></a>createPopupMenuHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createPopupMenuHandler = function()</td></tr></table></blockquote><p>Creates and returns a new <a href="../handler/mxPopupMenuHandler-js.html#mxPopupMenuHandler" class=LClass id=link927 onMouseOver="ShowTip(event, 'tt196', 'link927')" onMouseOut="HideTip('tt196')">mxPopupMenuHandler</a> to be used in this graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createSelectionModel"></a>createSelectionModel</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createSelectionModel = function()</td></tr></table></blockquote><p>Creates a new <a href="mxGraphSelectionModel-js.html#mxGraphSelectionModel" class=LClass id=link928 onMouseOver="ShowTip(event, 'tt48', 'link928')" onMouseOut="HideTip('tt48')">mxGraphSelectionModel</a> to be used in this graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createStylesheet"></a>createStylesheet</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createStylesheet = function()</td></tr></table></blockquote><p>Creates a new <a href="mxGraphSelectionModel-js.html#mxGraphSelectionModel" class=LClass id=link929 onMouseOver="ShowTip(event, 'tt48', 'link929')" onMouseOut="HideTip('tt48')">mxGraphSelectionModel</a> to be used in this graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createGraphView"></a>createGraphView</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createGraphView = function()</td></tr></table></blockquote><p>Creates a new <a href="mxGraphView-js.html#mxGraphView" class=LClass id=link930 onMouseOver="ShowTip(event, 'tt43', 'link930')" onMouseOut="HideTip('tt43')">mxGraphView</a> to be used in this graph.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createCellRenderer"></a>createCellRenderer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createCellRenderer = function()</td></tr></table></blockquote><p>Creates a new <a href="mxCellRenderer-js.html#mxCellRenderer" class=LClass id=link931 onMouseOver="ShowTip(event, 'tt52', 'link931')" onMouseOut="HideTip('tt52')">mxCellRenderer</a> to be used in this graph.</p></div></div></div>
2014-11-10 09:02:21 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createCellEditor"></a>createCellEditor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createCellEditor = function()</td></tr></table></blockquote><p>Creates a new <a href="mxCellEditor-js.html#mxCellEditor" class=LClass id=link932 onMouseOver="ShowTip(event, 'tt50', 'link932')" onMouseOut="HideTip('tt50')">mxCellEditor</a> to be used in this graph.</p></div></div></div>
2014-11-10 09:02:21 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getModel"></a>getModel</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getModel = function()</td></tr></table></blockquote><p>Returns the <a href="../model/mxGraphModel-js.html#mxGraphModel" class=LClass id=link933 onMouseOver="ShowTip(event, 'tt41', 'link933')" onMouseOut="HideTip('tt41')">mxGraphModel</a> that contains the cells.</p></div></div></div>
2014-11-10 09:02:21 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getView"></a>getView</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getView = function()</td></tr></table></blockquote><p>Returns the <a href="mxGraphView-js.html#mxGraphView" class=LClass id=link934 onMouseOver="ShowTip(event, 'tt43', 'link934')" onMouseOut="HideTip('tt43')">mxGraphView</a> that contains the <a href="mxCellState-js.html#mxCellState" class=LClass id=link935 onMouseOver="ShowTip(event, 'tt44', 'link935')" onMouseOut="HideTip('tt44')">mxCellStates</a>.</p></div></div></div>
2014-11-10 09:02:21 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getStylesheet"></a>getStylesheet</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getStylesheet = function()</td></tr></table></blockquote><p>Returns the <a href="mxStylesheet-js.html#mxStylesheet" class=LClass id=link936 onMouseOver="ShowTip(event, 'tt46', 'link936')" onMouseOut="HideTip('tt46')">mxStylesheet</a> that defines the style.</p></div></div></div>
2014-11-10 09:02:21 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setStylesheet"></a>setStylesheet</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setStylesheet = function(</td><td class=PParameter nowrap>stylesheet</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the <a href="mxStylesheet-js.html#mxStylesheet" class=LClass id=link937 onMouseOver="ShowTip(event, 'tt46', 'link937')" onMouseOut="HideTip('tt46')">mxStylesheet</a> that defines the style.</p></div></div></div>
2014-11-10 09:02:21 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getSelectionModel"></a>getSelectionModel</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getSelectionModel = function()</td></tr></table></blockquote><p>Returns the <a href="mxGraphSelectionModel-js.html#mxGraphSelectionModel" class=LClass id=link938 onMouseOver="ShowTip(event, 'tt48', 'link938')" onMouseOut="HideTip('tt48')">mxGraphSelectionModel</a> that contains the selection.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setSelectionModel"></a>setSelectionModel</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setSelectionModel = function(</td><td class=PParameter nowrap>selectionModel</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the &lt;mxSelectionModel&gt; that contains the selection.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getSelectionCellsForChanges"></a>getSelectionCellsForChanges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getSelectionCellsForChanges = function(</td><td class=PParameter nowrap>changes</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cells to be selected for the given array of changes.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.graphModelChanged"></a>graphModelChanged</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.graphModelChanged = function(</td><td class=PParameter nowrap>changes</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Called when the graph model changes.&nbsp; Invokes <a href="#mxGraph.processChange" class=LFunction id=link939 onMouseOver="ShowTip(event, 'tt211', 'link939')" onMouseOut="HideTip('tt211')">processChange</a> on each item of the given array to update the view accordingly.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>changes</td><td class=CDLDescription>Array that contains the individual changes.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getRemovedCellsForChanges"></a>getRemovedCellsForChanges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getRemovedCellsForChanges = function(</td><td class=PParameter nowrap>changes</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cells that have been removed from the model.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.processChange"></a>processChange</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.processChange = function(</td><td class=PParameter nowrap>change</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Processes the given change and invalidates the respective cached data in <a href="#mxGraph.view" class=LVariable id=link940 onMouseOver="ShowTip(event, 'tt42', 'link940')" onMouseOut="HideTip('tt42')">view</a>.&nbsp; This fires a &lt;root&gt; event if the root has changed in the model.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>change</td><td class=CDLDescription>Object that represents the change on the model.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.removeStateForCell"></a>removeStateForCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.removeStateForCell = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes all cached information for the given cell and its descendants.&nbsp; This is called when a cell was removed from the model.</p><h4 class=CHeading>Paramters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link941 onMouseOver="ShowTip(event, 'tt244', 'link941')" onMouseOut="HideTip('tt244')">mxCell</a> that was removed from the model.</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="mxGraph.Overlays"></a>Overlays</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.addCellOverlay"></a>addCellOverlay</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.addCellOverlay = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>overlay</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds an <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link942 onMouseOver="ShowTip(event, 'tt213', 'link942')" onMouseOut="HideTip('tt213')">mxCellOverlay</a> for the specified cell.&nbsp; This method fires an &lt;addoverlay&gt; event and returns the new <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link943 onMouseOver="ShowTip(event, 'tt213', 'link943')" onMouseOut="HideTip('tt213')">mxCellOverlay</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link944 onMouseOver="ShowTip(event, 'tt244', 'link944')" onMouseOut="HideTip('tt244')">mxCell</a> to add the overlay for.</td></tr><tr><td class=CDLEntry>overlay</td><td class=CDLDescription><a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link945 onMouseOver="ShowTip(event, 'tt213', 'link945')" onMouseOut="HideTip('tt213')">mxCellOverlay</a> to be added for the cell.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCellOverlays"></a>getCellOverlays</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCellOverlays = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the array of <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link946 onMouseOver="ShowTip(event, 'tt213', 'link946')" onMouseOut="HideTip('tt213')">mxCellOverlays</a> for the given cell or null, if no overlays are defined.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link947 onMouseOver="ShowTip(event, 'tt244', 'link947')" onMouseOut="HideTip('tt244')">mxCell</a> whose overlays should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.removeCellOverlay"></a>removeCellOverlay</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.removeCellOverlay = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>overlay</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes and returns the given <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link948 onMouseOver="ShowTip(event, 'tt213', 'link948')" onMouseOut="HideTip('tt213')">mxCellOverlay</a> from the given cell.&nbsp; This method fires a &lt;removeoverlay&gt; event.&nbsp; If no overlay is given, then all overlays are removed using &lt;removeOverlays&gt;.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link949 onMouseOver="ShowTip(event, 'tt244', 'link949')" onMouseOut="HideTip('tt244')">mxCell</a> whose overlay should be removed.</td></tr><tr><td class=CDLEntry>overlay</td><td class=CDLDescription>Optional <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link950 onMouseOver="ShowTip(event, 'tt213', 'link950')" onMouseOut="HideTip('tt213')">mxCellOverlay</a> to be removed.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.removeCellOverlays"></a>removeCellOverlays</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.removeCellOverlays = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes all <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link951 onMouseOver="ShowTip(event, 'tt213', 'link951')" onMouseOut="HideTip('tt213')">mxCellOverlays</a> from the given cell.&nbsp; This method fires a &lt;removeoverlay&gt; event for each <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link952 onMouseOver="ShowTip(event, 'tt213', 'link952')" onMouseOut="HideTip('tt213')">mxCellOverlay</a> and returns the array of <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link953 onMouseOver="ShowTip(event, 'tt213', 'link953')" onMouseOut="HideTip('tt213')">mxCellOverlays</a> that was removed from the cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link954 onMouseOver="ShowTip(event, 'tt244', 'link954')" onMouseOut="HideTip('tt244')">mxCell</a> whose overlays should be removed</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.clearCellOverlays"></a>clearCellOverlays</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.clearCellOverlays = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes all <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link955 onMouseOver="ShowTip(event, 'tt213', 'link955')" onMouseOut="HideTip('tt213')">mxCellOverlays</a> in the graph for the given cell and all its descendants.&nbsp; If no cell is specified then all overlays are removed from the graph.&nbsp; This implementation uses <a href="#mxGraph.removeCellOverlays" class=LFunction id=link956 onMouseOver="ShowTip(event, 'tt35', 'link956')" onMouseOut="HideTip('tt35')">removeCellOverlays</a> to remove the overlays from the individual cells.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link957 onMouseOver="ShowTip(event, 'tt244', 'link957')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the root of the subtree to remove the overlays from.&nbsp; Default is the root in the model.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCellWarning"></a>setCellWarning</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCellWarning = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>warning,</td></tr><tr><td></td><td class=PParameter nowrap>img,</td></tr><tr><td></td><td class=PParameter nowrap>isSelect</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates an overlay for the given cell using the warning and image or <a href="#mxGraph.warningImage" class=LVariable id=link958 onMouseOver="ShowTip(event, 'tt180', 'link958')" onMouseOut="HideTip('tt180')">warningImage</a> and returns the new <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link959 onMouseOver="ShowTip(event, 'tt213', 'link959')" onMouseOut="HideTip('tt213')">mxCellOverlay</a>.&nbsp; The warning is displayed as a tooltip in a red font and may contain HTML markup.&nbsp; If the warning is null or a zero length string, then all overlays are removed from the cell.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">graph.setCellWarning(cell, '&lt;b&gt;Warning:&lt;/b&gt;: Hello, World!');</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link960 onMouseOver="ShowTip(event, 'tt244', 'link960')" onMouseOut="HideTip('tt244')">mxCell</a> whose warning should be set.</td></tr><tr><td class=CDLEntry>warning</td><td class=CDLDescription>String that represents the warning to be displayed.</td></tr><tr><td class=CDLEntry>img</td><td class=CDLDescription>Optional <a href="../util/mxImage-js.html#mxImage" class=LClass id=link961 onMouseOver="ShowTip(event, 'tt77', 'link961')" onMouseOut="HideTip('tt77')">mxImage</a> to be used for the overlay.&nbsp; Default is <a href="#mxGraph.warningImage" class=LVariable id=link962 onMouseOver="ShowTip(event, 'tt180', 'link962')" onMouseOut="HideTip('tt180')">warningImage</a>.</td></tr><tr><td class=CDLEntry>isSelect</td><td class=CDLDescription>Optional boolean indicating if a click on the overlay should select the corresponding cell.&nbsp; Default is false.</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="mxGraph.In-place_editing"></a>In-place editing</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.startEditing"></a>startEditing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.startEditing = function(</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Calls <a href="#mxGraph.startEditingAtCell" class=LFunction id=link963 onMouseOver="ShowTip(event, 'tt30', 'link963')" onMouseOut="HideTip('tt30')">startEditingAtCell</a> using the given cell or the first selection cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Optional mouse event that triggered the editing.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.startEditingAtCell"></a>startEditingAtCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.startEditingAtCell = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Fires a <a href="#mxGraph.startEditing" class=LFunction id=link964 onMouseOver="ShowTip(event, 'tt217', 'link964')" onMouseOut="HideTip('tt217')">startEditing</a> event and invokes <a href="mxCellEditor-js.html#mxCellEditor.startEditing" class=LFunction id=link965 onMouseOver="ShowTip(event, 'tt218', 'link965')" onMouseOut="HideTip('tt218')">mxCellEditor.startEditing</a> on &lt;editor&gt;.&nbsp; After editing was started, a &lt;editingStarted&gt; event is fired.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link966 onMouseOver="ShowTip(event, 'tt244', 'link966')" onMouseOut="HideTip('tt244')">mxCell</a> to start the in-place editor for.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Optional mouse event that triggered the editing.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getEditingValue"></a>getEditingValue</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getEditingValue = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the initial value for in-place editing.&nbsp; This implementation returns <a href="#mxGraph.convertValueToString" class=LFunction id=link967 onMouseOver="ShowTip(event, 'tt327', 'link967')" onMouseOut="HideTip('tt327')">convertValueToString</a> for the given cell.&nbsp; If this function is overridden, then <a href="../model/mxGraphModel-js.html#mxGraphModel.valueForCellChanged" class=LFunction id=link968 onMouseOver="ShowTip(event, 'tt511', 'link968')" onMouseOut="HideTip('tt511')">mxGraphModel.valueForCellChanged</a> should take care of correctly storing the actual new value inside the user object.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link969 onMouseOver="ShowTip(event, 'tt244', 'link969')" onMouseOut="HideTip('tt244')">mxCell</a> for which the initial editing value should be returned.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Optional mouse event that triggered the editor.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-01-05 14:01:01 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.stopEditing"></a>stopEditing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.stopEditing = function(</td><td class=PParameter nowrap>cancel</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Stops the current editing and fires a &lt;editingStopped&gt; event.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cancel</td><td class=CDLDescription>Boolean that specifies if the current editing value should be stored.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.labelChanged"></a>labelChanged</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.labelChanged = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>value,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the label of the specified cell to the given value using <a href="#mxGraph.cellLabelChanged" class=LFunction id=link970 onMouseOver="ShowTip(event, 'tt32', 'link970')" onMouseOut="HideTip('tt32')">cellLabelChanged</a> and fires <a href="#mxGraph.mxEvent.LABEL_CHANGED" class=LEvent id=link971 onMouseOver="ShowTip(event, 'tt221', 'link971')" onMouseOut="HideTip('tt221')">mxEvent.LABEL_CHANGED</a> while the transaction is in progress.&nbsp; Returns the cell whose label was changed.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link972 onMouseOver="ShowTip(event, 'tt244', 'link972')" onMouseOut="HideTip('tt244')">mxCell</a> whose label should be changed.</td></tr><tr><td class=CDLEntry>value</td><td class=CDLDescription>New label to be assigned.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Optional event that triggered the change.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellLabelChanged"></a>cellLabelChanged</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cellLabelChanged = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>value,</td></tr><tr><td></td><td class=PParameter nowrap>autoSize</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the new label for a cell.&nbsp; If autoSize is true then <a href="#mxGraph.cellSizeUpdated" class=LFunction id=link973 onMouseOver="ShowTip(event, 'tt261', 'link973')" onMouseOut="HideTip('tt261')">cellSizeUpdated</a> will be called.</p><p>In the following example, the function is extended to map changes to attributes in an XML node, as shown in <a href="#mxGraph.convertValueToString" class=LFunction id=link974 onMouseOver="ShowTip(event, 'tt327', 'link974')" onMouseOut="HideTip('tt327')">convertValueToString</a>.&nbsp; Alternatively, the handling of this can be implemented as shown in <a href="../model/mxGraphModel-js.html#mxGraphModel.valueForCellChanged" class=LFunction id=link975 onMouseOver="ShowTip(event, 'tt511', 'link975')" onMouseOut="HideTip('tt511')">mxGraphModel.valueForCellChanged</a> without the need to clone the user object.</p><blockquote><pre class="prettyprint">var graphCellLabelChanged = graph.cellLabelChanged;
2012-05-21 20:32:26 +00:00
graph.cellLabelChanged = function(cell, newValue, autoSize)
{
// Cloned for correct undo/redo
var elt = cell.value.cloneNode(true);
elt.setAttribute('label', newValue);
newValue = elt;
graphCellLabelChanged.apply(this, arguments);
2015-04-23 20:18:31 +00:00
};</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link976 onMouseOver="ShowTip(event, 'tt244', 'link976')" onMouseOut="HideTip('tt244')">mxCell</a> whose label should be changed.</td></tr><tr><td class=CDLEntry>value</td><td class=CDLDescription>New label to be assigned.</td></tr><tr><td class=CDLEntry>autoSize</td><td class=CDLDescription>Boolean that specifies if <a href="#mxGraph.cellSizeUpdated" class=LFunction id=link977 onMouseOver="ShowTip(event, 'tt261', 'link977')" onMouseOut="HideTip('tt261')">cellSizeUpdated</a> should be called.</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="mxGraph.Event_processing"></a>Event processing</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.escape"></a>escape</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.escape = function(</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Processes an escape keystroke.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mouseevent that represents the keystroke.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.click"></a>click</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.click = function(</td><td class=PParameter nowrap>me</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Processes a singleclick on an optional cell and fires a <a href="#mxGraph.click" class=LFunction id=link978 onMouseOver="ShowTip(event, 'tt24', 'link978')" onMouseOut="HideTip('tt24')">click</a> event.&nbsp; The click event is fired initially.&nbsp; If the graph is enabled and the event has not been consumed, then the cell is selected using <a href="#mxGraph.selectCellForEvent" class=LFunction id=link979 onMouseOver="ShowTip(event, 'tt485', 'link979')" onMouseOut="HideTip('tt485')">selectCellForEvent</a> or the selection is cleared using <a href="#mxGraph.clearSelection" class=LFunction id=link980 onMouseOver="ShowTip(event, 'tt465', 'link980')" onMouseOut="HideTip('tt465')">clearSelection</a>.&nbsp; The events consumed state is set to true if the corresponding <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link981 onMouseOver="ShowTip(event, 'tt222', 'link981')" onMouseOut="HideTip('tt222')">mxMouseEvent</a> has been consumed.</p><p>To handle a click event, use the following code.</p><blockquote><pre class="prettyprint">graph.addListener(mxEvent.CLICK, function(sender, evt)
2013-05-23 16:14:48 +00:00
{
var e = evt.getProperty('event'); // mouse event
var cell = evt.getProperty('cell'); // cell may be null
if (cell != null)
{
// Do something useful with cell and consume the event
evt.consume();
}
2015-04-23 20:18:31 +00:00
});</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>me</td><td class=CDLDescription><a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link982 onMouseOver="ShowTip(event, 'tt222', 'link982')" onMouseOut="HideTip('tt222')">mxMouseEvent</a> that represents the single click.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2012-12-18 13:09:38 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.dblClick"></a>dblClick</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.dblClick = function(</td><td class=PParameter nowrap>evt,</td></tr><tr><td></td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Processes a doubleclick on an optional cell and fires a &lt;dblclick&gt; event.&nbsp; The event is fired initially.&nbsp; If the graph is enabled and the event has not been consumed, then &lt;edit&gt; is called with the given cell.&nbsp; The event is ignored if no cell was specified.</p><p>Example for overriding this method.</p><blockquote><pre class="prettyprint">graph.dblClick = function(evt, cell)
2012-05-21 20:32:26 +00:00
{
var mxe = new mxEventObject(mxEvent.DOUBLE_CLICK, 'event', evt, 'cell', cell);
this.fireEvent(mxe);
if (this.isEnabled() &amp;&amp; !mxEvent.isConsumed(evt) &amp;&amp; !mxe.isConsumed())
{
mxUtils.alert('Hello, World!');
mxe.consume();
}
2012-12-18 13:09:38 +00:00
}</pre></blockquote><p>Example listener for this event.</p><blockquote><pre class="prettyprint">graph.addListener(mxEvent.DOUBLE_CLICK, function(sender, evt)
{
var cell = evt.getProperty('cell');
// do something with the cell...
2015-04-23 20:18:31 +00:00
});</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mouseevent that represents the doubleclick.</td></tr><tr><td class=CDLEntry>cell</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link983 onMouseOver="ShowTip(event, 'tt244', 'link983')" onMouseOut="HideTip('tt244')">mxCell</a> under the mousepointer.</td></tr></table></div></div></div>
2013-06-28 19:07:06 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.tapAndHold"></a>tapAndHold</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.tapAndHold = function(</td><td class=PParameter nowrap>me</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles the <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link984 onMouseOver="ShowTip(event, 'tt222', 'link984')" onMouseOut="HideTip('tt222')">mxMouseEvent</a> by highlighting the <a href="mxCellState-js.html#mxCellState" class=LClass id=link985 onMouseOver="ShowTip(event, 'tt44', 'link985')" onMouseOut="HideTip('tt44')">mxCellState</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>me</td><td class=CDLDescription><a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link986 onMouseOver="ShowTip(event, 'tt222', 'link986')" onMouseOut="HideTip('tt222')">mxMouseEvent</a> that represents the touch event.</td></tr><tr><td class=CDLEntry>state</td><td class=CDLDescription>Optional <a href="mxCellState-js.html#mxCellState" class=LClass id=link987 onMouseOver="ShowTip(event, 'tt44', 'link987')" onMouseOut="HideTip('tt44')">mxCellState</a> that is associated with the event.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.scrollPointToVisible"></a>scrollPointToVisible</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.scrollPointToVisible = function(</td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y,</td></tr><tr><td></td><td class=PParameter nowrap>extend,</td></tr><tr><td></td><td class=PParameter nowrap>border</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Scrolls the graph to the given point, extending the graph container if specified.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createPanningManager"></a>createPanningManager</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.createPanningManager = function()</td></tr></table></blockquote><p>Creates and returns an <a href="../util/mxPanningManager-js.html#mxPanningManager" class=LClass id=link988 onMouseOver="ShowTip(event, 'tt224', 'link988')" onMouseOut="HideTip('tt224')">mxPanningManager</a>.</p></div></div></div>
2012-06-01 10:53:50 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getBorderSizes"></a>getBorderSizes</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getBorderSizes = function()</td></tr></table></blockquote><p>Returns the size of the border and padding on all four sides of the container.&nbsp; The left, top, right and bottom borders are stored in the x, y, width and height of the returned <a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link989 onMouseOver="ShowTip(event, 'tt133', 'link989')" onMouseOut="HideTip('tt133')">mxRectangle</a>, respectively.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getPreferredPageSize"></a>getPreferredPageSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getPreferredPageSize = function(</td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>width,</td></tr><tr><td></td><td class=PParameter nowrap>height</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the preferred size of the background page if <a href="#mxGraph.preferPageSize" class=LVariable id=link990 onMouseOver="ShowTip(event, 'tt84', 'link990')" onMouseOut="HideTip('tt84')">preferPageSize</a> is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.sizeDidChange"></a>sizeDidChange</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.sizeDidChange = function()</td></tr></table></blockquote><p>Called when the size of the graph has changed.&nbsp; This implementation fires a &lt;size&gt; event after updating the clipping region of the SVG element in SVG-bases browsers.</p></div></div></div>
2012-07-20 10:35:30 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.doResizeContainer"></a>doResizeContainer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.doResizeContainer = function(</td><td class=PParameter nowrap>width,</td></tr><tr><td></td><td class=PParameter nowrap>height</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Resizes the container for the given graph width and height.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.updatePageBreaks"></a>updatePageBreaks</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.updatePageBreaks = function(</td><td class=PParameter nowrap>visible,</td></tr><tr><td></td><td class=PParameter nowrap>width,</td></tr><tr><td></td><td class=PParameter nowrap>height</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Invokes from <a href="#mxGraph.sizeDidChange" class=LFunction id=link991 onMouseOver="ShowTip(event, 'tt29', 'link991')" onMouseOut="HideTip('tt29')">sizeDidChange</a> to redraw the page breaks.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>visible</td><td class=CDLDescription>Boolean that specifies if page breaks should be shown.</td></tr><tr><td class=CDLEntry>width</td><td class=CDLDescription>Specifies the width of the container in pixels.</td></tr><tr><td class=CDLEntry>height</td><td class=CDLDescription>Specifies the height of the container in pixels.</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="mxGraph.Cell_styles"></a>Cell styles</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCellStyle"></a>getCellStyle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCellStyle = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns an array of key, value pairs representing the cell style for the given cell.&nbsp; If no string is defined in the model that specifies the style, then the default style for the cell is returned or <a href="#mxGraph.EMPTY_ARRAY" class=LVariable id=link992 onMouseOver="ShowTip(event, 'tt37', 'link992')" onMouseOut="HideTip('tt37')">EMPTY_ARRAY</a>, if not style can be found.&nbsp; Note: You should try and get the cell state for the given cell and use the cached style in the state before using this method.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link993 onMouseOver="ShowTip(event, 'tt244', 'link993')" onMouseOut="HideTip('tt244')">mxCell</a> whose style should be returned as an array.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.postProcessCellStyle"></a>postProcessCellStyle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.postProcessCellStyle = function(</td><td class=PParameter nowrap>style</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Tries to resolve the value for the image style in the image bundles and turns short data URIs as defined in mxImageBundle to data URIs as defined in RFC 2397 of the IETF.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCellStyle"></a>setCellStyle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCellStyle = function(</td><td class=PParameter nowrap>style,</td></tr><tr><td></td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the style of the specified cells.&nbsp; If no cells are given, then the selection cells are changed.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>style</td><td class=CDLDescription>String representing the new style of the cells.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription>Optional array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link994 onMouseOver="ShowTip(event, 'tt244', 'link994')" onMouseOut="HideTip('tt244')">mxCells</a> to set the style for.&nbsp; Default is the selection cells.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.toggleCellStyle"></a>toggleCellStyle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.toggleCellStyle = function(</td><td class=PParameter nowrap>key,</td></tr><tr><td></td><td class=PParameter nowrap>defaultValue,</td></tr><tr><td></td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Toggles the boolean value for the given key in the style of the given cell and returns the new value as 0 or 1.&nbsp; If no cell is specified then the selection cell is used.</p><h4 class=CHeading>Parameter</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>key</td><td class=CDLDescription>String representing the key for the boolean value to be toggled.</td></tr><tr><td class=CDLEntry>defaultValue</td><td class=CDLDescription>Optional boolean default value if no value is defined.&nbsp; Default is false.</td></tr><tr><td class=CDLEntry>cell</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link995 onMouseOver="ShowTip(event, 'tt244', 'link995')" onMouseOut="HideTip('tt244')">mxCell</a> whose style should be modified.&nbsp; Default is the selection cell.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.toggleCellStyles"></a>toggleCellStyles</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.toggleCellStyles = function(</td><td class=PParameter nowrap>key,</td></tr><tr><td></td><td class=PParameter nowrap>defaultValue,</td></tr><tr><td></td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Toggles the boolean value for the given key in the style of the given cells and returns the new value as 0 or 1.&nbsp; If no cells are specified, then the selection cells are used.&nbsp; For example, this can be used to toggle <a href="../util/mxConstants-js.html#mxConstants.STYLE_ROUNDED" class=LVariable id=link996 onMouseOver="ShowTip(event, 'tt525', 'link996')" onMouseOut="HideTip('tt525')">mxConstants.STYLE_ROUNDED</a> or any other style with a boolean value.</p><h4 class=CHeading>Parameter</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>key</td><td class=CDLDescription>String representing the key for the boolean value to be toggled.</td></tr><tr><td class=CDLEntry>defaultValue</td><td class=CDLDescription>Optional boolean default value if no value is defined.&nbsp; Default is false.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription>Optional array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link997 onMouseOver="ShowTip(event, 'tt244', 'link997')" onMouseOut="HideTip('tt244')">mxCells</a> whose styles should be modified.&nbsp; Default is the selection cells.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCellStyles"></a>setCellStyles</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCellStyles = function(</td><td class=PParameter nowrap>key,</td></tr><tr><td></td><td class=PParameter nowrap>value,</td></tr><tr><td></td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the key to value in the styles of the given cells.&nbsp; This will modify the existing cell styles in-place and override any existing assignment for the given key.&nbsp; If no cells are specified, then the selection cells are changed.&nbsp; If no value is specified, then the respective key is removed from the styles.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>key</td><td class=CDLDescription>String representing the key to be assigned.</td></tr><tr><td class=CDLEntry>value</td><td class=CDLDescription>String representing the new value for the key.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription>Optional array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link998 onMouseOver="ShowTip(event, 'tt244', 'link998')" onMouseOut="HideTip('tt244')">mxCells</a> to change the style for.&nbsp; Default is the selection cells.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.toggleCellStyleFlags"></a>toggleCellStyleFlags</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.toggleCellStyleFlags = function(</td><td class=PParameter nowrap>key,</td></tr><tr><td></td><td class=PParameter nowrap>flag,</td></tr><tr><td></td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Toggles the given bit for the given key in the styles of the specified cells.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>key</td><td class=CDLDescription>String representing the key to toggle the flag in.</td></tr><tr><td class=CDLEntry>flag</td><td class=CDLDescription>Integer that represents the bit to be toggled.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription>Optional array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link999 onMouseOver="ShowTip(event, 'tt244', 'link999')" onMouseOut="HideTip('tt244')">mxCells</a> to change the style for.&nbsp; Default is the selection cells.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCellStyleFlags"></a>setCellStyleFlags</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCellStyleFlags = function(</td><td class=PParameter nowrap>key,</td></tr><tr><td></td><td class=PParameter nowrap>flag,</td></tr><tr><td></td><td class=PParameter nowrap>value,</td></tr><tr><td></td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets or toggles the given bit for the given key in the styles of the specified cells.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>key</td><td class=CDLDescription>String representing the key to toggle the flag in.</td></tr><tr><td class=CDLEntry>flag</td><td class=CDLDescription>Integer that represents the bit to be toggled.</td></tr><tr><td class=CDLEntry>value</td><td class=CDLDescription>Boolean value to be used or null if the value should be toggled.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription>Optional array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1000 onMouseOver="ShowTip(event, 'tt244', 'link1000')" onMouseOut="HideTip('tt244')">mxCells</a> to change the style for.&nbsp; Default is the selection cells.</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="mxGraph.Cell_alignment_and_orientation"></a>Cell alignment and orientation</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.alignCells"></a>alignCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.alignCells = function(</td><td class=PParameter nowrap>align,</td></tr><tr><td></td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>param</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Aligns the given cells vertically or horizontally according to the given alignment using the optional parameter as the coordinate.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>align</td><td class=CDLDescription>Specifies the alignment.&nbsp; Possible values are all constants in mxConstants with an ALIGN prefix.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription>Array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1001 onMouseOver="ShowTip(event, 'tt244', 'link1001')" onMouseOut="HideTip('tt244')">mxCells</a> to be aligned.</td></tr><tr><td class=CDLEntry>param</td><td class=CDLDescription>Optional coordinate for the alignment.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.flipEdge"></a>flipEdge</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.flipEdge = function(</td><td class=PParameter nowrap>edge</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Toggles the style of the given edge between null (or empty) and <a href="#mxGraph.alternateEdgeStyle" class=LVariable id=link1002 onMouseOver="ShowTip(event, 'tt75', 'link1002')" onMouseOut="HideTip('tt75')">alternateEdgeStyle</a>.&nbsp; This method fires <a href="#mxGraph.mxEvent.FLIP_EDGE" class=LEvent id=link1003 onMouseOver="ShowTip(event, 'tt526', 'link1003')" onMouseOut="HideTip('tt526')">mxEvent.FLIP_EDGE</a> while the transaction is in progress.&nbsp; Returns the edge that was flipped.</p><p>Here is an example that overrides this implementation to invert the value of <a href="../util/mxConstants-js.html#mxConstants.STYLE_ELBOW" class=LVariable id=link1004 onMouseOver="ShowTip(event, 'tt527', 'link1004')" onMouseOut="HideTip('tt527')">mxConstants.STYLE_ELBOW</a> without removing any existing styles.</p><blockquote><pre class="prettyprint">graph.flipEdge = function(edge)
2012-05-21 20:32:26 +00:00
{
if (edge != null)
{
var state = this.view.getState(edge);
var style = (state != null) ? state.style : this.getCellStyle(edge);
if (style != null)
{
var elbow = mxUtils.getValue(style, mxConstants.STYLE_ELBOW,
mxConstants.ELBOW_HORIZONTAL);
var value = (elbow == mxConstants.ELBOW_HORIZONTAL) ?
mxConstants.ELBOW_VERTICAL : mxConstants.ELBOW_HORIZONTAL;
this.setCellStyles(mxConstants.STYLE_ELBOW, value, [edge]);
}
}
2015-04-23 20:18:31 +00:00
};</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1005 onMouseOver="ShowTip(event, 'tt244', 'link1005')" onMouseOut="HideTip('tt244')">mxCell</a> whose style should be changed.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.addImageBundle"></a>addImageBundle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.addImageBundle = function(</td><td class=PParameter nowrap>bundle</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the specified <a href="../util/mxImageBundle-js.html#mxImageBundle" class=LClass id=link1006 onMouseOver="ShowTip(event, 'tt238', 'link1006')" onMouseOut="HideTip('tt238')">mxImageBundle</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.removeImageBundle"></a>removeImageBundle</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.removeImageBundle = function(</td><td class=PParameter nowrap>bundle</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes the specified <a href="../util/mxImageBundle-js.html#mxImageBundle" class=LClass id=link1007 onMouseOver="ShowTip(event, 'tt238', 'link1007')" onMouseOut="HideTip('tt238')">mxImageBundle</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getImageFromBundles"></a>getImageFromBundles</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getImageFromBundles = function(</td><td class=PParameter nowrap>key</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Searches all <a href="#mxGraph.imageBundles" class=LVariable id=link1008 onMouseOver="ShowTip(event, 'tt172', 'link1008')" onMouseOut="HideTip('tt172')">imageBundles</a> for the specified key and returns the value for the first match or null if the key is not found.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraph.Order"></a>Order</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.orderCells"></a>orderCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.orderCells = function(</td><td class=PParameter nowrap>back,</td></tr><tr><td></td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Moves the given cells to the front or back.&nbsp; The change is carried out using <a href="#mxGraph.cellsOrdered" class=LFunction id=link1009 onMouseOver="ShowTip(event, 'tt5', 'link1009')" onMouseOut="HideTip('tt5')">cellsOrdered</a>.&nbsp; This method fires <a href="#mxGraph.mxEvent.ORDER_CELLS" class=LEvent id=link1010 onMouseOver="ShowTip(event, 'tt528', 'link1010')" onMouseOut="HideTip('tt528')">mxEvent.ORDER_CELLS</a> while the transaction is in progress.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>back</td><td class=CDLDescription>Boolean that specifies if the cells should be moved to back.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription>Array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1011 onMouseOver="ShowTip(event, 'tt244', 'link1011')" onMouseOut="HideTip('tt244')">mxCells</a> to move to the background.&nbsp; If null is specified then the selection cells are used.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsOrdered"></a>cellsOrdered</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cellsOrdered = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>back</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Moves the given cells to the front or back.&nbsp; This method fires <a href="#mxGraph.mxEvent.CELLS_ORDERED" class=LEvent id=link1012 onMouseOver="ShowTip(event, 'tt529', 'link1012')" onMouseOut="HideTip('tt529')">mxEvent.CELLS_ORDERED</a> while the transaction is in progress.</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=link1013 onMouseOver="ShowTip(event, 'tt244', 'link1013')" onMouseOut="HideTip('tt244')">mxCells</a> whose order should be changed.</td></tr><tr><td class=CDLEntry>back</td><td class=CDLDescription>Boolean that specifies if the cells should be moved to back.</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="mxGraph.Grouping"></a>Grouping</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.groupCells"></a>groupCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.groupCells = function(</td><td class=PParameter nowrap>group,</td></tr><tr><td></td><td class=PParameter nowrap>border,</td></tr><tr><td></td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the cells into the given group.&nbsp; The change is carried out using <a href="#mxGraph.cellsAdded" class=LFunction id=link1014 onMouseOver="ShowTip(event, 'tt10', 'link1014')" onMouseOut="HideTip('tt10')">cellsAdded</a>, <a href="#mxGraph.cellsMoved" class=LFunction id=link1015 onMouseOver="ShowTip(event, 'tt20', 'link1015')" onMouseOut="HideTip('tt20')">cellsMoved</a> and <a href="#mxGraph.cellsResized" class=LFunction id=link1016 onMouseOver="ShowTip(event, 'tt18', 'link1016')" onMouseOut="HideTip('tt18')">cellsResized</a>.&nbsp; This method fires <a href="#mxGraph.mxEvent.GROUP_CELLS" class=LEvent id=link1017 onMouseOver="ShowTip(event, 'tt530', 'link1017')" onMouseOut="HideTip('tt530')">mxEvent.GROUP_CELLS</a> while the transaction is in progress.&nbsp; Returns the new group.&nbsp; A group is only created if there is at least one entry in the given array of cells.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>group</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1018 onMouseOver="ShowTip(event, 'tt244', 'link1018')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the target group.&nbsp; If null is specified then a new group is created using <a href="#mxGraph.createGroupCell" class=LFunction id=link1019 onMouseOver="ShowTip(event, 'tt243', 'link1019')" onMouseOut="HideTip('tt243')">createGroupCell</a>.</td></tr><tr><td class=CDLEntry>border</td><td class=CDLDescription>Optional integer that specifies the border between the child area and the group bounds.&nbsp; Default is 0.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription>Optional array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1020 onMouseOver="ShowTip(event, 'tt244', 'link1020')" onMouseOut="HideTip('tt244')">mxCells</a> to be grouped.&nbsp; If null is specified then the selection cells are used.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCellsForGroup"></a>getCellsForGroup</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCellsForGroup = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cells with the same parent as the first cell in the given array.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getBoundsForGroup"></a>getBoundsForGroup</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getBoundsForGroup = function(</td><td class=PParameter nowrap>group,</td></tr><tr><td></td><td class=PParameter nowrap>children,</td></tr><tr><td></td><td class=PParameter nowrap>border</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bounds to be used for the given group and children.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createGroupCell"></a>createGroupCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.createGroupCell = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hook for creating the group cell to hold the given array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1021 onMouseOver="ShowTip(event, 'tt244', 'link1021')" onMouseOut="HideTip('tt244')">mxCells</a> if no group cell was given to the &lt;group&gt; function.</p><p>The following code can be used to set the style of new group cells.</p><blockquote><pre class="prettyprint">var graphCreateGroupCell = graph.createGroupCell;
2012-05-21 20:32:26 +00:00
graph.createGroupCell = function(cells)
{
var group = graphCreateGroupCell.apply(this, arguments);
group.setStyle('group');
return group;
};</pre></blockquote></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.ungroupCells"></a>ungroupCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.ungroupCells = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Ungroups the given cells by moving the children the children to their parents parent and removing the empty groups.&nbsp; Returns the children that have been removed from the groups.</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 cells to be ungrouped.&nbsp; If null is specified then the selection cells are used.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.removeCellsFromParent"></a>removeCellsFromParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.removeCellsFromParent = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes the specified cells from their parents and adds them to the default parent.&nbsp; Returns the cells that were removed from their parents.</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=link1022 onMouseOver="ShowTip(event, 'tt244', 'link1022')" onMouseOut="HideTip('tt244')">mxCells</a> to be removed from their parents.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2014-11-28 08:55:09 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.updateGroupBounds"></a>updateGroupBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.updateGroupBounds = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>border,</td></tr><tr><td></td><td class=PParameter nowrap>moveGroup,</td></tr><tr><td></td><td class=PParameter nowrap>topBorder,</td></tr><tr><td></td><td class=PParameter nowrap>rightBorder,</td></tr><tr><td></td><td class=PParameter nowrap>bottomBorder,</td></tr><tr><td></td><td class=PParameter nowrap>leftBorder</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the bounds of the given groups to include all children and returns the passed-in cells.&nbsp; Call this with the groups in parent to child order, top-most group first, the cells are processed in reverse order and cells with no children are ignored.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cells</td><td class=CDLDescription>The groups whose bounds should be updated.&nbsp; If this is null, then the selection cells are used.</td></tr><tr><td class=CDLEntry>border</td><td class=CDLDescription>Optional border to be added in the group.&nbsp; Default is 0.</td></tr><tr><td class=CDLEntry>moveGroup</td><td class=CDLDescription>Optional boolean that allows the group to be moved.&nbsp; Default is false.</td></tr><tr><td class=CDLEntry>topBorder</td><td class=CDLDescription>Optional top border to be added in the group.&nbsp; Default is 0.</td></tr><tr><td class=CDLEntry>rightBorder</td><td class=CDLDescription>Optional top border to be added in the group.&nbsp; Default is 0.</td></tr><tr><td class=CDLEntry>bottomBorder</td><td class=CDLDescription>Optional top border to be added in the group.&nbsp; Default is 0.</td></tr><tr><td class=CDLEntry>leftBorder</td><td class=CDLDescription>Optional top border to be added in the group.&nbsp; Default is 0.</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="mxGraph.Cell_cloning,insertion_and_removal"></a>Cell cloning, insertion and removal</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cloneCells"></a>cloneCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cloneCells = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>allowInvalidEdges</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the clones for the given cells.&nbsp; If the terminal of an edge is not in the given array, then the respective end is assigned a terminal point and the terminal is removed.</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=link1023 onMouseOver="ShowTip(event, 'tt244', 'link1023')" onMouseOut="HideTip('tt244')">mxCells</a> to be cloned.</td></tr><tr><td class=CDLEntry>allowInvalidEdges</td><td class=CDLDescription>Optional boolean that specifies if invalid edges should be cloned.&nbsp; Default is true.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.insertVertex"></a>insertVertex</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.insertVertex = function(</td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>id,</td></tr><tr><td></td><td class=PParameter nowrap>value,</td></tr><tr><td></td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y,</td></tr><tr><td></td><td class=PParameter nowrap>width,</td></tr><tr><td></td><td class=PParameter nowrap>height,</td></tr><tr><td></td><td class=PParameter nowrap>style,</td></tr><tr><td></td><td class=PParameter nowrap>relative</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds a new vertex into the given parent <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1024 onMouseOver="ShowTip(event, 'tt244', 'link1024')" onMouseOut="HideTip('tt244')">mxCell</a> using value as the user object and the given coordinates as the <a href="../model/mxGeometry-js.html#mxGeometry" class=LClass id=link1025 onMouseOver="ShowTip(event, 'tt248', 'link1025')" onMouseOut="HideTip('tt248')">mxGeometry</a> of the new vertex.&nbsp; The id and style are used for the respective properties of the new <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1026 onMouseOver="ShowTip(event, 'tt244', 'link1026')" onMouseOut="HideTip('tt244')">mxCell</a>, which is returned.</p><p>When adding new vertices from a mouse event, one should take into account the offset of the graph container and the scale and translation of the view in order to find the correct unscaled, untranslated coordinates using <a href="#mxGraph.getPointForEvent" class=LFunction id=link1027 onMouseOver="ShowTip(event, 'tt458', 'link1027')" onMouseOut="HideTip('tt458')">mxGraph.getPointForEvent</a> as follows:</p><blockquote><pre class="prettyprint">var pt = graph.getPointForEvent(evt);
2012-05-21 20:32:26 +00:00
var parent = graph.getDefaultParent();
graph.insertVertex(parent, null,
2015-04-23 20:18:31 +00:00
'Hello, World!', x, y, 220, 30);</pre></blockquote><p>For adding image cells, the style parameter can be assigned as</p><blockquote><pre class="prettyprint">stylename;image=imageUrl</pre></blockquote><p>See <a href="#mxGraph.mxGraph" class=LFunction id=link1028 onMouseOver="ShowTip(event, 'tt36', 'link1028')" onMouseOut="HideTip('tt36')">mxGraph</a> for more information on using images.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1029 onMouseOver="ShowTip(event, 'tt244', 'link1029')" onMouseOut="HideTip('tt244')">mxCell</a> that specifies the parent of the new vertex.</td></tr><tr><td class=CDLEntry>id</td><td class=CDLDescription>Optional string that defines the Id of the new vertex.</td></tr><tr><td class=CDLEntry>value</td><td class=CDLDescription>Object to be used as the user object.</td></tr><tr><td class=CDLEntry>x</td><td class=CDLDescription>Integer that defines the x coordinate of the vertex.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Integer that defines the y coordinate of the vertex.</td></tr><tr><td class=CDLEntry>width</td><td class=CDLDescription>Integer that defines the width of the vertex.</td></tr><tr><td class=CDLEntry>height</td><td class=CDLDescription>Integer that defines the height of the vertex.</td></tr><tr><td class=CDLEntry>style</td><td class=CDLDescription>Optional string that defines the cell style.</td></tr><tr><td class=CDLEntry>relative</td><td class=CDLDescription>Optional boolean that specifies if the geometry is relative.&nbsp; Default is false.</td></tr></table></div></div></div>
2013-10-22 11:05:54 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createVertex"></a>createVertex</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.createVertex = function(</td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>id,</td></tr><tr><td></td><td class=PParameter nowrap>value,</td></tr><tr><td></td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y,</td></tr><tr><td></td><td class=PParameter nowrap>width,</td></tr><tr><td></td><td class=PParameter nowrap>height,</td></tr><tr><td></td><td class=PParameter nowrap>style,</td></tr><tr><td></td><td class=PParameter nowrap>relative</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hook method that creates the new vertex for <a href="#mxGraph.insertVertex" class=LFunction id=link1030 onMouseOver="ShowTip(event, 'tt247', 'link1030')" onMouseOut="HideTip('tt247')">insertVertex</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.insertEdge"></a>insertEdge</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.insertEdge = function(</td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>id,</td></tr><tr><td></td><td class=PParameter nowrap>value,</td></tr><tr><td></td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>target,</td></tr><tr><td></td><td class=PParameter nowrap>style</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds a new edge into the given parent <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1031 onMouseOver="ShowTip(event, 'tt244', 'link1031')" onMouseOut="HideTip('tt244')">mxCell</a> using value as the user object and the given source and target as the terminals of the new edge.&nbsp; The id and style are used for the respective properties of the new <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1032 onMouseOver="ShowTip(event, 'tt244', 'link1032')" onMouseOut="HideTip('tt244')">mxCell</a>, which is returned.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1033 onMouseOver="ShowTip(event, 'tt244', 'link1033')" onMouseOut="HideTip('tt244')">mxCell</a> that specifies the parent of the new edge.</td></tr><tr><td class=CDLEntry>id</td><td class=CDLDescription>Optional string that defines the Id of the new edge.</td></tr><tr><td class=CDLEntry>value</td><td class=CDLDescription>JavaScript object to be used as the user object.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1034 onMouseOver="ShowTip(event, 'tt244', 'link1034')" onMouseOut="HideTip('tt244')">mxCell</a> that defines the source of the edge.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1035 onMouseOver="ShowTip(event, 'tt244', 'link1035')" onMouseOut="HideTip('tt244')">mxCell</a> that defines the target of the edge.</td></tr><tr><td class=CDLEntry>style</td><td class=CDLDescription>Optional string that defines the cell style.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createEdge"></a>createEdge</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.createEdge = function(</td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>id,</td></tr><tr><td></td><td class=PParameter nowrap>value,</td></tr><tr><td></td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>target,</td></tr><tr><td></td><td class=PParameter nowrap>style</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hook method that creates the new edge for <a href="#mxGraph.insertEdge" class=LFunction id=link1036 onMouseOver="ShowTip(event, 'tt250', 'link1036')" onMouseOut="HideTip('tt250')">insertEdge</a>.&nbsp; This implementation does not set the source and target of the edge, these are set when the edge is added to the model.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.addEdge"></a>addEdge</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.addEdge = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>target,</td></tr><tr><td></td><td class=PParameter nowrap>index</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the edge to the parent and connects it to the given source and target terminals.&nbsp; This is a shortcut method.&nbsp; Returns the edge that was added.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1037 onMouseOver="ShowTip(event, 'tt244', 'link1037')" onMouseOut="HideTip('tt244')">mxCell</a> to be inserted into the given parent.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1038 onMouseOver="ShowTip(event, 'tt244', 'link1038')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the new parent.&nbsp; If no parent is given then the default parent is used.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1039 onMouseOver="ShowTip(event, 'tt244', 'link1039')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the source terminal.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1040 onMouseOver="ShowTip(event, 'tt244', 'link1040')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the target terminal.</td></tr><tr><td class=CDLEntry>index</td><td class=CDLDescription>Optional index to insert the cells at.&nbsp; Default is to append.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.addCell"></a>addCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.addCell = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>index,</td></tr><tr><td></td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the cell to the parent and connects it to the given source and target terminals.&nbsp; This is a shortcut method.&nbsp; Returns the cell that was added.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1041 onMouseOver="ShowTip(event, 'tt244', 'link1041')" onMouseOut="HideTip('tt244')">mxCell</a> to be inserted into the given parent.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1042 onMouseOver="ShowTip(event, 'tt244', 'link1042')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the new parent.&nbsp; If no parent is given then the default parent is used.</td></tr><tr><td class=CDLEntry>index</td><td class=CDLDescription>Optional index to insert the cells at.&nbsp; Default is to append.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1043 onMouseOver="ShowTip(event, 'tt244', 'link1043')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the source terminal.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1044 onMouseOver="ShowTip(event, 'tt244', 'link1044')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the target terminal.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.addCells"></a>addCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.addCells = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>index,</td></tr><tr><td></td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the cells to the parent at the given index, connecting each cell to the optional source and target terminal.&nbsp; The change is carried out using <a href="#mxGraph.cellsAdded" class=LFunction id=link1045 onMouseOver="ShowTip(event, 'tt10', 'link1045')" onMouseOut="HideTip('tt10')">cellsAdded</a>.&nbsp; This method fires <a href="#mxGraph.mxEvent.ADD_CELLS" class=LEvent id=link1046 onMouseOver="ShowTip(event, 'tt531', 'link1046')" onMouseOut="HideTip('tt531')">mxEvent.ADD_CELLS</a> while the transaction is in progress.&nbsp; Returns the cells that were added.</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=link1047 onMouseOver="ShowTip(event, 'tt244', 'link1047')" onMouseOut="HideTip('tt244')">mxCells</a> to be inserted.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1048 onMouseOver="ShowTip(event, 'tt244', 'link1048')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the new parent.&nbsp; If no parent is given then the default parent is used.</td></tr><tr><td class=CDLEntry>index</td><td class=CDLDescription>Optional index to insert the cells at.&nbsp; Default is to append.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Optional source <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1049 onMouseOver="ShowTip(event, 'tt244', 'link1049')" onMouseOut="HideTip('tt244')">mxCell</a> for all inserted cells.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription>Optional target <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1050 onMouseOver="ShowTip(event, 'tt244', 'link1050')" onMouseOut="HideTip('tt244')">mxCell</a> for all inserted cells.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsAdded"></a>cellsAdded</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cellsAdded = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>index,</td></tr><tr><td></td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>target,</td></tr><tr><td></td><td class=PParameter nowrap>absolute,</td></tr><tr><td></td><td class=PParameter nowrap>constrain</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the specified cells to the given parent.&nbsp; This method fires <a href="#mxGraph.mxEvent.CELLS_ADDED" class=LEvent id=link1051 onMouseOver="ShowTip(event, 'tt532', 'link1051')" onMouseOut="HideTip('tt532')">mxEvent.CELLS_ADDED</a> while the transaction is in progress.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.autoSizeCell"></a>autoSizeCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.autoSizeCell = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>recurse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes the given cells from the graph including all connected edges if includeEdges is true.&nbsp; The change is carried out using <a href="#mxGraph.cellsRemoved" class=LFunction id=link1052 onMouseOver="ShowTip(event, 'tt12', 'link1052')" onMouseOut="HideTip('tt12')">cellsRemoved</a>.&nbsp; This method fires <a href="#mxGraph.mxEvent.REMOVE_CELLS" class=LEvent id=link1053 onMouseOver="ShowTip(event, 'tt533', 'link1053')" onMouseOut="HideTip('tt533')">mxEvent.REMOVE_CELLS</a> while the transaction is in progress.&nbsp; The removed cells are returned as an array.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1054 onMouseOver="ShowTip(event, 'tt244', 'link1054')" onMouseOut="HideTip('tt244')">mxCells</a> to be resized.</td></tr><tr><td class=CDLEntry>recurse</td><td class=CDLDescription>Optional boolean which specifies if all descendants should be autosized.&nbsp; Default is true.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.removeCells"></a>removeCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.removeCells = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>includeEdges</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes the given cells from the graph including all connected edges if includeEdges is true.&nbsp; The change is carried out using <a href="#mxGraph.cellsRemoved" class=LFunction id=link1055 onMouseOver="ShowTip(event, 'tt12', 'link1055')" onMouseOut="HideTip('tt12')">cellsRemoved</a>.&nbsp; This method fires <a href="#mxGraph.mxEvent.REMOVE_CELLS" class=LEvent id=link1056 onMouseOver="ShowTip(event, 'tt533', 'link1056')" onMouseOut="HideTip('tt533')">mxEvent.REMOVE_CELLS</a> while the transaction is in progress.&nbsp; The removed cells are returned as an array.</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=link1057 onMouseOver="ShowTip(event, 'tt244', 'link1057')" onMouseOut="HideTip('tt244')">mxCells</a> to remove.&nbsp; If null is specified then the selection cells which are deletable are used.</td></tr><tr><td class=CDLEntry>includeEdges</td><td class=CDLDescription>Optional boolean which specifies if all connected edges should be removed as well.&nbsp; Default is true.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsRemoved"></a>cellsRemoved</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cellsRemoved = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes the given cells from the model.&nbsp; This method fires <a href="#mxGraph.mxEvent.CELLS_REMOVED" class=LEvent id=link1058 onMouseOver="ShowTip(event, 'tt534', 'link1058')" onMouseOut="HideTip('tt534')">mxEvent.CELLS_REMOVED</a> while the transaction is in progress.</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=link1059 onMouseOver="ShowTip(event, 'tt244', 'link1059')" onMouseOut="HideTip('tt244')">mxCells</a> to remove.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.splitEdge"></a>splitEdge</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.splitEdge = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>newEdge,</td></tr><tr><td></td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Splits the given edge by adding the newEdge between the previous source and the given cell and reconnecting the source of the given edge to the given cell.&nbsp; This method fires <a href="#mxGraph.mxEvent.SPLIT_EDGE" class=LEvent id=link1060 onMouseOver="ShowTip(event, 'tt535', 'link1060')" onMouseOut="HideTip('tt535')">mxEvent.SPLIT_EDGE</a> while the transaction is in progress.&nbsp; Returns the new edge that was inserted.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1061 onMouseOver="ShowTip(event, 'tt244', 'link1061')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the edge to be splitted.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1062 onMouseOver="ShowTip(event, 'tt244', 'link1062')" onMouseOut="HideTip('tt244')">mxCells</a> that represents the cells to insert into the edge.</td></tr><tr><td class=CDLEntry>newEdge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1063 onMouseOver="ShowTip(event, 'tt244', 'link1063')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the edge to be inserted.</td></tr><tr><td class=CDLEntry>dx</td><td class=CDLDescription>Optional integer that specifies the vector to move the cells.</td></tr><tr><td class=CDLEntry>dy</td><td class=CDLDescription>Optional integer that specifies the vector to move the cells.</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="mxGraph.Cell_visibility"></a>Cell visibility</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.toggleCells"></a>toggleCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.toggleCells = function(</td><td class=PParameter nowrap>show,</td></tr><tr><td></td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>includeEdges</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the visible state of the specified cells and all connected edges if includeEdges is true.&nbsp; The change is carried out using <a href="#mxGraph.cellsToggled" class=LFunction id=link1064 onMouseOver="ShowTip(event, 'tt255', 'link1064')" onMouseOut="HideTip('tt255')">cellsToggled</a>.&nbsp; This method fires <a href="#mxGraph.mxEvent.TOGGLE_CELLS" class=LEvent id=link1065 onMouseOver="ShowTip(event, 'tt536', 'link1065')" onMouseOut="HideTip('tt536')">mxEvent.TOGGLE_CELLS</a> while the transaction is in progress.&nbsp; Returns the cells whose visible state was changed.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>show</td><td class=CDLDescription>Boolean that specifies the visible state to be assigned.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription>Array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1066 onMouseOver="ShowTip(event, 'tt244', 'link1066')" onMouseOut="HideTip('tt244')">mxCells</a> whose visible state should be changed.&nbsp; If null is specified then the selection cells are used.</td></tr><tr><td class=CDLEntry>includeEdges</td><td class=CDLDescription>Optional boolean indicating if the visible state of all connected edges should be changed as well.&nbsp; Default is true.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsToggled"></a>cellsToggled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cellsToggled = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>show</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the visible state of the specified cells.</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=link1067 onMouseOver="ShowTip(event, 'tt244', 'link1067')" onMouseOut="HideTip('tt244')">mxCells</a> whose visible state should be changed.</td></tr><tr><td class=CDLEntry>show</td><td class=CDLDescription>Boolean that specifies the visible state to be assigned.</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="mxGraph.Folding"></a>Folding</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.foldCells"></a>foldCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.foldCells = function(</td><td class=PParameter nowrap>collapse,</td></tr><tr><td></td><td class=PParameter nowrap>recurse,</td></tr><tr><td></td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>checkFoldable,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the collapsed state of the specified cells and all descendants if recurse is true.&nbsp; The change is carried out using <a href="#mxGraph.cellsFolded" class=LFunction id=link1068 onMouseOver="ShowTip(event, 'tt256', 'link1068')" onMouseOut="HideTip('tt256')">cellsFolded</a>.&nbsp; This method fires <a href="#mxGraph.mxEvent.FOLD_CELLS" class=LEvent id=link1069 onMouseOver="ShowTip(event, 'tt537', 'link1069')" onMouseOut="HideTip('tt537')">mxEvent.FOLD_CELLS</a> while the transaction is in progress.&nbsp; Returns the cells whose collapsed state was changed.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>collapsed</td><td class=CDLDescription>Boolean indicating the collapsed state to be assigned.</td></tr><tr><td class=CDLEntry>recurse</td><td class=CDLDescription>Optional boolean indicating if the collapsed state of all descendants should be set.&nbsp; Default is false.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription>Array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1070 onMouseOver="ShowTip(event, 'tt244', 'link1070')" onMouseOut="HideTip('tt244')">mxCells</a> whose collapsed state should be set.&nbsp; If null is specified then the foldable selection cells are used.</td></tr><tr><td class=CDLEntry>checkFoldable</td><td class=CDLDescription>Optional boolean indicating of isCellFoldable should be checked.&nbsp; Default is false.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Optional native event that triggered the invocation.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsFolded"></a>cellsFolded</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cellsFolded = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>collapse,</td></tr><tr><td></td><td class=PParameter nowrap>recurse,</td></tr><tr><td></td><td class=PParameter nowrap>checkFoldable</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the collapsed state of the specified cells.&nbsp; This method fires <a href="#mxGraph.mxEvent.CELLS_FOLDED" class=LEvent id=link1071 onMouseOver="ShowTip(event, 'tt538', 'link1071')" onMouseOut="HideTip('tt538')">mxEvent.CELLS_FOLDED</a> while the transaction is in progress.&nbsp; Returns the cells whose collapsed state was changed.</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=link1072 onMouseOver="ShowTip(event, 'tt244', 'link1072')" onMouseOut="HideTip('tt244')">mxCells</a> whose collapsed state should be set.</td></tr><tr><td class=CDLEntry>collapsed</td><td class=CDLDescription>Boolean indicating the collapsed state to be assigned.</td></tr><tr><td class=CDLEntry>recurse</td><td class=CDLDescription>Boolean indicating if the collapsed state of all descendants should be set.</td></tr><tr><td class=CDLEntry>checkFoldable</td><td class=CDLDescription>Optional boolean indicating of isCellFoldable should be checked.&nbsp; Default is false.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.swapBounds"></a>swapBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.swapBounds = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>willCollapse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Swaps the alternate and the actual bounds in the geometry of the given cell invoking <a href="#mxGraph.updateAlternateBounds" class=LFunction id=link1073 onMouseOver="ShowTip(event, 'tt258', 'link1073')" onMouseOut="HideTip('tt258')">updateAlternateBounds</a> before carrying out the swap.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1074 onMouseOver="ShowTip(event, 'tt244', 'link1074')" onMouseOut="HideTip('tt244')">mxCell</a> for which the bounds should be swapped.</td></tr><tr><td class=CDLEntry>willCollapse</td><td class=CDLDescription>Boolean indicating if the cell is going to be collapsed.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.updateAlternateBounds"></a>updateAlternateBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.updateAlternateBounds = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>geo,</td></tr><tr><td></td><td class=PParameter nowrap>willCollapse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates or sets the alternate bounds in the given geometry for the given cell depending on whether the cell is going to be collapsed.&nbsp; If no alternate bounds are defined in the geometry and <a href="#mxGraph.collapseToPreferredSize" class=LVariable id=link1075 onMouseOver="ShowTip(event, 'tt148', 'link1075')" onMouseOut="HideTip('tt148')">collapseToPreferredSize</a> is true, then the preferred size is used for the alternate bounds.&nbsp; The top, left corner is always kept at the same location.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1076 onMouseOver="ShowTip(event, 'tt244', 'link1076')" onMouseOut="HideTip('tt244')">mxCell</a> for which the geometry is being udpated.</td></tr><tr><td class=CDLEntry>g</td><td class=CDLDescription><a href="../model/mxGeometry-js.html#mxGeometry" class=LClass id=link1077 onMouseOver="ShowTip(event, 'tt248', 'link1077')" onMouseOut="HideTip('tt248')">mxGeometry</a> for which the alternate bounds should be updated.</td></tr><tr><td class=CDLEntry>willCollapse</td><td class=CDLDescription>Boolean indicating if the cell is going to be collapsed.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.addAllEdges"></a>addAllEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.addAllEdges = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns an array with the given cells and all edges that are connected to a cell or one of its descendants.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getAllEdges"></a>getAllEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getAllEdges = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns all edges connected to the given cells or its descendants.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraph.Cell_sizing"></a>Cell sizing</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.updateCellSize"></a>updateCellSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.updateCellSize = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>ignoreChildren</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the size of the given cell in the model using <a href="#mxGraph.cellSizeUpdated" class=LFunction id=link1078 onMouseOver="ShowTip(event, 'tt261', 'link1078')" onMouseOut="HideTip('tt261')">cellSizeUpdated</a>.&nbsp; This method fires <a href="#mxGraph.mxEvent.UPDATE_CELL_SIZE" class=LEvent id=link1079 onMouseOver="ShowTip(event, 'tt539', 'link1079')" onMouseOut="HideTip('tt539')">mxEvent.UPDATE_CELL_SIZE</a> while the transaction is in progress.&nbsp; Returns the cell whose size was updated.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1080 onMouseOver="ShowTip(event, 'tt244', 'link1080')" onMouseOut="HideTip('tt244')">mxCell</a> whose size should be updated.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellSizeUpdated"></a>cellSizeUpdated</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cellSizeUpdated = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>ignoreChildren</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the size of the given cell in the model using <a href="#mxGraph.getPreferredSizeForCell" class=LFunction id=link1081 onMouseOver="ShowTip(event, 'tt262', 'link1081')" onMouseOut="HideTip('tt262')">getPreferredSizeForCell</a> to get the new size.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1082 onMouseOver="ShowTip(event, 'tt244', 'link1082')" onMouseOut="HideTip('tt244')">mxCell</a> for which the size should be changed.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getPreferredSizeForCell"></a>getPreferredSizeForCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getPreferredSizeForCell = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the preferred width and height of the given <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1083 onMouseOver="ShowTip(event, 'tt244', 'link1083')" onMouseOut="HideTip('tt244')">mxCell</a> as an <a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link1084 onMouseOver="ShowTip(event, 'tt133', 'link1084')" onMouseOut="HideTip('tt133')">mxRectangle</a>.&nbsp; To implement a minimum width, add a new style eg. minWidth in the vertex and override this method as follows.</p><blockquote><pre class="prettyprint">var graphGetPreferredSizeForCell = graph.getPreferredSizeForCell;
2013-08-09 09:08:09 +00:00
graph.getPreferredSizeForCell = function(cell)
{
var result = graphGetPreferredSizeForCell.apply(this, arguments);
var style = this.getCellStyle(cell);
if (style['minWidth'] &gt; 0)
{
result.width = Math.max(style['minWidth'], result.width);
}
return result;
2015-04-23 20:18:31 +00:00
};</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1085 onMouseOver="ShowTip(event, 'tt244', 'link1085')" onMouseOut="HideTip('tt244')">mxCell</a> for which the preferred size should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.resizeCell"></a>resizeCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.resizeCell = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>recurse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the bounds of the given cell using <a href="#mxGraph.resizeCells" class=LFunction id=link1086 onMouseOver="ShowTip(event, 'tt17', 'link1086')" onMouseOut="HideTip('tt17')">resizeCells</a>.&nbsp; Returns the cell which was passed to the function.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1087 onMouseOver="ShowTip(event, 'tt244', 'link1087')" onMouseOut="HideTip('tt244')">mxCell</a> whose bounds should be changed.</td></tr><tr><td class=CDLEntry>bounds</td><td class=CDLDescription><a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link1088 onMouseOver="ShowTip(event, 'tt133', 'link1088')" onMouseOut="HideTip('tt133')">mxRectangle</a> that represents the new bounds.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.resizeCells"></a>resizeCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.resizeCells = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>recurse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the bounds of the given cells and fires a <a href="#mxGraph.mxEvent.RESIZE_CELLS" class=LEvent id=link1089 onMouseOver="ShowTip(event, 'tt264', 'link1089')" onMouseOut="HideTip('tt264')">mxEvent.RESIZE_CELLS</a> event while the transaction is in progress.&nbsp; Returns the cells which have been passed to the function.</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=link1090 onMouseOver="ShowTip(event, 'tt244', 'link1090')" onMouseOut="HideTip('tt244')">mxCells</a> whose bounds should be changed.</td></tr><tr><td class=CDLEntry>bounds</td><td class=CDLDescription>Array of <a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link1091 onMouseOver="ShowTip(event, 'tt133', 'link1091')" onMouseOut="HideTip('tt133')">mxRectangles</a> that represent the new bounds.</td></tr></table></div></div></div>
2013-05-23 16:14:48 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsResized"></a>cellsResized</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cellsResized = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>recurse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the bounds of the given cells and fires a <a href="#mxGraph.mxEvent.CELLS_RESIZED" class=LEvent id=link1092 onMouseOver="ShowTip(event, 'tt265', 'link1092')" onMouseOut="HideTip('tt265')">mxEvent.CELLS_RESIZED</a> event.&nbsp; If <a href="#mxGraph.extendParents" class=LVariable id=link1093 onMouseOver="ShowTip(event, 'tt144', 'link1093')" onMouseOut="HideTip('tt144')">extendParents</a> is true, then the parent is extended if a child size is changed so that it overlaps with the parent.</p><p>The following example shows how to control group resizes to make sure that all child cells stay within the group.</p><blockquote><pre class="prettyprint">graph.addListener(mxEvent.CELLS_RESIZED, function(sender, evt)
2013-05-23 16:14:48 +00:00
{
var cells = evt.getProperty('cells');
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
if (cells != null)
{
for (var i = 0; i &lt; cells.length; i++)
{
if (graph.getModel().getChildCount(cells[i]) &gt; 0)
{
var geo = graph.getCellGeometry(cells[i]);
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
if (geo != null)
{
var children = graph.getChildCells(cells[i], true, true);
var bounds = graph.getBoundingBoxFromGeometry(children, true);
geo = geo.clone();
geo.width = Math.max(geo.width, bounds.width);
geo.height = Math.max(geo.height, bounds.height);
graph.getModel().setGeometry(cells[i], geo);
}
}
}
}
2015-04-23 20:18:31 +00:00
});</pre></blockquote><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=link1094 onMouseOver="ShowTip(event, 'tt244', 'link1094')" onMouseOut="HideTip('tt244')">mxCells</a> whose bounds should be changed.</td></tr><tr><td class=CDLEntry>bounds</td><td class=CDLDescription>Array of <a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link1095 onMouseOver="ShowTip(event, 'tt133', 'link1095')" onMouseOut="HideTip('tt133')">mxRectangles</a> that represent the new bounds.</td></tr><tr><td class=CDLEntry>recurse</td><td class=CDLDescription>Optional boolean that specifies if the children should be resized.</td></tr></table></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellResized"></a>cellResized</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cellResized = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>ignoreRelative,</td></tr><tr><td></td><td class=PParameter nowrap>recurse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Resizes the parents recursively so that they contain the complete area of the resized child cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1096 onMouseOver="ShowTip(event, 'tt244', 'link1096')" onMouseOut="HideTip('tt244')">mxCell</a> whose bounds should be changed.</td></tr><tr><td class=CDLEntry>bounds</td><td class=CDLDescription><a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link1097 onMouseOver="ShowTip(event, 'tt133', 'link1097')" onMouseOut="HideTip('tt133')">mxRectangles</a> that represent the new bounds.</td></tr><tr><td class=CDLEntry>ignoreRelative</td><td class=CDLDescription>Boolean that indicates if relative cells should be ignored.</td></tr><tr><td class=CDLEntry>recurse</td><td class=CDLDescription>Optional boolean that specifies if the children should be resized.</td></tr></table></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.resizeChildCells"></a>resizeChildCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.resizeChildCells = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>newGeo</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Resizes the child cells of the given cell for the given new geometry with respect to the current geometry of the cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1098 onMouseOver="ShowTip(event, 'tt244', 'link1098')" onMouseOut="HideTip('tt244')">mxCell</a> that has been resized.</td></tr><tr><td class=CDLEntry>newGeo</td><td class=CDLDescription><a href="../model/mxGeometry-js.html#mxGeometry" class=LClass id=link1099 onMouseOver="ShowTip(event, 'tt248', 'link1099')" onMouseOut="HideTip('tt248')">mxGeometry</a> that represents the new bounds.</td></tr></table></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.constrainChildCells"></a>constrainChildCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.constrainChildCells = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constrains the children of the given cell using <a href="#mxGraph.constrainChild" class=LFunction id=link1100 onMouseOver="ShowTip(event, 'tt269', 'link1100')" onMouseOut="HideTip('tt269')">constrainChild</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1101 onMouseOver="ShowTip(event, 'tt244', 'link1101')" onMouseOut="HideTip('tt244')">mxCell</a> that has been resized.</td></tr></table></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.scaleCell"></a>scaleCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.scaleCell = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy,</td></tr><tr><td></td><td class=PParameter nowrap>recurse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Scales the points, position and size of the given cell according to the given vertical and horizontal scaling factors.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1102 onMouseOver="ShowTip(event, 'tt244', 'link1102')" onMouseOut="HideTip('tt244')">mxCell</a> whose geometry should be scaled.</td></tr><tr><td class=CDLEntry>dx</td><td class=CDLDescription>Horizontal scaling factor.</td></tr><tr><td class=CDLEntry>dy</td><td class=CDLDescription>Vertical scaling factor.</td></tr><tr><td class=CDLEntry>recurse</td><td class=CDLDescription>Boolean indicating if the child cells should be scaled.</td></tr></table></div></div></div>
2013-05-23 16:14:48 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.extendParent"></a>extendParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.extendParent = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Resizes the parents recursively so that they contain the complete area of the resized child cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1103 onMouseOver="ShowTip(event, 'tt244', 'link1103')" onMouseOut="HideTip('tt244')">mxCell</a> that has been resized.</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="mxGraph.Cell_moving"></a>Cell moving</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.importCells"></a>importCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.importCells = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy,</td></tr><tr><td></td><td class=PParameter nowrap>target,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Clones and inserts the given cells into the graph using the move method and returns the inserted cells.&nbsp; This shortcut is used if cells are inserted via datatransfer.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.moveCells"></a>moveCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.moveCells = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy,</td></tr><tr><td></td><td class=PParameter nowrap>clone,</td></tr><tr><td></td><td class=PParameter nowrap>target,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Moves or clones the specified cells and moves the cells or clones by the given amount, adding them to the optional target cell.&nbsp; The evt is the mouse event as the mouse was released.&nbsp; The change is carried out using <a href="#mxGraph.cellsMoved" class=LFunction id=link1104 onMouseOver="ShowTip(event, 'tt20', 'link1104')" onMouseOut="HideTip('tt20')">cellsMoved</a>.&nbsp; This method fires <a href="#mxGraph.mxEvent.MOVE_CELLS" class=LEvent id=link1105 onMouseOver="ShowTip(event, 'tt540', 'link1105')" onMouseOut="HideTip('tt540')">mxEvent.MOVE_CELLS</a> while the transaction is in progress.&nbsp; Returns the cells that were moved.</p><p>Use the following code to move all cells in the graph.</p><blockquote><pre class="prettyprint">graph.moveCells(graph.getChildCells(null, true, true), 10, 10);</pre></blockquote><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=link1106 onMouseOver="ShowTip(event, 'tt244', 'link1106')" onMouseOut="HideTip('tt244')">mxCells</a> to be moved, cloned or added to the target.</td></tr><tr><td class=CDLEntry>dx</td><td class=CDLDescription>Integer that specifies the x-coordinate of the vector.&nbsp; Default is 0.</td></tr><tr><td class=CDLEntry>dy</td><td class=CDLDescription>Integer that specifies the y-coordinate of the vector.&nbsp; Default is 0.</td></tr><tr><td class=CDLEntry>clone</td><td class=CDLDescription>Boolean indicating if the cells should be cloned.&nbsp; Default is false.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1107 onMouseOver="ShowTip(event, 'tt244', 'link1107')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the new parent of the cells.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mouseevent that triggered the invocation.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellsMoved"></a>cellsMoved</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cellsMoved = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy,</td></tr><tr><td></td><td class=PParameter nowrap>disconnect,</td></tr><tr><td></td><td class=PParameter nowrap>constrain,</td></tr><tr><td></td><td class=PParameter nowrap>extend</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Moves the specified cells by the given vector, disconnecting the cells using disconnectGraph is disconnect is true.&nbsp; This method fires <a href="#mxGraph.mxEvent.CELLS_MOVED" class=LEvent id=link1108 onMouseOver="ShowTip(event, 'tt541', 'link1108')" onMouseOut="HideTip('tt541')">mxEvent.CELLS_MOVED</a> while the transaction is in progress.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.translateCell"></a>translateCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.translateCell = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Translates the geometry of the given cell and stores the new, translated geometry in the model as an atomic change.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCellContainmentArea"></a>getCellContainmentArea</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCellContainmentArea = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the <a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link1109 onMouseOver="ShowTip(event, 'tt133', 'link1109')" onMouseOut="HideTip('tt133')">mxRectangle</a> inside which a cell is to be kept.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1110 onMouseOver="ShowTip(event, 'tt244', 'link1110')" onMouseOut="HideTip('tt244')">mxCell</a> for which the area should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getMaximumGraphBounds"></a>getMaximumGraphBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getMaximumGraphBounds = function()</td></tr></table></blockquote><p>Returns the bounds inside which the diagram should be kept as an <a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link1111 onMouseOver="ShowTip(event, 'tt133', 'link1111')" onMouseOut="HideTip('tt133')">mxRectangle</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.constrainChild"></a>constrainChild</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.constrainChild = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Keeps the given cell inside the bounds returned by <a href="#mxGraph.getCellContainmentArea" class=LFunction id=link1112 onMouseOver="ShowTip(event, 'tt274', 'link1112')" onMouseOut="HideTip('tt274')">getCellContainmentArea</a> for its parent, according to the rules defined by <a href="#mxGraph.getOverlap" class=LFunction id=link1113 onMouseOver="ShowTip(event, 'tt72', 'link1113')" onMouseOut="HideTip('tt72')">getOverlap</a> and <a href="#mxGraph.isConstrainChild" class=LFunction id=link1114 onMouseOver="ShowTip(event, 'tt276', 'link1114')" onMouseOut="HideTip('tt276')">isConstrainChild</a>.&nbsp; This modifies the cell&rsquo;s geometry in-place and does not clone it.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cells</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1115 onMouseOver="ShowTip(event, 'tt244', 'link1115')" onMouseOut="HideTip('tt244')">mxCell</a> which should be constrained.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.resetEdges"></a>resetEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.resetEdges = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Resets the control points of the edges that are connected to the given cells if not both ends of the edge are in the given cells array.</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=link1116 onMouseOver="ShowTip(event, 'tt244', 'link1116')" onMouseOut="HideTip('tt244')">mxCells</a> for which the connected edges should be reset.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.resetEdge"></a>resetEdge</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.resetEdge = function(</td><td class=PParameter nowrap>edge</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Resets the control points of the given edge.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1117 onMouseOver="ShowTip(event, 'tt244', 'link1117')" onMouseOut="HideTip('tt244')">mxCell</a> whose points should be reset.</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="mxGraph.Cell_connecting_and_connection_constraints"></a>Cell connecting and connection constraints</h3></div></div>
2014-07-25 06:48:01 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getOutlineConstraint"></a>getOutlineConstraint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getOutlineConstraint = function(</td><td class=PParameter nowrap>point,</td></tr><tr><td></td><td class=PParameter nowrap>terminalState,</td></tr><tr><td></td><td class=PParameter nowrap>me</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the constraint used to connect to the outline of the given state.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getAllConnectionConstraints"></a>getAllConnectionConstraints</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getAllConnectionConstraints = function(</td><td class=PParameter nowrap>terminal,</td></tr><tr><td></td><td class=PParameter nowrap>source</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns an array of all <a href="mxConnectionConstraint-js.html#mxConnectionConstraint" class=LClass id=link1118 onMouseOver="ShowTip(event, 'tt281', 'link1118')" onMouseOut="HideTip('tt281')">mxConnectionConstraints</a> for the given terminal.&nbsp; If the shape of the given terminal is a &lt;mxStencilShape&gt; then the constraints of the corresponding <a href="../shape/mxStencil-js.html#mxStencil" class=LClass id=link1119 onMouseOver="ShowTip(event, 'tt542', 'link1119')" onMouseOut="HideTip('tt542')">mxStencil</a> are returned.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>terminal</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1120 onMouseOver="ShowTip(event, 'tt44', 'link1120')" onMouseOut="HideTip('tt44')">mxCellState</a> that represents the terminal.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean that specifies if the terminal is the source or target.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getConnectionConstraint"></a>getConnectionConstraint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getConnectionConstraint = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>terminal,</td></tr><tr><td></td><td class=PParameter nowrap>source</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns an <a href="mxConnectionConstraint-js.html#mxConnectionConstraint" class=LClass id=link1121 onMouseOver="ShowTip(event, 'tt281', 'link1121')" onMouseOut="HideTip('tt281')">mxConnectionConstraint</a> that describes the given connection point.&nbsp; This result can then be passed to <a href="#mxGraph.getConnectionPoint" class=LFunction id=link1122 onMouseOver="ShowTip(event, 'tt284', 'link1122')" onMouseOut="HideTip('tt284')">getConnectionPoint</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1123 onMouseOver="ShowTip(event, 'tt44', 'link1123')" onMouseOut="HideTip('tt44')">mxCellState</a> that represents the edge.</td></tr><tr><td class=CDLEntry>terminal</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1124 onMouseOver="ShowTip(event, 'tt44', 'link1124')" onMouseOut="HideTip('tt44')">mxCellState</a> that represents the terminal.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean indicating if the terminal is the source or target.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setConnectionConstraint"></a>setConnectionConstraint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setConnectionConstraint = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>terminal,</td></tr><tr><td></td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>constraint</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the <a href="mxConnectionConstraint-js.html#mxConnectionConstraint" class=LClass id=link1125 onMouseOver="ShowTip(event, 'tt281', 'link1125')" onMouseOut="HideTip('tt281')">mxConnectionConstraint</a> that describes the given connection point.&nbsp; If no constraint is given then nothing is changed.&nbsp; To remove an existing constraint from the given edge, use an empty constraint instead.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1126 onMouseOver="ShowTip(event, 'tt244', 'link1126')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the edge.</td></tr><tr><td class=CDLEntry>terminal</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1127 onMouseOver="ShowTip(event, 'tt244', 'link1127')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the terminal.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean indicating if the terminal is the source or target.</td></tr><tr><td class=CDLEntry>constraint</td><td class=CDLDescription>Optional <a href="mxConnectionConstraint-js.html#mxConnectionConstraint" class=LClass id=link1128 onMouseOver="ShowTip(event, 'tt281', 'link1128')" onMouseOut="HideTip('tt281')">mxConnectionConstraint</a> to be used for this connection.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getConnectionPoint"></a>getConnectionPoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getConnectionPoint = function(</td><td class=PParameter nowrap>vertex,</td></tr><tr><td></td><td class=PParameter nowrap>constraint</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the nearest point in the list of absolute points or the center of the opposite terminal.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>vertex</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1129 onMouseOver="ShowTip(event, 'tt44', 'link1129')" onMouseOut="HideTip('tt44')">mxCellState</a> that represents the vertex.</td></tr><tr><td class=CDLEntry>constraint</td><td class=CDLDescription><a href="mxConnectionConstraint-js.html#mxConnectionConstraint" class=LClass id=link1130 onMouseOver="ShowTip(event, 'tt281', 'link1130')" onMouseOut="HideTip('tt281')">mxConnectionConstraint</a> that represents the connection point constraint as returned by <a href="#mxGraph.getConnectionConstraint" class=LFunction id=link1131 onMouseOver="ShowTip(event, 'tt282', 'link1131')" onMouseOut="HideTip('tt282')">getConnectionConstraint</a>.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.connectCell"></a>connectCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.connectCell = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>terminal,</td></tr><tr><td></td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>constraint</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Connects the specified end of the given edge to the given terminal using <a href="#mxGraph.cellConnected" class=LFunction id=link1132 onMouseOver="ShowTip(event, 'tt22', 'link1132')" onMouseOut="HideTip('tt22')">cellConnected</a> and fires <a href="#mxGraph.mxEvent.CONNECT_CELL" class=LEvent id=link1133 onMouseOver="ShowTip(event, 'tt285', 'link1133')" onMouseOut="HideTip('tt285')">mxEvent.CONNECT_CELL</a> while the transaction is in progress.&nbsp; Returns the updated edge.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1134 onMouseOver="ShowTip(event, 'tt244', 'link1134')" onMouseOut="HideTip('tt244')">mxCell</a> whose terminal should be updated.</td></tr><tr><td class=CDLEntry>terminal</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1135 onMouseOver="ShowTip(event, 'tt244', 'link1135')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the new terminal to be used.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean indicating if the new terminal is the source or target.</td></tr><tr><td class=CDLEntry>constraint</td><td class=CDLDescription>Optional <a href="mxConnectionConstraint-js.html#mxConnectionConstraint" class=LClass id=link1136 onMouseOver="ShowTip(event, 'tt281', 'link1136')" onMouseOut="HideTip('tt281')">mxConnectionConstraint</a> to be used for this connection.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.cellConnected"></a>cellConnected</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cellConnected = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>terminal,</td></tr><tr><td></td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>constraint</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the new terminal for the given edge and resets the edge points if <a href="#mxGraph.resetEdgesOnConnect" class=LVariable id=link1137 onMouseOver="ShowTip(event, 'tt157', 'link1137')" onMouseOut="HideTip('tt157')">resetEdgesOnConnect</a> is true.&nbsp; This method fires <a href="#mxGraph.mxEvent.CELL_CONNECTED" class=LEvent id=link1138 onMouseOver="ShowTip(event, 'tt543', 'link1138')" onMouseOut="HideTip('tt543')">mxEvent.CELL_CONNECTED</a> while the transaction is in progress.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1139 onMouseOver="ShowTip(event, 'tt244', 'link1139')" onMouseOut="HideTip('tt244')">mxCell</a> whose terminal should be updated.</td></tr><tr><td class=CDLEntry>terminal</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1140 onMouseOver="ShowTip(event, 'tt244', 'link1140')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the new terminal to be used.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean indicating if the new terminal is the source or target.</td></tr><tr><td class=CDLEntry>constraint</td><td class=CDLDescription><a href="mxConnectionConstraint-js.html#mxConnectionConstraint" class=LClass id=link1141 onMouseOver="ShowTip(event, 'tt281', 'link1141')" onMouseOut="HideTip('tt281')">mxConnectionConstraint</a> to be used for this connection.</td></tr></table></div></div></div>
2014-07-25 06:48:01 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.disconnectGraph"></a>disconnectGraph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.disconnectGraph = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Disconnects the given edges from the terminals which are not in the given array.</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=link1142 onMouseOver="ShowTip(event, 'tt244', 'link1142')" onMouseOut="HideTip('tt244')">mxCells</a> to be disconnected.</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="mxGraph.Drilldown"></a>Drilldown</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCurrentRoot"></a>getCurrentRoot</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getCurrentRoot = function()</td></tr></table></blockquote><p>Returns the current root of the displayed cell hierarchy.&nbsp; This is a shortcut to <a href="mxGraphView-js.html#mxGraphView.currentRoot" class=LVariable id=link1143 onMouseOver="ShowTip(event, 'tt440', 'link1143')" onMouseOut="HideTip('tt440')">mxGraphView.currentRoot</a> in <a href="#mxGraph.view" class=LVariable id=link1144 onMouseOver="ShowTip(event, 'tt42', 'link1144')" onMouseOut="HideTip('tt42')">view</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getTranslateForRoot"></a>getTranslateForRoot</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getTranslateForRoot = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the translation to be used if the given cell is the root cell as an <a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link1145 onMouseOver="ShowTip(event, 'tt289', 'link1145')" onMouseOut="HideTip('tt289')">mxPoint</a>.&nbsp; This implementation returns null.</p><h4 class=CHeading>Example</h4><p>To keep the children at their absolute position while stepping into groups, this function can be overridden as follows.</p><blockquote><pre class="prettyprint">var offset = new mxPoint(0, 0);
2012-05-21 20:32:26 +00:00
while (cell != null)
{
var geo = this.model.getGeometry(cell);
if (geo != null)
{
offset.x -= geo.x;
offset.y -= geo.y;
}
cell = this.model.getParent(cell);
}
2015-04-23 20:18:31 +00:00
return offset;</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1146 onMouseOver="ShowTip(event, 'tt244', 'link1146')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the root.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isPort"></a>isPort</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isPort = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is a &ldquo;port&rdquo;, that is, when connecting to it, the cell returned by getTerminalForPort should be used as the terminal and the port should be referenced by the ID in either the mxConstants.STYLE_SOURCE_PORT or the or the mxConstants.STYLE_TARGET_PORT.&nbsp; Note that a port should not be movable.&nbsp; This implementation always returns false.</p><h4 class=CHeading>A typical implementation is the following</h4><blockquote><pre class="prettyprint">graph.isPort = function(cell)
{
var geo = this.getCellGeometry(cell);
return (geo != null) ? geo.relative : false;
2015-04-23 20:18:31 +00:00
};</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1147 onMouseOver="ShowTip(event, 'tt244', 'link1147')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the port.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getTerminalForPort"></a>getTerminalForPort</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getTerminalForPort = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>source</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the terminal to be used for a given port.&nbsp; This implementation always returns the parent cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1148 onMouseOver="ShowTip(event, 'tt244', 'link1148')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the port.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>If the cell is the source or target port.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getChildOffsetForCell"></a>getChildOffsetForCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getChildOffsetForCell = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the offset to be used for the cells inside the given cell.&nbsp; The root and layer cells may be identified using <a href="../model/mxGraphModel-js.html#mxGraphModel.isRoot" class=LFunction id=link1149 onMouseOver="ShowTip(event, 'tt544', 'link1149')" onMouseOut="HideTip('tt544')">mxGraphModel.isRoot</a> and <a href="../model/mxGraphModel-js.html#mxGraphModel.isLayer" class=LFunction id=link1150 onMouseOver="ShowTip(event, 'tt545', 'link1150')" onMouseOut="HideTip('tt545')">mxGraphModel.isLayer</a>.&nbsp; For all other current roots, the <a href="mxGraphView-js.html#mxGraphView.currentRoot" class=LVariable id=link1151 onMouseOver="ShowTip(event, 'tt440', 'link1151')" onMouseOut="HideTip('tt440')">mxGraphView.currentRoot</a> field points to the respective cell, so that the following holds: cell == this.view.currentRoot.&nbsp; This implementation returns null.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1152 onMouseOver="ShowTip(event, 'tt244', 'link1152')" onMouseOut="HideTip('tt244')">mxCell</a> whose offset should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.enterGroup"></a>enterGroup</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.enterGroup = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Uses the given cell as the root of the displayed cell hierarchy.&nbsp; If no cell is specified then the selection cell is used.&nbsp; The cell is only used if <a href="#mxGraph.isValidRoot" class=LFunction id=link1153 onMouseOver="ShowTip(event, 'tt296', 'link1153')" onMouseOut="HideTip('tt296')">isValidRoot</a> returns true.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1154 onMouseOver="ShowTip(event, 'tt244', 'link1154')" onMouseOut="HideTip('tt244')">mxCell</a> to be used as the new root.&nbsp; Default is the selection cell.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.exitGroup"></a>exitGroup</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.exitGroup = function()</td></tr></table></blockquote><p>Changes the current root to the next valid root in the displayed cell hierarchy.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.home"></a>home</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.home = function()</td></tr></table></blockquote><p>Uses the root of the model as the root of the displayed cell hierarchy and selects the previous root.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isValidRoot"></a>isValidRoot</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isValidRoot = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is a valid root for the cell display hierarchy.&nbsp; This implementation returns true for all non-null values.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1155 onMouseOver="ShowTip(event, 'tt244', 'link1155')" onMouseOut="HideTip('tt244')">mxCell</a> which should be checked as a possible root.</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="mxGraph.Graph_display"></a>Graph display</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getGraphBounds"></a>getGraphBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getGraphBounds = function()</td></tr></table></blockquote><p>Returns the bounds of the visible graph.&nbsp; Shortcut to <a href="mxGraphView-js.html#mxGraphView.getGraphBounds" class=LFunction id=link1156 onMouseOver="ShowTip(event, 'tt546', 'link1156')" onMouseOut="HideTip('tt546')">mxGraphView.getGraphBounds</a>.&nbsp; See also: <a href="#mxGraph.getBoundingBoxFromGeometry" class=LFunction id=link1157 onMouseOver="ShowTip(event, 'tt299', 'link1157')" onMouseOut="HideTip('tt299')">getBoundingBoxFromGeometry</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCellBounds"></a>getCellBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCellBounds = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>includeEdges,</td></tr><tr><td></td><td class=PParameter nowrap>includeDescendants</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the scaled, translated bounds for the given cell.&nbsp; See <a href="mxGraphView-js.html#mxGraphView.getBounds" class=LFunction id=link1158 onMouseOver="ShowTip(event, 'tt547', 'link1158')" onMouseOut="HideTip('tt547')">mxGraphView.getBounds</a> for arrays.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1159 onMouseOver="ShowTip(event, 'tt244', 'link1159')" onMouseOut="HideTip('tt244')">mxCell</a> whose bounds should be returned.</td></tr><tr><td class=CDLEntry>includeEdge</td><td class=CDLDescription>Optional boolean that specifies if the bounds of the connected edges should be included.&nbsp; Default is false.</td></tr><tr><td class=CDLEntry>includeDescendants</td><td class=CDLDescription>Optional boolean that specifies if the bounds of all descendants should be included.&nbsp; Default is false.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getBoundingBoxFromGeometry"></a>getBoundingBoxFromGeometry</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getBoundingBoxFromGeometry = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>includeEdges</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bounding box for the geometries of the vertices in the given array of cells.&nbsp; This can be used to find the graph bounds during a layout operation (ie. before the last endUpdate) as follows:</p><blockquote><pre class="prettyprint">var cells = graph.getChildCells(graph.getDefaultParent(), true, true);
var bounds = graph.getBoundingBoxFromGeometry(cells, true);</pre></blockquote><h4 class=CHeading>This can then be used to move cells to the origin</h4><blockquote><pre class="prettyprint">if (bounds.x &lt; 0 || bounds.y &lt; 0)
{
graph.moveCells(cells, -Math.min(bounds.x, 0), -Math.min(bounds.y, 0))
}</pre></blockquote><h4 class=CHeading>Or to translate the graph view</h4><blockquote><pre class="prettyprint">if (bounds.x &lt; 0 || bounds.y &lt; 0)
{
graph.view.setTranslate(-Math.min(bounds.x, 0), -Math.min(bounds.y, 0));
2015-04-23 20:18:31 +00:00
}</pre></blockquote><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=link1160 onMouseOver="ShowTip(event, 'tt244', 'link1160')" onMouseOut="HideTip('tt244')">mxCells</a> whose bounds should be returned.</td></tr><tr><td class=CDLEntry>includeEdges</td><td class=CDLDescription>Specifies if edge bounds should be included by computing the bounding box for all points in geometry.&nbsp; Default is false.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.refresh"></a>refresh</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.refresh = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Clears all cell states or the states for the hierarchy starting at the given cell and validates the graph.&nbsp; This fires a refresh event as the last step.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1161 onMouseOver="ShowTip(event, 'tt244', 'link1161')" onMouseOut="HideTip('tt244')">mxCell</a> for which the cell states should be cleared.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.snap"></a>snap</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.snap = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Snaps the given numeric value to the grid if <a href="#mxGraph.gridEnabled" class=LVariable id=link1162 onMouseOver="ShowTip(event, 'tt58', 'link1162')" onMouseOut="HideTip('tt58')">gridEnabled</a> is true.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>Numeric value to be snapped to the grid.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.panGraph"></a>panGraph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.panGraph = function(</td><td class=PParameter nowrap>dx,</td></tr><tr><td></td><td class=PParameter nowrap>dy</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Shifts the graph display by the given amount.&nbsp; This is used to preview panning operations, use <a href="mxGraphView-js.html#mxGraphView.setTranslate" class=LFunction id=link1163 onMouseOver="ShowTip(event, 'tt548', 'link1163')" onMouseOut="HideTip('tt548')">mxGraphView.setTranslate</a> to set a persistent translation of the view.&nbsp; Fires <a href="../util/mxEvent-js.html#mxEvent.PAN" class=LVariable id=link1164 onMouseOver="ShowTip(event, 'tt549', 'link1164')" onMouseOut="HideTip('tt549')">mxEvent.PAN</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>dx</td><td class=CDLDescription>Amount to shift the graph along the x-axis.</td></tr><tr><td class=CDLEntry>dy</td><td class=CDLDescription>Amount to shift the graph along the y-axis.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.zoomIn"></a>zoomIn</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.zoomIn = function()</td></tr></table></blockquote><p>Zooms into the graph by <a href="#mxGraph.zoomFactor" class=LVariable id=link1165 onMouseOver="ShowTip(event, 'tt149', 'link1165')" onMouseOut="HideTip('tt149')">zoomFactor</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.zoomOut"></a>zoomOut</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.zoomOut = function()</td></tr></table></blockquote><p>Zooms out of the graph by <a href="#mxGraph.zoomFactor" class=LVariable id=link1166 onMouseOver="ShowTip(event, 'tt149', 'link1166')" onMouseOut="HideTip('tt149')">zoomFactor</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.zoomActual"></a>zoomActual</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.zoomActual = function()</td></tr></table></blockquote><p>Resets the zoom and panning in the view.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.zoomTo"></a>zoomTo</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.zoomTo = function(</td><td class=PParameter nowrap>scale,</td></tr><tr><td></td><td class=PParameter nowrap>center</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Zooms the graph to the given scale with an optional boolean center argument, which is passd to <a href="#mxGraph.zoom" class=LFunction id=link1167 onMouseOver="ShowTip(event, 'tt303', 'link1167')" onMouseOut="HideTip('tt303')">zoom</a>.</p></div></div></div>
2014-07-25 06:48:01 +00:00
2015-01-05 14:01:01 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.center"></a>center</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.center = function(</td><td class=PParameter nowrap>horizontal,</td></tr><tr><td></td><td class=PParameter nowrap>vertical</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Centers the graph in the container.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>horizontal</td><td class=CDLDescription>Optional boolean that specifies if the graph should be centered horizontally.&nbsp; Default is true.</td></tr><tr><td class=CDLEntry>vertical</td><td class=CDLDescription>Optional boolean that specifies if the graph should be centered vertically.&nbsp; Default is true.</td></tr></table></div></div></div>
2012-05-30 16:26:17 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.zoom"></a>zoom</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.zoom = function(</td><td class=PParameter nowrap>factor,</td></tr><tr><td></td><td class=PParameter nowrap>center</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Zooms the graph using the given factor.&nbsp; Center is an optional boolean argument that keeps the graph scrolled to the center.&nbsp; If the center argument is omitted, then <a href="#mxGraph.centerZoom" class=LVariable id=link1168 onMouseOver="ShowTip(event, 'tt153', 'link1168')" onMouseOut="HideTip('tt153')">centerZoom</a> will be used as its value.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2012-10-29 20:17:12 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.zoomToRect"></a>zoomToRect</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.zoomToRect = function(</td><td class=PParameter nowrap>rect</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Zooms the graph to the specified rectangle.&nbsp; If the rectangle does not have same aspect ratio as the display container, it is increased in the smaller relative dimension only until the aspect match.&nbsp; The original rectangle is centralised within this expanded one.</p><p>Note that the input rectangular must be un-scaled and un-translated.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>rect</td><td class=CDLDescription>The un-scaled and un-translated rectangluar region that should be just visible after the operation</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.fit"></a>fit</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.fit = function(</td><td class=PParameter nowrap>border,</td></tr><tr><td></td><td class=PParameter nowrap>keepOrigin</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Scales the graph such that the complete diagram fits into &lt;container&gt; and returns the current scale in the view.&nbsp; To fit an initial graph prior to rendering, set <a href="mxGraphView-js.html#mxGraphView.rendering" class=LVariable id=link1169 onMouseOver="ShowTip(event, 'tt550', 'link1169')" onMouseOut="HideTip('tt550')">mxGraphView.rendering</a> to false prior to changing the model and execute the following after changing the model.</p><blockquote><pre class="prettyprint">graph.fit();
2012-05-30 16:26:17 +00:00
graph.view.rendering = true;
graph.refresh();</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>border</td><td class=CDLDescription>Optional number that specifies the border.&nbsp; Default is 0.</td></tr><tr><td class=CDLEntry>keepOrigin</td><td class=CDLDescription>Optional boolean that specifies if the translate should be changed.&nbsp; Default is false.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.scrollCellToVisible"></a>scrollCellToVisible</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.scrollCellToVisible = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>center</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Pans the graph so that it shows the given cell.&nbsp; Optionally the cell may be centered in the container.</p><p>To center a given graph if the &lt;container&gt; has no scrollbars, use the following code.</p><p>[code] var bounds = graph.getGraphBounds(); graph.view.setTranslate(-bounds.x - (bounds.width - container.clientWidth) / 2, -bounds.y - (bounds.height - container.clientHeight) / 2); [/code]</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1170 onMouseOver="ShowTip(event, 'tt244', 'link1170')" onMouseOut="HideTip('tt244')">mxCell</a> to be made visible.</td></tr><tr><td class=CDLEntry>center</td><td class=CDLDescription>Optional boolean flag.&nbsp; Default is false.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.scrollRectToVisible"></a>scrollRectToVisible</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.scrollRectToVisible = function(</td><td class=PParameter nowrap>rect</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Pans the graph so that it shows the given rectangle.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>rect</td><td class=CDLDescription><a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link1171 onMouseOver="ShowTip(event, 'tt133', 'link1171')" onMouseOut="HideTip('tt133')">mxRectangle</a> to be made visible.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCellGeometry"></a>getCellGeometry</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCellGeometry = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the <a href="../model/mxGeometry-js.html#mxGeometry" class=LClass id=link1172 onMouseOver="ShowTip(event, 'tt248', 'link1172')" onMouseOut="HideTip('tt248')">mxGeometry</a> for the given cell.&nbsp; This implementation uses <a href="../model/mxGraphModel-js.html#mxGraphModel.getGeometry" class=LFunction id=link1173 onMouseOver="ShowTip(event, 'tt551', 'link1173')" onMouseOut="HideTip('tt551')">mxGraphModel.getGeometry</a>.&nbsp; Subclasses can override this to implement specific geometries for cells in only one graph, that is, it can return geometries that depend on the current state of the view.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1174 onMouseOver="ShowTip(event, 'tt244', 'link1174')" onMouseOut="HideTip('tt244')">mxCell</a> whose geometry should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellVisible"></a>isCellVisible</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellVisible = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is visible in this graph.&nbsp; This implementation uses <a href="../model/mxGraphModel-js.html#mxGraphModel.isVisible" class=LFunction id=link1175 onMouseOver="ShowTip(event, 'tt552', 'link1175')" onMouseOut="HideTip('tt552')">mxGraphModel.isVisible</a>.&nbsp; Subclassers can override this to implement specific visibility for cells in only one graph, that is, without affecting the visible state of the cell.</p><p>When using dynamic filter expressions for cell visibility, then the graph should be revalidated after the filter expression has changed.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1176 onMouseOver="ShowTip(event, 'tt244', 'link1176')" onMouseOut="HideTip('tt244')">mxCell</a> whose visible state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellCollapsed"></a>isCellCollapsed</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellCollapsed = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is collapsed in this graph.&nbsp; This implementation uses <a href="../model/mxGraphModel-js.html#mxGraphModel.isCollapsed" class=LFunction id=link1177 onMouseOver="ShowTip(event, 'tt553', 'link1177')" onMouseOut="HideTip('tt553')">mxGraphModel.isCollapsed</a>.&nbsp; Subclassers can override this to implement specific collapsed states for cells in only one graph, that is, without affecting the collapsed state of the cell.</p><p>When using dynamic filter expressions for the collapsed state, then the graph should be revalidated after the filter expression has changed.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1178 onMouseOver="ShowTip(event, 'tt244', 'link1178')" onMouseOut="HideTip('tt244')">mxCell</a> whose collapsed state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellConnectable"></a>isCellConnectable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellConnectable = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is connectable in this graph.&nbsp; This implementation uses <a href="../model/mxGraphModel-js.html#mxGraphModel.isConnectable" class=LFunction id=link1179 onMouseOver="ShowTip(event, 'tt554', 'link1179')" onMouseOut="HideTip('tt554')">mxGraphModel.isConnectable</a>.&nbsp; Subclassers can override this to implement specific connectable states for cells in only one graph, that is, without affecting the connectable state of the cell in the model.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1180 onMouseOver="ShowTip(event, 'tt244', 'link1180')" onMouseOut="HideTip('tt244')">mxCell</a> whose connectable state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isOrthogonal"></a>isOrthogonal</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isOrthogonal = function(</td><td class=PParameter nowrap>edge</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if perimeter points should be computed such that the resulting edge has only horizontal or vertical segments.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1181 onMouseOver="ShowTip(event, 'tt44', 'link1181')" onMouseOut="HideTip('tt44')">mxCellState</a> that represents the edge.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isLoop"></a>isLoop</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isLoop = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell state is a loop.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1182 onMouseOver="ShowTip(event, 'tt44', 'link1182')" onMouseOut="HideTip('tt44')">mxCellState</a> that represents a potential loop.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCloneEvent"></a>isCloneEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCloneEvent = function(</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given event is a clone event.&nbsp; This implementation returns true if control is pressed.</p></div></div></div>
2012-07-20 10:35:30 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isToggleEvent"></a>isToggleEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isToggleEvent = function(</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given event is a toggle event.&nbsp; This implementation returns true if the meta key (Cmd) is pressed on Macs or if control is pressed on any other platform.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isGridEnabledEvent"></a>isGridEnabledEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isGridEnabledEvent = function(</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given mouse event should be aligned to the grid.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isConstrainedEvent"></a>isConstrainedEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isConstrainedEvent = function(</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given mouse event should be aligned to the grid.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraph.Validation"></a>Validation</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.validationAlert"></a>validationAlert</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.validationAlert = function(</td><td class=PParameter nowrap>message</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Displays the given validation error in a dialog.&nbsp; This implementation uses mxUtils.alert.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isEdgeValid"></a>isEdgeValid</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isEdgeValid = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Checks if the return value of <a href="#mxGraph.getEdgeValidationError" class=LFunction id=link1183 onMouseOver="ShowTip(event, 'tt320', 'link1183')" onMouseOut="HideTip('tt320')">getEdgeValidationError</a> for the given arguments is null.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1184 onMouseOver="ShowTip(event, 'tt244', 'link1184')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the edge to validate.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1185 onMouseOver="ShowTip(event, 'tt244', 'link1185')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the source terminal.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1186 onMouseOver="ShowTip(event, 'tt244', 'link1186')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the target terminal.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getEdgeValidationError"></a>getEdgeValidationError</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getEdgeValidationError = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the validation error message to be displayed when inserting or changing an edges&rsquo; connectivity.&nbsp; A return value of null means the edge is valid, a return value of &lsquo;&rsquo; means it&rsquo;s not valid, but do not display an error message.&nbsp; Any other (non-empty) string returned from this method is displayed as an error message when trying to connect an edge to a source and target.&nbsp; This implementation uses the <a href="#mxGraph.multiplicities" class=LVariable id=link1187 onMouseOver="ShowTip(event, 'tt53', 'link1187')" onMouseOut="HideTip('tt53')">multiplicities</a>, and checks <a href="#mxGraph.multigraph" class=LVariable id=link1188 onMouseOver="ShowTip(event, 'tt161', 'link1188')" onMouseOut="HideTip('tt161')">multigraph</a>, <a href="#mxGraph.allowDanglingEdges" class=LVariable id=link1189 onMouseOver="ShowTip(event, 'tt163', 'link1189')" onMouseOut="HideTip('tt163')">allowDanglingEdges</a> and <a href="#mxGraph.allowLoops" class=LVariable id=link1190 onMouseOver="ShowTip(event, 'tt158', 'link1190')" onMouseOut="HideTip('tt158')">allowLoops</a> to generate validation errors.</p><p>For extending this method with specific checks for source/target cells, the method can be extended as follows.&nbsp; Returning an empty string means the edge is invalid with no error message, a non-null string specifies the error message, and null means the edge is valid.</p><blockquote><pre class="prettyprint">graph.getEdgeValidationError = function(edge, source, target)
2012-05-21 20:32:26 +00:00
{
if (source != null &amp;&amp; target != null &amp;&amp;
this.model.getValue(source) != null &amp;&amp;
this.model.getValue(target) != null)
{
if (target is not valid for source)
{
return 'Invalid Target';
}
}
// &quot;Supercall&quot;
return mxGraph.prototype.getEdgeValidationError.apply(this, arguments);
2015-04-23 20:18:31 +00:00
}</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1191 onMouseOver="ShowTip(event, 'tt244', 'link1191')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the edge to validate.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1192 onMouseOver="ShowTip(event, 'tt244', 'link1192')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the source terminal.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1193 onMouseOver="ShowTip(event, 'tt244', 'link1193')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the target terminal.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.validateEdge"></a>validateEdge</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.validateEdge = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hook method for subclassers to return an error message for the given edge and terminals.&nbsp; This implementation returns null.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1194 onMouseOver="ShowTip(event, 'tt244', 'link1194')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the edge to validate.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1195 onMouseOver="ShowTip(event, 'tt244', 'link1195')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the source terminal.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1196 onMouseOver="ShowTip(event, 'tt244', 'link1196')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the target terminal.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.validateGraph"></a>validateGraph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.validateGraph = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>context</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Validates the graph by validating each descendant of the given cell or the root of the model.&nbsp; Context is an object that contains the validation state for the complete validation run.&nbsp; The validation errors are attached to their cells using <a href="#mxGraph.setCellWarning" class=LFunction id=link1197 onMouseOver="ShowTip(event, 'tt216', 'link1197')" onMouseOut="HideTip('tt216')">setCellWarning</a>.&nbsp; This function returns true if no validation errors exist in the graph.</p><h4 class=CHeading>Paramters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1198 onMouseOver="ShowTip(event, 'tt244', 'link1198')" onMouseOut="HideTip('tt244')">mxCell</a> to start the validation recursion.&nbsp; Default is the graph root.</td></tr><tr><td class=CDLEntry>context</td><td class=CDLDescription>Object that represents the global validation state.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCellValidationError"></a>getCellValidationError</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCellValidationError = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Checks all <a href="#mxGraph.multiplicities" class=LVariable id=link1199 onMouseOver="ShowTip(event, 'tt53', 'link1199')" onMouseOut="HideTip('tt53')">multiplicities</a> that cannot be enforced while the graph is being modified, namely, all multiplicities that require a minimum of 1 edge.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1200 onMouseOver="ShowTip(event, 'tt244', 'link1200')" onMouseOut="HideTip('tt244')">mxCell</a> for which the multiplicities should be checked.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.validateCell"></a>validateCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.validateCell = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>context</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hook method for subclassers to return an error message for the given cell and validation context.&nbsp; This implementation returns null.&nbsp; Any HTML breaks will be converted to linefeeds in the calling method.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1201 onMouseOver="ShowTip(event, 'tt244', 'link1201')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the cell to validate.</td></tr><tr><td class=CDLEntry>context</td><td class=CDLDescription>Object that represents the global validation state.</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="mxGraph.Graph_appearance"></a>Graph appearance</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getBackgroundImage"></a>getBackgroundImage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getBackgroundImage = function()</td></tr></table></blockquote><p>Returns the <a href="#mxGraph.backgroundImage" class=LVariable id=link1202 onMouseOver="ShowTip(event, 'tt76', 'link1202')" onMouseOut="HideTip('tt76')">backgroundImage</a> as an <a href="../util/mxImage-js.html#mxImage" class=LClass id=link1203 onMouseOver="ShowTip(event, 'tt77', 'link1203')" onMouseOut="HideTip('tt77')">mxImage</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setBackgroundImage"></a>setBackgroundImage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setBackgroundImage = function(</td><td class=PParameter nowrap>image</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the new <a href="#mxGraph.backgroundImage" class=LVariable id=link1204 onMouseOver="ShowTip(event, 'tt76', 'link1204')" onMouseOut="HideTip('tt76')">backgroundImage</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>image</td><td class=CDLDescription>New <a href="../util/mxImage-js.html#mxImage" class=LClass id=link1205 onMouseOver="ShowTip(event, 'tt77', 'link1205')" onMouseOut="HideTip('tt77')">mxImage</a> to be used for the background.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getFoldingImage"></a>getFoldingImage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getFoldingImage = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the <a href="../util/mxImage-js.html#mxImage" class=LClass id=link1206 onMouseOver="ShowTip(event, 'tt77', 'link1206')" onMouseOut="HideTip('tt77')">mxImage</a> used to display the collapsed state of the specified cell state.&nbsp; This returns null for all edges.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.convertValueToString"></a>convertValueToString</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.convertValueToString = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the textual representation for the given cell.&nbsp; This implementation returns the nodename or string-representation of the user object.</p><h4 class=CHeading>Example</h4><p>The following returns the label attribute from the cells user object if it is an XML node.</p><blockquote><pre class="prettyprint">graph.convertValueToString = function(cell)
{
return cell.getAttribute('label');
2015-04-23 20:18:31 +00:00
}</pre></blockquote><p>See also: <a href="#mxGraph.cellLabelChanged" class=LFunction id=link1207 onMouseOver="ShowTip(event, 'tt32', 'link1207')" onMouseOut="HideTip('tt32')">cellLabelChanged</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1208 onMouseOver="ShowTip(event, 'tt244', 'link1208')" onMouseOut="HideTip('tt244')">mxCell</a> whose textual representation should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getLabel"></a>getLabel</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getLabel = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns a string or DOM node that represents the label for the given cell.&nbsp; This implementation uses <a href="#mxGraph.convertValueToString" class=LFunction id=link1209 onMouseOver="ShowTip(event, 'tt327', 'link1209')" onMouseOut="HideTip('tt327')">convertValueToString</a> if <a href="#mxGraph.labelsVisible" class=LVariable id=link1210 onMouseOver="ShowTip(event, 'tt166', 'link1210')" onMouseOut="HideTip('tt166')">labelsVisible</a> is true.&nbsp; Otherwise it returns an empty string.</p><p>To truncate a label to match the size of the cell, the following code can be used.</p><blockquote><pre class="prettyprint">graph.getLabel = function(cell)
2012-05-21 20:32:26 +00:00
{
var label = mxGraph.prototype.getLabel.apply(this, arguments);
if (label != null &amp;&amp; this.model.isVertex(cell))
{
var geo = this.getCellGeometry(cell);
if (geo != null)
{
var max = parseInt(geo.width / 8);
if (label.length &gt; max)
{
label = label.substring(0, max)+'...';
}
}
}
return mxUtils.htmlEntities(label);
}</pre></blockquote><p>A resize listener is needed in the graph to force a repaint of the label after a resize.</p><blockquote><pre class="prettyprint">graph.addListener(mxEvent.RESIZE_CELLS, function(sender, evt)
{
var cells = evt.getProperty('cells');
for (var i = 0; i &lt; cells.length; i++)
{
this.view.removeState(cells[i]);
}
2015-04-23 20:18:31 +00:00
});</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1211 onMouseOver="ShowTip(event, 'tt244', 'link1211')" onMouseOut="HideTip('tt244')">mxCell</a> whose label should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isHtmlLabel"></a>isHtmlLabel</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isHtmlLabel = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the label must be rendered as HTML markup.&nbsp; The default implementation returns <a href="#mxGraph.htmlLabels" class=LVariable id=link1212 onMouseOver="ShowTip(event, 'tt167', 'link1212')" onMouseOut="HideTip('tt167')">htmlLabels</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1213 onMouseOver="ShowTip(event, 'tt244', 'link1213')" onMouseOut="HideTip('tt244')">mxCell</a> whose label should be displayed as HTML markup.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isHtmlLabels"></a>isHtmlLabels</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isHtmlLabels = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.htmlLabels" class=LVariable id=link1214 onMouseOver="ShowTip(event, 'tt167', 'link1214')" onMouseOut="HideTip('tt167')">htmlLabels</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setHtmlLabels"></a>setHtmlLabels</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setHtmlLabels = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.htmlLabels" class=LVariable id=link1215 onMouseOver="ShowTip(event, 'tt167', 'link1215')" onMouseOut="HideTip('tt167')">htmlLabels</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isWrapping"></a>isWrapping</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isWrapping = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>This enables wrapping for HTML labels.</p><p>Returns true if no white-space CSS style directive should be used for displaying the given cells label.&nbsp; This implementation returns true if <a href="../util/mxConstants-js.html#mxConstants.STYLE_WHITE_SPACE" class=LVariable id=link1216 onMouseOver="ShowTip(event, 'tt555', 'link1216')" onMouseOut="HideTip('tt555')">mxConstants.STYLE_WHITE_SPACE</a> in the style of the given cell is &lsquo;wrap&rsquo;.</p><p>This is used as a workaround for IE ignoring the white-space directive of child elements if the directive appears in a parent element.&nbsp; It should be overridden to return true if a white-space directive is used in the HTML markup that represents the given cells label.&nbsp; In order for HTML markup to work in labels, <a href="#mxGraph.isHtmlLabel" class=LFunction id=link1217 onMouseOver="ShowTip(event, 'tt168', 'link1217')" onMouseOut="HideTip('tt168')">isHtmlLabel</a> must also return true for the given cell.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">graph.getLabel = function(cell)
2012-05-21 20:32:26 +00:00
{
var tmp = mxGraph.prototype.getLabel.apply(this, arguments); // &quot;supercall&quot;
if (this.model.isEdge(cell))
{
tmp = '&lt;div style=&quot;width: 150px; white-space:normal;&quot;&gt;'+tmp+'&lt;/div&gt;';
}
return tmp;
}
graph.isWrapping = function(state)
{
return this.model.isEdge(state.cell);
2015-04-23 20:18:31 +00:00
}</pre></blockquote><p>Makes sure no edge label is wider than 150 pixels, otherwise the content is wrapped.&nbsp; Note: No width must be specified for wrapped vertex labels as the vertex defines the width in its geometry.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1218 onMouseOver="ShowTip(event, 'tt244', 'link1218')" onMouseOut="HideTip('tt244')">mxCell</a> whose label should be wrapped.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isLabelClipped"></a>isLabelClipped</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isLabelClipped = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the overflow portion of labels should be hidden.&nbsp; If this returns true then vertex labels will be clipped to the size of the vertices.&nbsp; This implementation returns true if <a href="../util/mxConstants-js.html#mxConstants.STYLE_OVERFLOW" class=LVariable id=link1219 onMouseOver="ShowTip(event, 'tt556', 'link1219')" onMouseOut="HideTip('tt556')">mxConstants.STYLE_OVERFLOW</a> in the style of the given cell is &lsquo;hidden&rsquo;.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1220 onMouseOver="ShowTip(event, 'tt244', 'link1220')" onMouseOut="HideTip('tt244')">mxCell</a> whose label should be clipped.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getTooltip"></a>getTooltip</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getTooltip = function(</td><td class=PParameter nowrap>state,</td></tr><tr><td></td><td class=PParameter nowrap>node,</td></tr><tr><td></td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the string or DOM node that represents the tooltip for the given state, node and coordinate pair.&nbsp; This implementation checks if the given node is a folding icon or overlay and returns the respective tooltip.&nbsp; If this does not result in a tooltip, the handler for the cell is retrieved from &lt;selectionCellsHandler&gt; and the optional getTooltipForNode method is called.&nbsp; If no special tooltip exists here then <a href="#mxGraph.getTooltipForCell" class=LFunction id=link1221 onMouseOver="ShowTip(event, 'tt334', 'link1221')" onMouseOut="HideTip('tt334')">getTooltipForCell</a> is used with the cell in the given state as the argument to return a tooltip for the given state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1222 onMouseOver="ShowTip(event, 'tt44', 'link1222')" onMouseOut="HideTip('tt44')">mxCellState</a> whose tooltip should be returned.</td></tr><tr><td class=CDLEntry>node</td><td class=CDLDescription>DOM node that is currently under the mouse.</td></tr><tr><td class=CDLEntry>x</td><td class=CDLDescription>X-coordinate of the mouse.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Y-coordinate of the mouse.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getTooltipForCell"></a>getTooltipForCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getTooltipForCell = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the string or DOM node to be used as the tooltip for the given cell.&nbsp; This implementation uses the cells getTooltip function if it exists, or else it returns <a href="#mxGraph.convertValueToString" class=LFunction id=link1223 onMouseOver="ShowTip(event, 'tt327', 'link1223')" onMouseOut="HideTip('tt327')">convertValueToString</a> for the cell.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">graph.getTooltipForCell = function(cell)
2012-05-21 20:32:26 +00:00
{
return 'Hello, World!';
2015-04-23 20:18:31 +00:00
}</pre></blockquote><p>Replaces all tooltips with the string Hello, World!</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1224 onMouseOver="ShowTip(event, 'tt244', 'link1224')" onMouseOut="HideTip('tt244')">mxCell</a> whose tooltip should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCursorForMouseEvent"></a>getCursorForMouseEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCursorForMouseEvent = function(</td><td class=PParameter nowrap>me</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cursor value to be used for the CSS of the shape for the given event.&nbsp; This implementation calls <a href="#mxGraph.getCursorForCell" class=LFunction id=link1225 onMouseOver="ShowTip(event, 'tt336', 'link1225')" onMouseOut="HideTip('tt336')">getCursorForCell</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>me</td><td class=CDLDescription><a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link1226 onMouseOver="ShowTip(event, 'tt222', 'link1226')" onMouseOut="HideTip('tt222')">mxMouseEvent</a> whose cursor should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCursorForCell"></a>getCursorForCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCursorForCell = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cursor value to be used for the CSS of the shape for the given cell.&nbsp; This implementation returns null.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1227 onMouseOver="ShowTip(event, 'tt244', 'link1227')" onMouseOut="HideTip('tt244')">mxCell</a> whose cursor should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getStartSize"></a>getStartSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getStartSize = function(</td><td class=PParameter nowrap>swimlane</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the start size of the given swimlane, that is, the width or height of the part that contains the title, depending on the horizontal style.&nbsp; The return value is an <a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link1228 onMouseOver="ShowTip(event, 'tt133', 'link1228')" onMouseOut="HideTip('tt133')">mxRectangle</a> with either width or height set as appropriate.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>swimlane</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1229 onMouseOver="ShowTip(event, 'tt244', 'link1229')" onMouseOut="HideTip('tt244')">mxCell</a> whose start size should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getImage"></a>getImage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getImage = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the image URL for the given cell state.&nbsp; This implementation returns the value stored under <a href="../util/mxConstants-js.html#mxConstants.STYLE_IMAGE" class=LVariable id=link1230 onMouseOver="ShowTip(event, 'tt509', 'link1230')" onMouseOut="HideTip('tt509')">mxConstants.STYLE_IMAGE</a> in the cell style.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1231 onMouseOver="ShowTip(event, 'tt44', 'link1231')" onMouseOut="HideTip('tt44')">mxCellState</a> whose image URL should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getVerticalAlign"></a>getVerticalAlign</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getVerticalAlign = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the vertical alignment for the given cell state.&nbsp; This implementation returns the value stored under <a href="../util/mxConstants-js.html#mxConstants.STYLE_VERTICAL_ALIGN" class=LVariable id=link1232 onMouseOver="ShowTip(event, 'tt557', 'link1232')" onMouseOut="HideTip('tt557')">mxConstants.STYLE_VERTICAL_ALIGN</a> in the cell style.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1233 onMouseOver="ShowTip(event, 'tt44', 'link1233')" onMouseOut="HideTip('tt44')">mxCellState</a> whose vertical alignment should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getIndicatorColor"></a>getIndicatorColor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getIndicatorColor = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the indicator color for the given cell state.&nbsp; This implementation returns the value stored under <a href="../util/mxConstants-js.html#mxConstants.STYLE_INDICATOR_COLOR" class=LVariable id=link1234 onMouseOver="ShowTip(event, 'tt558', 'link1234')" onMouseOut="HideTip('tt558')">mxConstants.STYLE_INDICATOR_COLOR</a> in the cell style.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1235 onMouseOver="ShowTip(event, 'tt44', 'link1235')" onMouseOut="HideTip('tt44')">mxCellState</a> whose indicator color should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getIndicatorGradientColor"></a>getIndicatorGradientColor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getIndicatorGradientColor = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the indicator gradient color for the given cell state.&nbsp; This implementation returns the value stored under <a href="../util/mxConstants-js.html#mxConstants.STYLE_INDICATOR_GRADIENTCOLOR" class=LVariable id=link1236 onMouseOver="ShowTip(event, 'tt559', 'link1236')" onMouseOut="HideTip('tt559')">mxConstants.STYLE_INDICATOR_GRADIENTCOLOR</a> in the cell style.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1237 onMouseOver="ShowTip(event, 'tt44', 'link1237')" onMouseOut="HideTip('tt44')">mxCellState</a> whose indicator gradient color should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getIndicatorShape"></a>getIndicatorShape</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getIndicatorShape = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the indicator shape for the given cell state.&nbsp; This implementation returns the value stored under <a href="../util/mxConstants-js.html#mxConstants.STYLE_INDICATOR_SHAPE" class=LVariable id=link1238 onMouseOver="ShowTip(event, 'tt560', 'link1238')" onMouseOut="HideTip('tt560')">mxConstants.STYLE_INDICATOR_SHAPE</a> in the cell style.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1239 onMouseOver="ShowTip(event, 'tt44', 'link1239')" onMouseOut="HideTip('tt44')">mxCellState</a> whose indicator shape should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getIndicatorImage"></a>getIndicatorImage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getIndicatorImage = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the indicator image for the given cell state.&nbsp; This implementation returns the value stored under <a href="../util/mxConstants-js.html#mxConstants.STYLE_INDICATOR_IMAGE" class=LVariable id=link1240 onMouseOver="ShowTip(event, 'tt561', 'link1240')" onMouseOut="HideTip('tt561')">mxConstants.STYLE_INDICATOR_IMAGE</a> in the cell style.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1241 onMouseOver="ShowTip(event, 'tt44', 'link1241')" onMouseOut="HideTip('tt44')">mxCellState</a> whose indicator image should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getBorder"></a>getBorder</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getBorder = function()</td></tr></table></blockquote><p>Returns the value of <a href="#mxGraph.border" class=LVariable id=link1242 onMouseOver="ShowTip(event, 'tt138', 'link1242')" onMouseOut="HideTip('tt138')">border</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setBorder"></a>setBorder</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setBorder = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the value of <a href="#mxGraph.border" class=LVariable id=link1243 onMouseOver="ShowTip(event, 'tt138', 'link1243')" onMouseOut="HideTip('tt138')">border</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>Positive integer that represents the border to be used.</td></tr></table></div></div></div>
2014-01-08 16:23:20 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isSwimlane"></a>isSwimlane</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isSwimlane = function (</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is a swimlane in the graph.&nbsp; A swimlane is a container cell with some specific behaviour.&nbsp; This implementation checks if the shape associated with the given cell is a <a href="../shape/mxSwimlane-js.html#mxSwimlane" class=LClass id=link1244 onMouseOver="ShowTip(event, 'tt562', 'link1244')" onMouseOut="HideTip('tt562')">mxSwimlane</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1245 onMouseOver="ShowTip(event, 'tt244', 'link1245')" onMouseOut="HideTip('tt244')">mxCell</a> to be checked.</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="mxGraph.Graph_behaviour"></a>Graph behaviour</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isResizeContainer"></a>isResizeContainer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isResizeContainer = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.resizeContainer" class=LVariable id=link1246 onMouseOver="ShowTip(event, 'tt136', 'link1246')" onMouseOut="HideTip('tt136')">resizeContainer</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setResizeContainer"></a>setResizeContainer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setResizeContainer = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.resizeContainer" class=LVariable id=link1247 onMouseOver="ShowTip(event, 'tt136', 'link1247')" onMouseOut="HideTip('tt136')">resizeContainer</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 indicating if the container should be resized.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isEnabled"></a>isEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isEnabled = function()</td></tr></table></blockquote><p>Returns true if the graph is <a href="#mxGraph.enabled" class=LVariable id=link1248 onMouseOver="ShowTip(event, 'tt87', 'link1248')" onMouseOut="HideTip('tt87')">enabled</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setEnabled"></a>setEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setEnabled = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if the graph should allow any interactions.&nbsp; This implementation updates <a href="#mxGraph.enabled" class=LVariable id=link1249 onMouseOver="ShowTip(event, 'tt87', 'link1249')" onMouseOut="HideTip('tt87')">enabled</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 indicating if the graph should be enabled.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isEscapeEnabled"></a>isEscapeEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isEscapeEnabled = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.escapeEnabled" class=LVariable id=link1250 onMouseOver="ShowTip(event, 'tt89', 'link1250')" onMouseOut="HideTip('tt89')">escapeEnabled</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setEscapeEnabled"></a>setEscapeEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setEscapeEnabled = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.escapeEnabled" class=LVariable id=link1251 onMouseOver="ShowTip(event, 'tt89', 'link1251')" onMouseOut="HideTip('tt89')">escapeEnabled</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 indicating if escape should be enabled.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isInvokesStopCellEditing"></a>isInvokesStopCellEditing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isInvokesStopCellEditing = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.invokesStopCellEditing" class=LVariable id=link1252 onMouseOver="ShowTip(event, 'tt92', 'link1252')" onMouseOut="HideTip('tt92')">invokesStopCellEditing</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setInvokesStopCellEditing"></a>setInvokesStopCellEditing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setInvokesStopCellEditing = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.invokesStopCellEditing" class=LVariable id=link1253 onMouseOver="ShowTip(event, 'tt92', 'link1253')" onMouseOut="HideTip('tt92')">invokesStopCellEditing</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isEnterStopsCellEditing"></a>isEnterStopsCellEditing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isEnterStopsCellEditing = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.enterStopsCellEditing" class=LVariable id=link1254 onMouseOver="ShowTip(event, 'tt93', 'link1254')" onMouseOut="HideTip('tt93')">enterStopsCellEditing</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setEnterStopsCellEditing"></a>setEnterStopsCellEditing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setEnterStopsCellEditing = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.enterStopsCellEditing" class=LVariable id=link1255 onMouseOver="ShowTip(event, 'tt93', 'link1255')" onMouseOut="HideTip('tt93')">enterStopsCellEditing</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellLocked"></a>isCellLocked</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellLocked = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell may not be moved, sized, bended, disconnected, edited or selected.&nbsp; This implementation returns true for all vertices with a relative geometry if &lt;locked&gt; is false.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1256 onMouseOver="ShowTip(event, 'tt244', 'link1256')" onMouseOut="HideTip('tt244')">mxCell</a> whose locked state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellsLocked"></a>isCellsLocked</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isCellsLocked = function()</td></tr></table></blockquote><p>Returns true if the given cell may not be moved, sized, bended, disconnected, edited or selected.&nbsp; This implementation returns true for all vertices with a relative geometry if &lt;locked&gt; is false.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1257 onMouseOver="ShowTip(event, 'tt244', 'link1257')" onMouseOut="HideTip('tt244')">mxCell</a> whose locked state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setLocked"></a>setLocked</h3><div class=CBody><p>Sets if any cell may be moved, sized, bended, disconnected, edited or selected.</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 defines the new value for <a href="#mxGraph.cellsLocked" class=LVariable id=link1258 onMouseOver="ShowTip(event, 'tt100', 'link1258')" onMouseOut="HideTip('tt100')">cellsLocked</a>.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCloneableCells"></a>getCloneableCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCloneableCells = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cells which may be exported in the given array of cells.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellCloneable"></a>isCellCloneable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellCloneable = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is cloneable.&nbsp; This implementation returns <a href="#mxGraph.isCellsCloneable" class=LFunction id=link1259 onMouseOver="ShowTip(event, 'tt358', 'link1259')" onMouseOut="HideTip('tt358')">isCellsCloneable</a> for all cells unless a cell style specifies <a href="../util/mxConstants-js.html#mxConstants.STYLE_CLONEABLE" class=LVariable id=link1260 onMouseOver="ShowTip(event, 'tt563', 'link1260')" onMouseOut="HideTip('tt563')">mxConstants.STYLE_CLONEABLE</a> to be 0.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1261 onMouseOver="ShowTip(event, 'tt244', 'link1261')" onMouseOut="HideTip('tt244')">mxCell</a> whose cloneable state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellsCloneable"></a>isCellsCloneable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isCellsCloneable = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.cellsCloneable" class=LVariable id=link1262 onMouseOver="ShowTip(event, 'tt102', 'link1262')" onMouseOut="HideTip('tt102')">cellsCloneable</a>, that is, if the graph allows cloning of cells by using control-drag.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCellsCloneable"></a>setCellsCloneable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCellsCloneable = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if the graph should allow cloning of cells by holding down the control key while cells are being moved.&nbsp; This implementation updates <a href="#mxGraph.cellsCloneable" class=LVariable id=link1263 onMouseOver="ShowTip(event, 'tt102', 'link1263')" onMouseOut="HideTip('tt102')">cellsCloneable</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 indicating if the graph should be cloneable.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getExportableCells"></a>getExportableCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getExportableCells = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cells which may be exported in the given array of cells.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.canExportCell"></a>canExportCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.canExportCell = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell may be exported to the clipboard.&nbsp; This implementation returns <a href="#mxGraph.exportEnabled" class=LVariable id=link1264 onMouseOver="ShowTip(event, 'tt96', 'link1264')" onMouseOut="HideTip('tt96')">exportEnabled</a> for all cells.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1265 onMouseOver="ShowTip(event, 'tt244', 'link1265')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the cell to be exported.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getImportableCells"></a>getImportableCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getImportableCells = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cells which may be imported in the given array of cells.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.canImportCell"></a>canImportCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.canImportCell = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell may be imported from the clipboard.&nbsp; This implementation returns <a href="#mxGraph.importEnabled" class=LVariable id=link1266 onMouseOver="ShowTip(event, 'tt98', 'link1266')" onMouseOut="HideTip('tt98')">importEnabled</a> for all cells.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1267 onMouseOver="ShowTip(event, 'tt244', 'link1267')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the cell to be imported.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellSelectable"></a>isCellSelectable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellSelectable = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is selectable.&nbsp; This implementation returns <a href="#mxGraph.cellsSelectable" class=LVariable id=link1268 onMouseOver="ShowTip(event, 'tt121', 'link1268')" onMouseOut="HideTip('tt121')">cellsSelectable</a>.</p><p>To add a new style for making cells (un)selectable, use the following code.</p><blockquote><pre class="prettyprint">mxGraph.prototype.isCellSelectable = function(cell)
2012-05-21 20:32:26 +00:00
{
var state = this.view.getState(cell);
var style = (state != null) ? state.style : this.getCellStyle(cell);
return this.isCellsSelectable() &amp;&amp; !this.isCellLocked(cell) &amp;&amp; style['selectable'] != 0;
2015-04-23 20:18:31 +00:00
};</pre></blockquote><p>You can then use the new style as shown in this example.</p><blockquote><pre class="prettyprint">graph.insertVertex(parent, null, 'Hello,', 20, 20, 80, 30, 'selectable=0');</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1269 onMouseOver="ShowTip(event, 'tt244', 'link1269')" onMouseOut="HideTip('tt244')">mxCell</a> whose selectable state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellsSelectable"></a>isCellsSelectable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isCellsSelectable = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.cellsSelectable" class=LVariable id=link1270 onMouseOver="ShowTip(event, 'tt121', 'link1270')" onMouseOut="HideTip('tt121')">cellsSelectable</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCellsSelectable"></a>setCellsSelectable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCellsSelectable = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.cellsSelectable" class=LVariable id=link1271 onMouseOver="ShowTip(event, 'tt121', 'link1271')" onMouseOut="HideTip('tt121')">cellsSelectable</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getDeletableCells"></a>getDeletableCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getDeletableCells = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cells which may be exported in the given array of cells.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellDeletable"></a>isCellDeletable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellDeletable = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is moveable.&nbsp; This returns <a href="#mxGraph.cellsDeletable" class=LVariable id=link1272 onMouseOver="ShowTip(event, 'tt107', 'link1272')" onMouseOut="HideTip('tt107')">cellsDeletable</a> for all given cells if a cells style does not specify <a href="../util/mxConstants-js.html#mxConstants.STYLE_DELETABLE" class=LVariable id=link1273 onMouseOver="ShowTip(event, 'tt564', 'link1273')" onMouseOut="HideTip('tt564')">mxConstants.STYLE_DELETABLE</a> to be 0.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1274 onMouseOver="ShowTip(event, 'tt244', 'link1274')" onMouseOut="HideTip('tt244')">mxCell</a> whose deletable state should be returned.</td></tr></table></div></div></div>
2013-05-23 16:14:48 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellsDeletable"></a>isCellsDeletable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isCellsDeletable = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.cellsDeletable" class=LVariable id=link1275 onMouseOver="ShowTip(event, 'tt107', 'link1275')" onMouseOut="HideTip('tt107')">cellsDeletable</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCellsDeletable"></a>setCellsDeletable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCellsDeletable = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.cellsDeletable" class=LVariable id=link1276 onMouseOver="ShowTip(event, 'tt107', 'link1276')" onMouseOut="HideTip('tt107')">cellsDeletable</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 indicating if the graph should allow deletion of cells.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isLabelMovable"></a>isLabelMovable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isLabelMovable = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given edges&rsquo;s label is moveable.&nbsp; This returns &lt;movable&gt; for all given cells if &lt;isLocked&gt; does not return true for the given cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1277 onMouseOver="ShowTip(event, 'tt244', 'link1277')" onMouseOut="HideTip('tt244')">mxCell</a> whose label should be moved.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellRotatable"></a>isCellRotatable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellRotatable = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is rotatable.&nbsp; This returns true for the given cell if its style does not specify <a href="../util/mxConstants-js.html#mxConstants.STYLE_ROTATABLE" class=LVariable id=link1278 onMouseOver="ShowTip(event, 'tt565', 'link1278')" onMouseOut="HideTip('tt565')">mxConstants.STYLE_ROTATABLE</a> to be 0.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1279 onMouseOver="ShowTip(event, 'tt244', 'link1279')" onMouseOut="HideTip('tt244')">mxCell</a> whose rotatable state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getMovableCells"></a>getMovableCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getMovableCells = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cells which are movable in the given array of cells.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellMovable"></a>isCellMovable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellMovable = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is moveable.&nbsp; This returns <a href="#mxGraph.cellsMovable" class=LVariable id=link1280 onMouseOver="ShowTip(event, 'tt109', 'link1280')" onMouseOut="HideTip('tt109')">cellsMovable</a> for all given cells if <a href="#mxGraph.isCellLocked" class=LFunction id=link1281 onMouseOver="ShowTip(event, 'tt101', 'link1281')" onMouseOut="HideTip('tt101')">isCellLocked</a> does not return true for the given cell and its style does not specify <a href="../util/mxConstants-js.html#mxConstants.STYLE_MOVABLE" class=LVariable id=link1282 onMouseOver="ShowTip(event, 'tt566', 'link1282')" onMouseOut="HideTip('tt566')">mxConstants.STYLE_MOVABLE</a> to be 0.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1283 onMouseOver="ShowTip(event, 'tt244', 'link1283')" onMouseOut="HideTip('tt244')">mxCell</a> whose movable state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellsMovable"></a>isCellsMovable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isCellsMovable = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.cellsMovable" class=LVariable id=link1284 onMouseOver="ShowTip(event, 'tt109', 'link1284')" onMouseOut="HideTip('tt109')">cellsMovable</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCellsMovable"></a>setCellsMovable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCellsMovable = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if the graph should allow moving of cells.&nbsp; This implementation updates &lt;cellsMsovable&gt;.</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 indicating if the graph should allow moving of cells.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isGridEnabled"></a>isGridEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isGridEnabled = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.gridEnabled" class=LVariable id=link1285 onMouseOver="ShowTip(event, 'tt58', 'link1285')" onMouseOut="HideTip('tt58')">gridEnabled</a> as a boolean.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setGridEnabled"></a>setGridEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setGridEnabled = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if the grid should be enabled.</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 indicating if the grid should be enabled.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isPortsEnabled"></a>isPortsEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isPortsEnabled = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.portsEnabled" class=LVariable id=link1286 onMouseOver="ShowTip(event, 'tt59', 'link1286')" onMouseOut="HideTip('tt59')">portsEnabled</a> as a boolean.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setPortsEnabled"></a>setPortsEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setPortsEnabled = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if the ports should be enabled.</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 indicating if the ports should be enabled.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getGridSize"></a>getGridSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getGridSize = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.gridSize" class=LVariable id=link1287 onMouseOver="ShowTip(event, 'tt57', 'link1287')" onMouseOut="HideTip('tt57')">gridSize</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setGridSize"></a>setGridSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setGridSize = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.gridSize" class=LVariable id=link1288 onMouseOver="ShowTip(event, 'tt57', 'link1288')" onMouseOut="HideTip('tt57')">gridSize</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getTolerance"></a>getTolerance</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getTolerance = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.tolerance" class=LVariable id=link1289 onMouseOver="ShowTip(event, 'tt70', 'link1289')" onMouseOut="HideTip('tt70')">tolerance</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setTolerance"></a>setTolerance</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setTolerance = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.tolerance" class=LVariable id=link1290 onMouseOver="ShowTip(event, 'tt70', 'link1290')" onMouseOut="HideTip('tt70')">tolerance</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isVertexLabelsMovable"></a>isVertexLabelsMovable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isVertexLabelsMovable = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.vertexLabelsMovable" class=LVariable id=link1291 onMouseOver="ShowTip(event, 'tt113', 'link1291')" onMouseOut="HideTip('tt113')">vertexLabelsMovable</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setVertexLabelsMovable"></a>setVertexLabelsMovable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setVertexLabelsMovable = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.vertexLabelsMovable" class=LVariable id=link1292 onMouseOver="ShowTip(event, 'tt113', 'link1292')" onMouseOut="HideTip('tt113')">vertexLabelsMovable</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isEdgeLabelsMovable"></a>isEdgeLabelsMovable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isEdgeLabelsMovable = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.edgeLabelsMovable" class=LVariable id=link1293 onMouseOver="ShowTip(event, 'tt111', 'link1293')" onMouseOut="HideTip('tt111')">edgeLabelsMovable</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isEdgeLabelsMovable"></a>isEdgeLabelsMovable</h3><div class=CBody><p>Sets <a href="#mxGraph.edgeLabelsMovable" class=LVariable id=link1294 onMouseOver="ShowTip(event, 'tt111', 'link1294')" onMouseOut="HideTip('tt111')">edgeLabelsMovable</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isSwimlaneNesting"></a>isSwimlaneNesting</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isSwimlaneNesting = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.swimlaneNesting" class=LVariable id=link1295 onMouseOver="ShowTip(event, 'tt170', 'link1295')" onMouseOut="HideTip('tt170')">swimlaneNesting</a> as a boolean.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setSwimlaneNesting"></a>setSwimlaneNesting</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setSwimlaneNesting = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if swimlanes can be nested by drag and drop.&nbsp; This is only taken into account if dropEnabled is true.</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 indicating if swimlanes can be nested.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isSwimlaneSelectionEnabled"></a>isSwimlaneSelectionEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isSwimlaneSelectionEnabled = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.swimlaneSelectionEnabled" class=LVariable id=link1296 onMouseOver="ShowTip(event, 'tt169', 'link1296')" onMouseOut="HideTip('tt169')">swimlaneSelectionEnabled</a> as a boolean.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setSwimlaneSelectionEnabled"></a>setSwimlaneSelectionEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setSwimlaneSelectionEnabled = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if swimlanes should be selected if the mouse is released over their content area.</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 indicating if swimlanes content areas should be selected when the mouse is released over them.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isMultigraph"></a>isMultigraph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isMultigraph = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.multigraph" class=LVariable id=link1297 onMouseOver="ShowTip(event, 'tt161', 'link1297')" onMouseOut="HideTip('tt161')">multigraph</a> as a boolean.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setMultigraph"></a>setMultigraph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setMultigraph = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if the graph should allow multiple connections between the same pair of vertices.</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 indicating if the graph allows multiple connections between the same pair of vertices.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isAllowLoops"></a>isAllowLoops</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isAllowLoops = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.allowLoops" class=LVariable id=link1298 onMouseOver="ShowTip(event, 'tt158', 'link1298')" onMouseOut="HideTip('tt158')">allowLoops</a> as a boolean.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setAllowDanglingEdges"></a>setAllowDanglingEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setAllowDanglingEdges = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if dangling edges are allowed, that is, if edges are allowed that do not have a source and/or target terminal defined.</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 indicating if dangling edges are allowed.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isAllowDanglingEdges"></a>isAllowDanglingEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isAllowDanglingEdges = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.allowDanglingEdges" class=LVariable id=link1299 onMouseOver="ShowTip(event, 'tt163', 'link1299')" onMouseOut="HideTip('tt163')">allowDanglingEdges</a> as a boolean.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setConnectableEdges"></a>setConnectableEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setConnectableEdges = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if edges should be connectable.</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 indicating if edges should be connectable.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isConnectableEdges"></a>isConnectableEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isConnectableEdges = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.connectableEdges" class=LVariable id=link1300 onMouseOver="ShowTip(event, 'tt162', 'link1300')" onMouseOut="HideTip('tt162')">connectableEdges</a> as a boolean.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCloneInvalidEdges"></a>setCloneInvalidEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCloneInvalidEdges = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if edges should be inserted when cloned but not valid wrt.&nbsp; <a href="#mxGraph.getEdgeValidationError" class=LFunction id=link1301 onMouseOver="ShowTip(event, 'tt320', 'link1301')" onMouseOut="HideTip('tt320')">getEdgeValidationError</a>.&nbsp; If false such edges will be silently ignored.</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 indicating if cloned invalid edges should be inserted into the graph or ignored.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCloneInvalidEdges"></a>isCloneInvalidEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isCloneInvalidEdges = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.cloneInvalidEdges" class=LVariable id=link1302 onMouseOver="ShowTip(event, 'tt164', 'link1302')" onMouseOut="HideTip('tt164')">cloneInvalidEdges</a> as a boolean.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setAllowLoops"></a>setAllowLoops</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setAllowLoops = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if loops are allowed.</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 indicating if loops are allowed.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isDisconnectOnMove"></a>isDisconnectOnMove</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isDisconnectOnMove = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.disconnectOnMove" class=LVariable id=link1303 onMouseOver="ShowTip(event, 'tt165', 'link1303')" onMouseOut="HideTip('tt165')">disconnectOnMove</a> as a boolean.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setDisconnectOnMove"></a>setDisconnectOnMove</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setDisconnectOnMove = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if edges should be disconnected when moved.&nbsp; (Note: Cloned edges are always disconnected.)</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 indicating if edges should be disconnected when moved.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isDropEnabled"></a>isDropEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isDropEnabled = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.dropEnabled" class=LVariable id=link1304 onMouseOver="ShowTip(event, 'tt114', 'link1304')" onMouseOut="HideTip('tt114')">dropEnabled</a> as a boolean.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setDropEnabled"></a>setDropEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setDropEnabled = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if the graph should allow dropping of cells onto or into other cells.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>dropEnabled</td><td class=CDLDescription>Boolean indicating if the graph should allow dropping of cells into other cells.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isSplitEnabled"></a>isSplitEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isSplitEnabled = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.splitEnabled" class=LVariable id=link1305 onMouseOver="ShowTip(event, 'tt116', 'link1305')" onMouseOut="HideTip('tt116')">splitEnabled</a> as a boolean.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setSplitEnabled"></a>setSplitEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setSplitEnabled = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if the graph should allow dropping of cells onto or into other cells.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>dropEnabled</td><td class=CDLDescription>Boolean indicating if the graph should allow dropping of cells into other cells.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellResizable"></a>isCellResizable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellResizable = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is resizable.&nbsp; This returns <a href="#mxGraph.cellsResizable" class=LVariable id=link1306 onMouseOver="ShowTip(event, 'tt117', 'link1306')" onMouseOut="HideTip('tt117')">cellsResizable</a> for all given cells if <a href="#mxGraph.isCellLocked" class=LFunction id=link1307 onMouseOver="ShowTip(event, 'tt101', 'link1307')" onMouseOut="HideTip('tt101')">isCellLocked</a> does not return true for the given cell and its style does not specify <a href="../util/mxConstants-js.html#mxConstants.STYLE_RESIZABLE" class=LVariable id=link1308 onMouseOver="ShowTip(event, 'tt567', 'link1308')" onMouseOut="HideTip('tt567')">mxConstants.STYLE_RESIZABLE</a> to be 0.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1309 onMouseOver="ShowTip(event, 'tt244', 'link1309')" onMouseOut="HideTip('tt244')">mxCell</a> whose resizable state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellsResizable"></a>isCellsResizable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isCellsResizable = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.cellsResizable" class=LVariable id=link1310 onMouseOver="ShowTip(event, 'tt117', 'link1310')" onMouseOut="HideTip('tt117')">cellsResizable</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCellsResizable"></a>setCellsResizable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCellsResizable = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if the graph should allow resizing of cells.&nbsp; This implementation updates <a href="#mxGraph.cellsResizable" class=LVariable id=link1311 onMouseOver="ShowTip(event, 'tt117', 'link1311')" onMouseOut="HideTip('tt117')">cellsResizable</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 indicating if the graph should allow resizing of cells.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isTerminalPointMovable"></a>isTerminalPointMovable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isTerminalPointMovable = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>source</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given terminal point is movable.&nbsp; This is independent from <a href="#mxGraph.isCellConnectable" class=LFunction id=link1312 onMouseOver="ShowTip(event, 'tt311', 'link1312')" onMouseOut="HideTip('tt311')">isCellConnectable</a> and <a href="#mxGraph.isCellDisconnectable" class=LFunction id=link1313 onMouseOver="ShowTip(event, 'tt408', 'link1313')" onMouseOut="HideTip('tt408')">isCellDisconnectable</a> and controls if terminal points can be moved in the graph if the edge is not connected.&nbsp; Note that it is required for this to return true to connect unconnected edges.&nbsp; This implementation returns true.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1314 onMouseOver="ShowTip(event, 'tt244', 'link1314')" onMouseOut="HideTip('tt244')">mxCell</a> whose terminal point should be moved.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean indicating if the source or target terminal should be moved.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellBendable"></a>isCellBendable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellBendable = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is bendable.&nbsp; This returns <a href="#mxGraph.cellsBendable" class=LVariable id=link1315 onMouseOver="ShowTip(event, 'tt119', 'link1315')" onMouseOut="HideTip('tt119')">cellsBendable</a> for all given cells if &lt;isLocked&gt; does not return true for the given cell and its style does not specify <a href="../util/mxConstants-js.html#mxConstants.STYLE_BENDABLE" class=LVariable id=link1316 onMouseOver="ShowTip(event, 'tt568', 'link1316')" onMouseOut="HideTip('tt568')">mxConstants.STYLE_BENDABLE</a> to be 0.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1317 onMouseOver="ShowTip(event, 'tt244', 'link1317')" onMouseOut="HideTip('tt244')">mxCell</a> whose bendable state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellsBendable"></a>isCellsBendable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isCellsBendable = function()</td></tr></table></blockquote><p>Returns &lt;cellsBenadable&gt;.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCellsBendable"></a>setCellsBendable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCellsBendable = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if the graph should allow bending of edges.&nbsp; This implementation updates &lt;bendable&gt;.</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 indicating if the graph should allow bending of edges.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellEditable"></a>isCellEditable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellEditable = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is editable.&nbsp; This returns <a href="#mxGraph.cellsEditable" class=LVariable id=link1318 onMouseOver="ShowTip(event, 'tt105', 'link1318')" onMouseOut="HideTip('tt105')">cellsEditable</a> for all given cells if <a href="#mxGraph.isCellLocked" class=LFunction id=link1319 onMouseOver="ShowTip(event, 'tt101', 'link1319')" onMouseOut="HideTip('tt101')">isCellLocked</a> does not return true for the given cell and its style does not specify <a href="../util/mxConstants-js.html#mxConstants.STYLE_EDITABLE" class=LVariable id=link1320 onMouseOver="ShowTip(event, 'tt569', 'link1320')" onMouseOut="HideTip('tt569')">mxConstants.STYLE_EDITABLE</a> to be 0.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1321 onMouseOver="ShowTip(event, 'tt244', 'link1321')" onMouseOut="HideTip('tt244')">mxCell</a> whose editable state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellsEditable"></a>isCellsEditable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isCellsEditable = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.cellsEditable" class=LVariable id=link1322 onMouseOver="ShowTip(event, 'tt105', 'link1322')" onMouseOut="HideTip('tt105')">cellsEditable</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCellsEditable"></a>setCellsEditable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCellsEditable = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if the graph should allow in-place editing for cell labels.&nbsp; This implementation updates <a href="#mxGraph.cellsEditable" class=LVariable id=link1323 onMouseOver="ShowTip(event, 'tt105', 'link1323')" onMouseOut="HideTip('tt105')">cellsEditable</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 indicating if the graph should allow in-place editing.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellDisconnectable"></a>isCellDisconnectable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellDisconnectable = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>terminal,</td></tr><tr><td></td><td class=PParameter nowrap>source</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is disconnectable from the source or target terminal.&nbsp; This returns <a href="#mxGraph.isCellsDisconnectable" class=LFunction id=link1324 onMouseOver="ShowTip(event, 'tt409', 'link1324')" onMouseOut="HideTip('tt409')">isCellsDisconnectable</a> for all given cells if <a href="#mxGraph.isCellLocked" class=LFunction id=link1325 onMouseOver="ShowTip(event, 'tt101', 'link1325')" onMouseOut="HideTip('tt101')">isCellLocked</a> does not return true for the given cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1326 onMouseOver="ShowTip(event, 'tt244', 'link1326')" onMouseOut="HideTip('tt244')">mxCell</a> whose disconnectable state should be returned.</td></tr><tr><td class=CDLEntry>terminal</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1327 onMouseOver="ShowTip(event, 'tt244', 'link1327')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the source or target terminal.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Boolean indicating if the source or target terminal is to be disconnected.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellsDisconnectable"></a>isCellsDisconnectable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isCellsDisconnectable = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.cellsDisconnectable" class=LVariable id=link1328 onMouseOver="ShowTip(event, 'tt123', 'link1328')" onMouseOut="HideTip('tt123')">cellsDisconnectable</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setCellsDisconnectable"></a>setCellsDisconnectable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setCellsDisconnectable = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.cellsDisconnectable" class=LVariable id=link1329 onMouseOver="ShowTip(event, 'tt123', 'link1329')" onMouseOut="HideTip('tt123')">cellsDisconnectable</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isValidSource"></a>isValidSource</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isValidSource = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is a valid source for new connections.&nbsp; This implementation returns true for all non-null values and is called by is called by <a href="#mxGraph.isValidConnection" class=LFunction id=link1330 onMouseOver="ShowTip(event, 'tt413', 'link1330')" onMouseOut="HideTip('tt413')">isValidConnection</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1331 onMouseOver="ShowTip(event, 'tt244', 'link1331')" onMouseOut="HideTip('tt244')">mxCell</a> that represents a possible source or null.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isValidTarget"></a>isValidTarget</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isValidTarget = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns <a href="#mxGraph.isValidSource" class=LFunction id=link1332 onMouseOver="ShowTip(event, 'tt411', 'link1332')" onMouseOut="HideTip('tt411')">isValidSource</a> for the given cell.&nbsp; This is called by <a href="#mxGraph.isValidConnection" class=LFunction id=link1333 onMouseOver="ShowTip(event, 'tt413', 'link1333')" onMouseOut="HideTip('tt413')">isValidConnection</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1334 onMouseOver="ShowTip(event, 'tt244', 'link1334')" onMouseOut="HideTip('tt244')">mxCell</a> that represents a possible target or null.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isValidConnection"></a>isValidConnection</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isValidConnection = function(</td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given target cell is a valid target for source.&nbsp; This is a boolean implementation for not allowing connections between certain pairs of vertices and is called by <a href="#mxGraph.getEdgeValidationError" class=LFunction id=link1335 onMouseOver="ShowTip(event, 'tt320', 'link1335')" onMouseOut="HideTip('tt320')">getEdgeValidationError</a>.&nbsp; This implementation returns true if <a href="#mxGraph.isValidSource" class=LFunction id=link1336 onMouseOver="ShowTip(event, 'tt411', 'link1336')" onMouseOut="HideTip('tt411')">isValidSource</a> returns true for the source and <a href="#mxGraph.isValidTarget" class=LFunction id=link1337 onMouseOver="ShowTip(event, 'tt412', 'link1337')" onMouseOut="HideTip('tt412')">isValidTarget</a> returns true for the target.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>source</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1338 onMouseOver="ShowTip(event, 'tt244', 'link1338')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the source cell.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1339 onMouseOver="ShowTip(event, 'tt244', 'link1339')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the target cell.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setConnectable"></a>setConnectable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setConnectable = function(</td><td class=PParameter nowrap>connectable</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if the graph should allow new connections.&nbsp; This implementation updates <a href="../handler/mxConnectionHandler-js.html#mxConnectionHandler.enabled" class=LVariable id=link1340 onMouseOver="ShowTip(event, 'tt570', 'link1340')" onMouseOut="HideTip('tt570')">mxConnectionHandler.enabled</a> in &lt;connectionHandler&gt;.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>connectable</td><td class=CDLDescription>Boolean indicating if new connections should be allowed.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isConnectable"></a>isConnectable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isConnectable = function(</td><td class=PParameter nowrap>connectable</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the &lt;connectionHandler&gt; is enabled.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setTooltips"></a>setTooltips</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setTooltips = function (</td><td class=PParameter nowrap>enabled</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if tooltips should be enabled.&nbsp; This implementation updates <a href="../handler/mxTooltipHandler-js.html#mxTooltipHandler.enabled" class=LVariable id=link1341 onMouseOver="ShowTip(event, 'tt571', 'link1341')" onMouseOut="HideTip('tt571')">mxTooltipHandler.enabled</a> in &lt;tooltipHandler&gt;.</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 indicating if tooltips should be enabled.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setPanning"></a>setPanning</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setPanning = function(</td><td class=PParameter nowrap>enabled</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if panning should be enabled.&nbsp; This implementation updates <a href="../handler/mxPanningHandler-js.html#mxPanningHandler.panningEnabled" class=LVariable id=link1342 onMouseOver="ShowTip(event, 'tt572', 'link1342')" onMouseOut="HideTip('tt572')">mxPanningHandler.panningEnabled</a> in &lt;panningHandler&gt;.</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 indicating if panning should be enabled.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isEditing"></a>isEditing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isEditing = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is currently being edited.&nbsp; If no cell is specified then this returns true if any cell is currently being edited.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1343 onMouseOver="ShowTip(event, 'tt244', 'link1343')" onMouseOut="HideTip('tt244')">mxCell</a> that should be checked.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isAutoSizeCell"></a>isAutoSizeCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isAutoSizeCell = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the size of the given cell should automatically be updated after a change of the label.&nbsp; This implementation returns <a href="#mxGraph.autoSizeCells" class=LVariable id=link1344 onMouseOver="ShowTip(event, 'tt124', 'link1344')" onMouseOut="HideTip('tt124')">autoSizeCells</a> or checks if the cell style does specify <a href="../util/mxConstants-js.html#mxConstants.STYLE_AUTOSIZE" class=LVariable id=link1345 onMouseOver="ShowTip(event, 'tt573', 'link1345')" onMouseOut="HideTip('tt573')">mxConstants.STYLE_AUTOSIZE</a> to be 1.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1346 onMouseOver="ShowTip(event, 'tt244', 'link1346')" onMouseOut="HideTip('tt244')">mxCell</a> that should be resized.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isAutoSizeCells"></a>isAutoSizeCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isAutoSizeCells = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.autoSizeCells" class=LVariable id=link1347 onMouseOver="ShowTip(event, 'tt124', 'link1347')" onMouseOut="HideTip('tt124')">autoSizeCells</a>.</p></div></div></div>
2013-08-09 09:08:09 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setAutoSizeCells"></a>setAutoSizeCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setAutoSizeCells = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Specifies if cell sizes should be automatically updated after a label change.&nbsp; This implementation sets <a href="#mxGraph.autoSizeCells" class=LVariable id=link1348 onMouseOver="ShowTip(event, 'tt124', 'link1348')" onMouseOut="HideTip('tt124')">autoSizeCells</a> to the given parameter.&nbsp; To update the size of cells when the cells are added, set <a href="#mxGraph.autoSizeCellsOnAdd" class=LVariable id=link1349 onMouseOver="ShowTip(event, 'tt125', 'link1349')" onMouseOut="HideTip('tt125')">autoSizeCellsOnAdd</a> to true.</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 indicating if cells should be resized automatically.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isExtendParent"></a>isExtendParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isExtendParent = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the parent of the given cell should be extended if the child has been resized so that it overlaps the parent.&nbsp; This implementation returns <a href="#mxGraph.isExtendParents" class=LFunction id=link1350 onMouseOver="ShowTip(event, 'tt423', 'link1350')" onMouseOut="HideTip('tt423')">isExtendParents</a> if the cell is not an edge.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1351 onMouseOver="ShowTip(event, 'tt244', 'link1351')" onMouseOut="HideTip('tt244')">mxCell</a> that has been resized.</td></tr></table></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isExtendParents"></a>isExtendParents</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isExtendParents = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.extendParents" class=LVariable id=link1352 onMouseOver="ShowTip(event, 'tt144', 'link1352')" onMouseOut="HideTip('tt144')">extendParents</a>.</p></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setExtendParents"></a>setExtendParents</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setExtendParents = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.extendParents" class=LVariable id=link1353 onMouseOver="ShowTip(event, 'tt144', 'link1353')" onMouseOut="HideTip('tt144')">extendParents</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>New boolean value for <a href="#mxGraph.extendParents" class=LVariable id=link1354 onMouseOver="ShowTip(event, 'tt144', 'link1354')" onMouseOut="HideTip('tt144')">extendParents</a>.</td></tr></table></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isExtendParentsOnAdd"></a>isExtendParentsOnAdd</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isExtendParentsOnAdd = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns <a href="#mxGraph.extendParentsOnAdd" class=LVariable id=link1355 onMouseOver="ShowTip(event, 'tt145', 'link1355')" onMouseOut="HideTip('tt145')">extendParentsOnAdd</a>.</p></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setExtendParentsOnAdd"></a>setExtendParentsOnAdd</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setExtendParentsOnAdd = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.extendParentsOnAdd" class=LVariable id=link1356 onMouseOver="ShowTip(event, 'tt145', 'link1356')" onMouseOut="HideTip('tt145')">extendParentsOnAdd</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>New boolean value for <a href="#mxGraph.extendParentsOnAdd" class=LVariable id=link1357 onMouseOver="ShowTip(event, 'tt145', 'link1357')" onMouseOut="HideTip('tt145')">extendParentsOnAdd</a>.</td></tr></table></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isExtendParentsOnMove"></a>isExtendParentsOnMove</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isExtendParentsOnMove = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.extendParentsOnAdd" class=LVariable id=link1358 onMouseOver="ShowTip(event, 'tt145', 'link1358')" onMouseOut="HideTip('tt145')">extendParentsOnAdd</a>.</p></div></div></div>
2013-09-19 07:24:45 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setExtendParentsOnMove"></a>setExtendParentsOnMove</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setExtendParentsOnMove = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.extendParentsOnAdd" class=LVariable id=link1359 onMouseOver="ShowTip(event, 'tt145', 'link1359')" onMouseOut="HideTip('tt145')">extendParentsOnAdd</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>New boolean value for <a href="#mxGraph.extendParentsOnAdd" class=LVariable id=link1360 onMouseOver="ShowTip(event, 'tt145', 'link1360')" onMouseOut="HideTip('tt145')">extendParentsOnAdd</a>.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isRecursiveResize"></a>isRecursiveResize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isRecursiveResize = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns <a href="#mxGraph.recursiveResize" class=LVariable id=link1361 onMouseOver="ShowTip(event, 'tt146', 'link1361')" onMouseOut="HideTip('tt146')">recursiveResize</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1362 onMouseOver="ShowTip(event, 'tt44', 'link1362')" onMouseOut="HideTip('tt44')">mxCellState</a> that is being resized.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setRecursiveResize"></a>setRecursiveResize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setRecursiveResize = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.recursiveResize" class=LVariable id=link1363 onMouseOver="ShowTip(event, 'tt146', 'link1363')" onMouseOut="HideTip('tt146')">recursiveResize</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>New boolean value for <a href="#mxGraph.recursiveResize" class=LVariable id=link1364 onMouseOver="ShowTip(event, 'tt146', 'link1364')" onMouseOut="HideTip('tt146')">recursiveResize</a>.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isConstrainChild"></a>isConstrainChild</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isConstrainChild = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell should be kept inside the bounds of its parent according to the rules defined by <a href="#mxGraph.getOverlap" class=LFunction id=link1365 onMouseOver="ShowTip(event, 'tt72', 'link1365')" onMouseOut="HideTip('tt72')">getOverlap</a> and <a href="#mxGraph.isAllowOverlapParent" class=LFunction id=link1366 onMouseOver="ShowTip(event, 'tt73', 'link1366')" onMouseOut="HideTip('tt73')">isAllowOverlapParent</a>.&nbsp; This implementation returns false for all children of edges and <a href="#mxGraph.isConstrainChildren" class=LFunction id=link1367 onMouseOver="ShowTip(event, 'tt430', 'link1367')" onMouseOut="HideTip('tt430')">isConstrainChildren</a> otherwise.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1368 onMouseOver="ShowTip(event, 'tt244', 'link1368')" onMouseOut="HideTip('tt244')">mxCell</a> that should be constrained.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isConstrainChildren"></a>isConstrainChildren</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isConstrainChildren = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.constrainChildren" class=LVariable id=link1369 onMouseOver="ShowTip(event, 'tt142', 'link1369')" onMouseOut="HideTip('tt142')">constrainChildren</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setConstrainChildren"></a>setConstrainChildren</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setConstrainChildren = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.constrainChildren" class=LVariable id=link1370 onMouseOver="ShowTip(event, 'tt142', 'link1370')" onMouseOut="HideTip('tt142')">constrainChildren</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setConstrainChildrenOnResize"></a>setConstrainChildrenOnResize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setConstrainChildrenOnResize = function(</td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets <a href="#mxGraph.constrainChildrenOnResize" class=LVariable id=link1371 onMouseOver="ShowTip(event, 'tt143', 'link1371')" onMouseOut="HideTip('tt143')">constrainChildrenOnResize</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isConstrainChildrenOnResize"></a>isConstrainChildrenOnResize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isConstrainChildrenOnResize = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.constrainChildrenOnResize" class=LVariable id=link1372 onMouseOver="ShowTip(event, 'tt143', 'link1372')" onMouseOut="HideTip('tt143')">constrainChildrenOnResize</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isConstrainChildren"></a>isConstrainChildren</h3><div class=CBody><p>Returns <a href="#mxGraph.allowNegativeCoordinates" class=LVariable id=link1373 onMouseOver="ShowTip(event, 'tt141', 'link1373')" onMouseOut="HideTip('tt141')">allowNegativeCoordinates</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setConstrainChildren"></a>setConstrainChildren</h3><div class=CBody><p>Sets <a href="#mxGraph.allowNegativeCoordinates" class=LVariable id=link1374 onMouseOver="ShowTip(event, 'tt141', 'link1374')" onMouseOut="HideTip('tt141')">allowNegativeCoordinates</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getOverlap"></a>getOverlap</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getOverlap = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns a decimal number representing the amount of the width and height of the given cell that is allowed to overlap its parent.&nbsp; A value of 0 means all children must stay inside the parent, 1 means the child is allowed to be placed outside of the parent such that it touches one of the parents sides.&nbsp; If <a href="#mxGraph.isAllowOverlapParent" class=LFunction id=link1375 onMouseOver="ShowTip(event, 'tt73', 'link1375')" onMouseOut="HideTip('tt73')">isAllowOverlapParent</a> returns false for the given cell, then this method returns 0.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1376 onMouseOver="ShowTip(event, 'tt244', 'link1376')" onMouseOut="HideTip('tt244')">mxCell</a> for which the overlap ratio should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isAllowOverlapParent"></a>isAllowOverlapParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isAllowOverlapParent = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is allowed to be placed outside of the parents area.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1377 onMouseOver="ShowTip(event, 'tt244', 'link1377')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the child to be checked.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getFoldableCells"></a>getFoldableCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getFoldableCells = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>collapse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cells which are movable in the given array of cells.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellFoldable"></a>isCellFoldable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellFoldable = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>collapse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is foldable.&nbsp; This implementation returns true if the cell has at least one child and its style does not specify <a href="../util/mxConstants-js.html#mxConstants.STYLE_FOLDABLE" class=LVariable id=link1378 onMouseOver="ShowTip(event, 'tt574', 'link1378')" onMouseOut="HideTip('tt574')">mxConstants.STYLE_FOLDABLE</a> to be 0.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1379 onMouseOver="ShowTip(event, 'tt244', 'link1379')" onMouseOut="HideTip('tt244')">mxCell</a> whose foldable state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isValidDropTarget"></a>isValidDropTarget</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isValidDropTarget = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is a valid drop target for the specified cells.&nbsp; If <a href="#mxGraph.splitEnabled" class=LVariable id=link1380 onMouseOver="ShowTip(event, 'tt116', 'link1380')" onMouseOut="HideTip('tt116')">splitEnabled</a> is true then this returns <a href="#mxGraph.isSplitTarget" class=LFunction id=link1381 onMouseOver="ShowTip(event, 'tt437', 'link1381')" onMouseOut="HideTip('tt437')">isSplitTarget</a> for the given arguments else it returns true if the cell is not collapsed and its child count is greater than 0.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1382 onMouseOver="ShowTip(event, 'tt244', 'link1382')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the possible drop target.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1383 onMouseOver="ShowTip(event, 'tt244', 'link1383')" onMouseOut="HideTip('tt244')">mxCells</a> that should be dropped into the target.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mouseevent that triggered the invocation.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isSplitTarget"></a>isSplitTarget</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isSplitTarget = function(</td><td class=PParameter nowrap>target,</td></tr><tr><td></td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given edge may be splitted into two edges with the given cell as a new terminal between the two.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1384 onMouseOver="ShowTip(event, 'tt244', 'link1384')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the edge to be splitted.</td></tr><tr><td class=CDLEntry>cells</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1385 onMouseOver="ShowTip(event, 'tt244', 'link1385')" onMouseOut="HideTip('tt244')">mxCells</a> that should split the edge.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mouseevent that triggered the invocation.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getDropTarget"></a>getDropTarget</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getDropTarget = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>evt,</td></tr><tr><td></td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>clone</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the given cell if it is a drop target for the given cells or the nearest ancestor that may be used as a drop target for the given cells.&nbsp; If the given array contains a swimlane and <a href="#mxGraph.swimlaneNesting" class=LVariable id=link1386 onMouseOver="ShowTip(event, 'tt170', 'link1386')" onMouseOut="HideTip('tt170')">swimlaneNesting</a> is false then this always returns null.&nbsp; If no cell is given, then the bottommost swimlane at the location of the given event is returned.</p><p>This function should only be used if <a href="#mxGraph.isDropEnabled" class=LFunction id=link1387 onMouseOver="ShowTip(event, 'tt115', 'link1387')" onMouseOut="HideTip('tt115')">isDropEnabled</a> returns true.</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=link1388 onMouseOver="ShowTip(event, 'tt244', 'link1388')" onMouseOut="HideTip('tt244')">mxCells</a> which are to be dropped onto the target.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mouseevent for the drag and drop.</td></tr><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1389 onMouseOver="ShowTip(event, 'tt244', 'link1389')" onMouseOut="HideTip('tt244')">mxCell</a> that is under the mousepointer.</td></tr><tr><td class=CDLEntry>clone</td><td class=CDLDescription>Optional boolean to indicate of cells will be cloned.</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="mxGraph.Cell_retrieval"></a>Cell retrieval</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getDefaultParent"></a>getDefaultParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getDefaultParent = function()</td></tr></table></blockquote><p>Returns <a href="#mxGraph.defaultParent" class=LVariable id=link1390 onMouseOver="ShowTip(event, 'tt74', 'link1390')" onMouseOut="HideTip('tt74')">defaultParent</a> or <a href="mxGraphView-js.html#mxGraphView.currentRoot" class=LVariable id=link1391 onMouseOver="ShowTip(event, 'tt440', 'link1391')" onMouseOut="HideTip('tt440')">mxGraphView.currentRoot</a> or the first child child of <a href="../model/mxGraphModel-js.html#mxGraphModel.root" class=LVariable id=link1392 onMouseOver="ShowTip(event, 'tt441', 'link1392')" onMouseOut="HideTip('tt441')">mxGraphModel.root</a> if both are null.&nbsp; The value returned by this function should be used as the parent for new cells (aka default layer).</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setDefaultParent"></a>setDefaultParent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setDefaultParent = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the <a href="#mxGraph.defaultParent" class=LVariable id=link1393 onMouseOver="ShowTip(event, 'tt74', 'link1393')" onMouseOut="HideTip('tt74')">defaultParent</a> to the given cell.&nbsp; Set this to null to return the first child of the root in getDefaultParent.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getSwimlane"></a>getSwimlane</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getSwimlane = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the nearest ancestor of the given cell which is a swimlane, or the given cell, if it is itself a swimlane.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1394 onMouseOver="ShowTip(event, 'tt244', 'link1394')" onMouseOut="HideTip('tt244')">mxCell</a> for which the ancestor swimlane should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getSwimlaneAt"></a>getSwimlaneAt</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getSwimlaneAt = function (</td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y,</td></tr><tr><td></td><td class=PParameter nowrap>parent</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bottom-most swimlane that intersects the given point (x, y) in the cell hierarchy that starts at the given parent.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x</td><td class=CDLDescription>X-coordinate of the location to be checked.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Y-coordinate of the location to be checked.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1395 onMouseOver="ShowTip(event, 'tt244', 'link1395')" onMouseOut="HideTip('tt244')">mxCell</a> that should be used as the root of the recursion.&nbsp; Default is <a href="#mxGraph.defaultParent" class=LVariable id=link1396 onMouseOver="ShowTip(event, 'tt74', 'link1396')" onMouseOut="HideTip('tt74')">defaultParent</a>.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCellAt"></a>getCellAt</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCellAt = function(</td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y,</td></tr><tr><td></td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>vertices,</td></tr><tr><td></td><td class=PParameter nowrap>edges,</td></tr><tr><td></td><td class=PParameter nowrap>ignoreFn</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bottom-most cell that intersects the given point (x, y) in the cell hierarchy starting at the given parent.&nbsp; This will also return swimlanes if the given location intersects the content area of the swimlane.&nbsp; If this is not desired, then the <a href="#mxGraph.hitsSwimlaneContent" class=LFunction id=link1397 onMouseOver="ShowTip(event, 'tt447', 'link1397')" onMouseOut="HideTip('tt447')">hitsSwimlaneContent</a> may be used if the returned cell is a swimlane to determine if the location is inside the content area or on the actual title of the swimlane.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x</td><td class=CDLDescription>X-coordinate of the location to be checked.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Y-coordinate of the location to be checked.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1398 onMouseOver="ShowTip(event, 'tt244', 'link1398')" onMouseOut="HideTip('tt244')">mxCell</a> that should be used as the root of the recursion.&nbsp; Default is current root of the view or the root of the model.</td></tr><tr><td class=CDLEntry>vertices</td><td class=CDLDescription>Optional boolean indicating if vertices should be returned.&nbsp; Default is true.</td></tr><tr><td class=CDLEntry>edges</td><td class=CDLDescription>Optional boolean indicating if edges should be returned.&nbsp; Default is true.</td></tr><tr><td class=CDLEntry>ignoreFn</td><td class=CDLDescription>Optional function that returns true if cell should be ignored.&nbsp; The function is passed the cell state and the x and y parameter.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.intersects"></a>intersects</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.intersects = function(</td><td class=PParameter nowrap>state,</td></tr><tr><td></td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bottom-most cell that intersects the given point (x, y) in the cell hierarchy that starts at the given parent.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1399 onMouseOver="ShowTip(event, 'tt44', 'link1399')" onMouseOut="HideTip('tt44')">mxCellState</a> that represents the cell state.</td></tr><tr><td class=CDLEntry>x</td><td class=CDLDescription>X-coordinate of the location to be checked.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Y-coordinate of the location to be checked.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.hitsSwimlaneContent"></a>hitsSwimlaneContent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.hitsSwimlaneContent = function(</td><td class=PParameter nowrap>swimlane,</td></tr><tr><td></td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given coordinate pair is inside the content are of the given swimlane.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>swimlane</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1400 onMouseOver="ShowTip(event, 'tt244', 'link1400')" onMouseOut="HideTip('tt244')">mxCell</a> that specifies the swimlane.</td></tr><tr><td class=CDLEntry>x</td><td class=CDLDescription>X-coordinate of the mouse event.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Y-coordinate of the mouse event.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getChildVertices"></a>getChildVertices</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getChildVertices = function(</td><td class=PParameter nowrap>parent</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the visible child vertices of the given parent.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1401 onMouseOver="ShowTip(event, 'tt244', 'link1401')" onMouseOut="HideTip('tt244')">mxCell</a> whose children should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getChildEdges"></a>getChildEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getChildEdges = function(</td><td class=PParameter nowrap>parent</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the visible child edges of the given parent.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1402 onMouseOver="ShowTip(event, 'tt244', 'link1402')" onMouseOut="HideTip('tt244')">mxCell</a> whose child vertices should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getChildCells"></a>getChildCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getChildCells = function(</td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>vertices,</td></tr><tr><td></td><td class=PParameter nowrap>edges</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the visible child vertices or edges in the given parent.&nbsp; If vertices and edges is false, then all children are returned.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1403 onMouseOver="ShowTip(event, 'tt244', 'link1403')" onMouseOut="HideTip('tt244')">mxCell</a> whose children should be returned.</td></tr><tr><td class=CDLEntry>vertices</td><td class=CDLDescription>Optional boolean that specifies if child vertices should be returned.&nbsp; Default is false.</td></tr><tr><td class=CDLEntry>edges</td><td class=CDLDescription>Optional boolean that specifies if child edges should be returned.&nbsp; Default is false.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getConnections"></a>getConnections</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getConnections = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>parent</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns all visible edges connected to the given cell without loops.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1404 onMouseOver="ShowTip(event, 'tt244', 'link1404')" onMouseOut="HideTip('tt244')">mxCell</a> whose connections should be returned.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription>Optional parent of the opposite end for a connection to be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getIncomingEdges"></a>getIncomingEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getIncomingEdges = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>parent</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the visible incoming edges for the given cell.&nbsp; If the optional parent argument is specified, then only child edges of the given parent are returned.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1405 onMouseOver="ShowTip(event, 'tt244', 'link1405')" onMouseOut="HideTip('tt244')">mxCell</a> whose incoming edges should be returned.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription>Optional parent of the opposite end for an edge to be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getOutgoingEdges"></a>getOutgoingEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getOutgoingEdges = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>parent</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the visible outgoing edges for the given cell.&nbsp; If the optional parent argument is specified, then only child edges of the given parent are returned.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1406 onMouseOver="ShowTip(event, 'tt244', 'link1406')" onMouseOut="HideTip('tt244')">mxCell</a> whose outgoing edges should be returned.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription>Optional parent of the opposite end for an edge to be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getEdges"></a>getEdges</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getEdges = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>incoming,</td></tr><tr><td></td><td class=PParameter nowrap>outgoing,</td></tr><tr><td></td><td class=PParameter nowrap>includeLoops,</td></tr><tr><td></td><td class=PParameter nowrap>recurse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the incoming and/or outgoing edges for the given cell.&nbsp; If the optional parent argument is specified, then only edges are returned where the opposite is in the given parent cell.&nbsp; If at least one of incoming or outgoing is true, then loops are ignored, if both are false, then all edges connected to the given cell are returned including loops.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1407 onMouseOver="ShowTip(event, 'tt244', 'link1407')" onMouseOut="HideTip('tt244')">mxCell</a> whose edges should be returned.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription>Optional parent of the opposite end for an edge to be returned.</td></tr><tr><td class=CDLEntry>incoming</td><td class=CDLDescription>Optional boolean that specifies if incoming edges should be included in the result.&nbsp; Default is true.</td></tr><tr><td class=CDLEntry>outgoing</td><td class=CDLDescription>Optional boolean that specifies if outgoing edges should be included in the result.&nbsp; Default is true.</td></tr><tr><td class=CDLEntry>includeLoops</td><td class=CDLDescription>Optional boolean that specifies if loops should be included in the result.&nbsp; Default is true.</td></tr><tr><td class=CDLEntry>recurse</td><td class=CDLDescription>Optional boolean the specifies if the parent specified only need be an ancestral parent, true, or the direct parent, false.&nbsp; Default is false</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isValidAncestor"></a>isValidAncestor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isValidAncestor = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>recurse</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns whether or not the specified parent is a valid ancestor of the specified cell, either direct or indirectly based on whether ancestor recursion is enabled.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1408 onMouseOver="ShowTip(event, 'tt244', 'link1408')" onMouseOut="HideTip('tt244')">mxCell</a> the possible child cell</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1409 onMouseOver="ShowTip(event, 'tt244', 'link1409')" onMouseOut="HideTip('tt244')">mxCell</a> the possible parent cell</td></tr><tr><td class=CDLEntry>recurse</td><td class=CDLDescription>boolean whether or not to recurse the child ancestors</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getOpposites"></a>getOpposites</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getOpposites = function(</td><td class=PParameter nowrap>edges,</td></tr><tr><td></td><td class=PParameter nowrap>terminal,</td></tr><tr><td></td><td class=PParameter nowrap>sources,</td></tr><tr><td></td><td class=PParameter nowrap>targets</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns all distinct visible opposite cells for the specified terminal on the given edges.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edges</td><td class=CDLDescription>Array of <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1410 onMouseOver="ShowTip(event, 'tt244', 'link1410')" onMouseOut="HideTip('tt244')">mxCells</a> that contains the edges whose opposite terminals should be returned.</td></tr><tr><td class=CDLEntry>terminal</td><td class=CDLDescription>Terminal that specifies the end whose opposite should be returned.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Optional boolean that specifies if source terminals should be included in the result.&nbsp; Default is true.</td></tr><tr><td class=CDLEntry>targets</td><td class=CDLDescription>Optional boolean that specifies if targer terminals should be included in the result.&nbsp; Default is true.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getEdgesBetween"></a>getEdgesBetween</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getEdgesBetween = function(</td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>target,</td></tr><tr><td></td><td class=PParameter nowrap>directed</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the edges between the given source and target.&nbsp; This takes into account collapsed and invisible cells and returns the connected edges as displayed on the screen.</p><h4 class=CHeading>Parameters</h4><p>source - target - directed -</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getPointForEvent"></a>getPointForEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getPointForEvent = function(</td><td class=PParameter nowrap>evt,</td></tr><tr><td></td><td class=PParameter nowrap>addOffset</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns an <a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link1411 onMouseOver="ShowTip(event, 'tt289', 'link1411')" onMouseOut="HideTip('tt289')">mxPoint</a> representing the given event in the unscaled, non-translated coordinate space of &lt;container&gt; and applies the grid.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mousevent that contains the mouse pointer location.</td></tr><tr><td class=CDLEntry>addOffset</td><td class=CDLDescription>Optional boolean that specifies if the position should be offset by half of the <a href="#mxGraph.gridSize" class=LVariable id=link1412 onMouseOver="ShowTip(event, 'tt57', 'link1412')" onMouseOut="HideTip('tt57')">gridSize</a>.&nbsp; Default is true.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCells"></a>getCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCells = function(</td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y,</td></tr><tr><td></td><td class=PParameter nowrap>width,</td></tr><tr><td></td><td class=PParameter nowrap>height,</td></tr><tr><td></td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>result</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the child vertices and edges of the given parent that are contained in the given rectangle.&nbsp; The result is added to the optional result array, which is returned.&nbsp; If no result array is specified then a new array is created and returned.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x</td><td class=CDLDescription>X-coordinate of the rectangle.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Y-coordinate of the rectangle.</td></tr><tr><td class=CDLEntry>width</td><td class=CDLDescription>Width of the rectangle.</td></tr><tr><td class=CDLEntry>height</td><td class=CDLDescription>Height of the rectangle.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1413 onMouseOver="ShowTip(event, 'tt244', 'link1413')" onMouseOut="HideTip('tt244')">mxCell</a> that should be used as the root of the recursion.&nbsp; Default is current root of the view or the root of the model.</td></tr><tr><td class=CDLEntry>result</td><td class=CDLDescription>Optional array to store the result in.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getCellsBeyond"></a>getCellsBeyond</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getCellsBeyond = function(</td><td class=PParameter nowrap>x0,</td></tr><tr><td></td><td class=PParameter nowrap>y0,</td></tr><tr><td></td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>rightHalfpane,</td></tr><tr><td></td><td class=PParameter nowrap>bottomHalfpane</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the children of the given parent that are contained in the halfpane from the given point (x0, y0) rightwards or downwards depending on rightHalfpane and bottomHalfpane.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x0</td><td class=CDLDescription>X-coordinate of the origin.</td></tr><tr><td class=CDLEntry>y0</td><td class=CDLDescription>Y-coordinate of the origin.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1414 onMouseOver="ShowTip(event, 'tt244', 'link1414')" onMouseOut="HideTip('tt244')">mxCell</a> whose children should be checked.&nbsp; Default is <a href="#mxGraph.defaultParent" class=LVariable id=link1415 onMouseOver="ShowTip(event, 'tt74', 'link1415')" onMouseOut="HideTip('tt74')">defaultParent</a>.</td></tr><tr><td class=CDLEntry>rightHalfpane</td><td class=CDLDescription>Boolean indicating if the cells in the right halfpane from the origin should be returned.</td></tr><tr><td class=CDLEntry>bottomHalfpane</td><td class=CDLDescription>Boolean indicating if the cells in the bottom halfpane from the origin should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.findTreeRoots"></a>findTreeRoots</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.findTreeRoots = function(</td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>isolate,</td></tr><tr><td></td><td class=PParameter nowrap>invert</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns all children in the given parent which do not have incoming edges.&nbsp; If the result is empty then the with the greatest difference between incoming and outgoing edges is returned.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>parent</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1416 onMouseOver="ShowTip(event, 'tt244', 'link1416')" onMouseOut="HideTip('tt244')">mxCell</a> whose children should be checked.</td></tr><tr><td class=CDLEntry>isolate</td><td class=CDLDescription>Optional boolean that specifies if edges should be ignored if the opposite end is not a child of the given parent cell.&nbsp; Default is false.</td></tr><tr><td class=CDLEntry>invert</td><td class=CDLDescription>Optional boolean that specifies if outgoing or incoming edges should be counted for a tree root.&nbsp; If false then outgoing edges will be counted.&nbsp; Default is false.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.traverse"></a>traverse</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.traverse = function(</td><td class=PParameter nowrap>vertex,</td></tr><tr><td></td><td class=PParameter nowrap>directed,</td></tr><tr><td></td><td class=PParameter nowrap>func,</td></tr><tr><td></td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>visited</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Traverses the (directed) graph invoking the given function for each visited vertex and edge.&nbsp; The function is invoked with the current vertex and the incoming edge as a parameter.&nbsp; This implementation makes sure each vertex is only visited once.&nbsp; The function may return false if the traversal should stop at the given vertex.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">mxLog.show();
var cell = graph.getSelectionCell();
graph.traverse(cell, false, function(vertex, edge)
{
mxLog.debug(graph.getLabel(vertex));
2015-04-23 20:18:31 +00:00
});</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>vertex</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1417 onMouseOver="ShowTip(event, 'tt244', 'link1417')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the vertex where the traversal starts.</td></tr><tr><td class=CDLEntry>directed</td><td class=CDLDescription>Optional boolean indicating if edges should only be traversed from source to target.&nbsp; Default is true.</td></tr><tr><td class=CDLEntry>func</td><td class=CDLDescription>Visitor function that takes the current vertex and the incoming edge as arguments.&nbsp; The traversal stops if the function returns false.</td></tr><tr><td class=CDLEntry>edge</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1418 onMouseOver="ShowTip(event, 'tt244', 'link1418')" onMouseOut="HideTip('tt244')">mxCell</a> that represents the incoming edge.&nbsp; This is null for the first step of the traversal.</td></tr><tr><td class=CDLEntry>visited</td><td class=CDLDescription>Optional array of cell paths for the visited cells.</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="mxGraph.Selection"></a>Selection</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellSelected"></a>isCellSelected</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isCellSelected = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is selected.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1419 onMouseOver="ShowTip(event, 'tt244', 'link1419')" onMouseOut="HideTip('tt244')">mxCell</a> for which the selection state should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isSelectionEmpty"></a>isSelectionEmpty</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.isSelectionEmpty = function()</td></tr></table></blockquote><p>Returns true if the selection is empty.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.clearSelection"></a>clearSelection</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.clearSelection = function()</td></tr></table></blockquote><p>Clears the selection using <a href="mxGraphSelectionModel-js.html#mxGraphSelectionModel.clear" class=LFunction id=link1420 onMouseOver="ShowTip(event, 'tt466', 'link1420')" onMouseOut="HideTip('tt466')">mxGraphSelectionModel.clear</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getSelectionCount"></a>getSelectionCount</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getSelectionCount = function()</td></tr></table></blockquote><p>Returns the number of selected cells.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getSelectionCell"></a>getSelectionCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getSelectionCell = function()</td></tr></table></blockquote><p>Returns the first cell from the array of selected <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1421 onMouseOver="ShowTip(event, 'tt244', 'link1421')" onMouseOut="HideTip('tt244')">mxCells</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getSelectionCells"></a>getSelectionCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.getSelectionCells = function()</td></tr></table></blockquote><p>Returns the array of selected <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1422 onMouseOver="ShowTip(event, 'tt244', 'link1422')" onMouseOut="HideTip('tt244')">mxCells</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setSelectionCell"></a>setSelectionCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setSelectionCell = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the selection cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1423 onMouseOver="ShowTip(event, 'tt244', 'link1423')" onMouseOut="HideTip('tt244')">mxCell</a> to be selected.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setSelectionCells"></a>setSelectionCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.setSelectionCells = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the selection cell.</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=link1424 onMouseOver="ShowTip(event, 'tt244', 'link1424')" onMouseOut="HideTip('tt244')">mxCells</a> to be selected.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.addSelectionCell"></a>addSelectionCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.addSelectionCell = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the given cell to the selection.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1425 onMouseOver="ShowTip(event, 'tt244', 'link1425')" onMouseOut="HideTip('tt244')">mxCell</a> to be add to the selection.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.addSelectionCells"></a>addSelectionCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.addSelectionCells = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the given cells to the selection.</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=link1426 onMouseOver="ShowTip(event, 'tt244', 'link1426')" onMouseOut="HideTip('tt244')">mxCells</a> to be added to the selection.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.removeSelectionCell"></a>removeSelectionCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.removeSelectionCell = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes the given cell from the selection.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1427 onMouseOver="ShowTip(event, 'tt244', 'link1427')" onMouseOut="HideTip('tt244')">mxCell</a> to be removed from the selection.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.removeSelectionCells"></a>removeSelectionCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.removeSelectionCells = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes the given cells from the selection.</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=link1428 onMouseOver="ShowTip(event, 'tt244', 'link1428')" onMouseOut="HideTip('tt244')">mxCells</a> to be removed from the selection.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectRegion"></a>selectRegion</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.selectRegion = function(</td><td class=PParameter nowrap>rect,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Selects and returns the cells inside the given rectangle for the specified event.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>rect</td><td class=CDLDescription><a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link1429 onMouseOver="ShowTip(event, 'tt133', 'link1429')" onMouseOut="HideTip('tt133')">mxRectangle</a> that represents the region to be selected.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mouseevent that triggered the selection.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectNextCell"></a>selectNextCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.selectNextCell = function()</td></tr></table></blockquote><p>Selects the next cell.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectPreviousCell"></a>selectPreviousCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.selectPreviousCell = function()</td></tr></table></blockquote><p>Selects the previous cell.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectParentCell"></a>selectParentCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.selectParentCell = function()</td></tr></table></blockquote><p>Selects the parent cell.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectChildCell"></a>selectChildCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.selectChildCell = function()</td></tr></table></blockquote><p>Selects the first child cell.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectCell"></a>selectCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.selectCell = function(</td><td class=PParameter nowrap>isNext,</td></tr><tr><td></td><td class=PParameter nowrap>isParent,</td></tr><tr><td></td><td class=PParameter nowrap>isChild</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Selects the next, parent, first child or previous cell, if all arguments are false.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>isNext</td><td class=CDLDescription>Boolean indicating if the next cell should be selected.</td></tr><tr><td class=CDLEntry>isParent</td><td class=CDLDescription>Boolean indicating if the parent cell should be selected.</td></tr><tr><td class=CDLEntry>isChild</td><td class=CDLDescription>Boolean indicating if the first child cell should be selected.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectAll"></a>selectAll</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.selectAll = function(</td><td class=PParameter nowrap>parent</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Selects all children of the given parent cell or the children of the default parent if no parent is specified.&nbsp; To select leaf vertices and/or edges use <a href="#mxGraph.selectCells" class=LFunction id=link1430 onMouseOver="ShowTip(event, 'tt484', 'link1430')" onMouseOut="HideTip('tt484')">selectCells</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>parent</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1431 onMouseOver="ShowTip(event, 'tt244', 'link1431')" onMouseOut="HideTip('tt244')">mxCell</a> whose children should be selected.&nbsp; Default is <a href="#mxGraph.defaultParent" class=LVariable id=link1432 onMouseOver="ShowTip(event, 'tt74', 'link1432')" onMouseOut="HideTip('tt74')">defaultParent</a>.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectVertices"></a>selectVertices</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.selectVertices = function(</td><td class=PParameter nowrap>parent</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Select all vertices inside the given parent or the default parent.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectVertices"></a>selectVertices</h3><div class=CBody><p>Select all vertices inside the given parent or the default parent.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectCells"></a>selectCells</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.selectCells = function(</td><td class=PParameter nowrap>vertices,</td></tr><tr><td></td><td class=PParameter nowrap>edges,</td></tr><tr><td></td><td class=PParameter nowrap>parent</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Selects all vertices and/or edges depending on the given boolean arguments recursively, starting at the given parent or the default parent if no parent is specified.&nbsp; Use <a href="#mxGraph.selectAll" class=LFunction id=link1433 onMouseOver="ShowTip(event, 'tt482', 'link1433')" onMouseOut="HideTip('tt482')">selectAll</a> to select all cells.&nbsp; For vertices, only cells with no children are selected.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>vertices</td><td class=CDLDescription>Boolean indicating if vertices should be selected.</td></tr><tr><td class=CDLEntry>edges</td><td class=CDLDescription>Boolean indicating if edges should be selected.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1434 onMouseOver="ShowTip(event, 'tt244', 'link1434')" onMouseOut="HideTip('tt244')">mxCell</a> that acts as the root of the recursion.&nbsp; Default is <a href="#mxGraph.defaultParent" class=LVariable id=link1435 onMouseOver="ShowTip(event, 'tt74', 'link1435')" onMouseOut="HideTip('tt74')">defaultParent</a>.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectCellForEvent"></a>selectCellForEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.selectCellForEvent = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Selects the given cell by either adding it to the selection or replacing the selection depending on whether the given mouse event is a toggle event.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link1436 onMouseOver="ShowTip(event, 'tt244', 'link1436')" onMouseOut="HideTip('tt244')">mxCell</a> to be selected.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Optional mouseevent that triggered the selection.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.selectCellsForEvent"></a>selectCellsForEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.selectCellsForEvent = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Selects the given cells by either adding them to the selection or replacing the selection depending on whether the given mouse event is a toggle event.</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=link1437 onMouseOver="ShowTip(event, 'tt244', 'link1437')" onMouseOut="HideTip('tt244')">mxCells</a> to be selected.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Optional mouseevent that triggered the selection.</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="mxGraph.Selection_state"></a>Selection state</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createHandler"></a>createHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.createHandler = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates a new handler for the given cell state.&nbsp; This implementation returns a new <a href="../handler/mxEdgeHandler-js.html#mxEdgeHandler" class=LClass id=link1438 onMouseOver="ShowTip(event, 'tt491', 'link1438')" onMouseOut="HideTip('tt491')">mxEdgeHandler</a> of the corresponding cell is an edge, otherwise it returns an <a href="../handler/mxVertexHandler-js.html#mxVertexHandler" class=LClass id=link1439 onMouseOver="ShowTip(event, 'tt489', 'link1439')" onMouseOut="HideTip('tt489')">mxVertexHandler</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1440 onMouseOver="ShowTip(event, 'tt44', 'link1440')" onMouseOut="HideTip('tt44')">mxCellState</a> whose handler should be created.</td></tr></table></div></div></div>
2014-11-10 09:02:21 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createVertexHandler"></a>createVertexHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.createVertexHandler = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hooks to create a new <a href="../handler/mxVertexHandler-js.html#mxVertexHandler" class=LClass id=link1441 onMouseOver="ShowTip(event, 'tt489', 'link1441')" onMouseOut="HideTip('tt489')">mxVertexHandler</a> for the given <a href="mxCellState-js.html#mxCellState" class=LClass id=link1442 onMouseOver="ShowTip(event, 'tt44', 'link1442')" onMouseOut="HideTip('tt44')">mxCellState</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1443 onMouseOver="ShowTip(event, 'tt44', 'link1443')" onMouseOut="HideTip('tt44')">mxCellState</a> to create the handler for.</td></tr></table></div></div></div>
2014-11-10 09:02:21 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createEdgeHandler"></a>createEdgeHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.createEdgeHandler = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hooks to create a new <a href="../handler/mxEdgeHandler-js.html#mxEdgeHandler" class=LClass id=link1444 onMouseOver="ShowTip(event, 'tt491', 'link1444')" onMouseOut="HideTip('tt491')">mxEdgeHandler</a> for the given <a href="mxCellState-js.html#mxCellState" class=LClass id=link1445 onMouseOver="ShowTip(event, 'tt44', 'link1445')" onMouseOut="HideTip('tt44')">mxCellState</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1446 onMouseOver="ShowTip(event, 'tt44', 'link1446')" onMouseOut="HideTip('tt44')">mxCellState</a> to create the handler for.</td></tr></table></div></div></div>
2014-11-10 09:02:21 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createEdgeSegmentHandler"></a>createEdgeSegmentHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.createEdgeSegmentHandler = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hooks to create a new &lt;mxEdgeSegmentHandler&gt; for the given <a href="mxCellState-js.html#mxCellState" class=LClass id=link1447 onMouseOver="ShowTip(event, 'tt44', 'link1447')" onMouseOut="HideTip('tt44')">mxCellState</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1448 onMouseOver="ShowTip(event, 'tt44', 'link1448')" onMouseOut="HideTip('tt44')">mxCellState</a> to create the handler for.</td></tr></table></div></div></div>
2014-11-10 09:02:21 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createElbowEdgeHandler"></a>createElbowEdgeHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.createElbowEdgeHandler = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hooks to create a new <a href="../handler/mxElbowEdgeHandler-js.html#mxElbowEdgeHandler" class=LClass id=link1449 onMouseOver="ShowTip(event, 'tt494', 'link1449')" onMouseOut="HideTip('tt494')">mxElbowEdgeHandler</a> for the given <a href="mxCellState-js.html#mxCellState" class=LClass id=link1450 onMouseOver="ShowTip(event, 'tt44', 'link1450')" onMouseOut="HideTip('tt44')">mxCellState</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link1451 onMouseOver="ShowTip(event, 'tt44', 'link1451')" onMouseOut="HideTip('tt44')">mxCellState</a> to create the handler for.</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="mxGraph.Graph_events"></a>Graph events</h3></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.addMouseListener"></a>addMouseListener</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.addMouseListener = function(</td><td class=PParameter nowrap>listener</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds a listener to the graph event dispatch loop.&nbsp; The listener must implement the mouseDown, mouseMove and mouseUp methods as shown in the <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link1452 onMouseOver="ShowTip(event, 'tt222', 'link1452')" onMouseOut="HideTip('tt222')">mxMouseEvent</a> class.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>listener</td><td class=CDLDescription>Listener to be added to the graph event listeners.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.removeMouseListener"></a>removeMouseListener</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.removeMouseListener = function(</td><td class=PParameter nowrap>listener</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes the specified graph listener.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>listener</td><td class=CDLDescription>Listener to be removed from the graph event listeners.</td></tr></table></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.updateMouseEvent"></a>updateMouseEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.updateMouseEvent = function(</td><td class=PParameter nowrap>me,</td></tr><tr><td></td><td class=PParameter nowrap>evtName</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the graphX and graphY properties if the given <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link1453 onMouseOver="ShowTip(event, 'tt222', 'link1453')" onMouseOut="HideTip('tt222')">mxMouseEvent</a> if required and returned the event.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>me</td><td class=CDLDescription><a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link1454 onMouseOver="ShowTip(event, 'tt222', 'link1454')" onMouseOut="HideTip('tt222')">mxMouseEvent</a> to be updated.</td></tr><tr><td class=CDLEntry>evtName</td><td class=CDLDescription>Name of the mouse event.</td></tr></table></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getStateForEvent"></a>getStateForEvent</h3><div class=CBody><p>Returns the state for the given touch event.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isEventIgnored"></a>isEventIgnored</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isEventIgnored = function(</td><td class=PParameter nowrap>evtName,</td></tr><tr><td></td><td class=PParameter nowrap>me,</td></tr><tr><td></td><td class=PParameter nowrap>sender</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the event should be ignored in <a href="#mxGraph.fireMouseEvent" class=LFunction id=link1455 onMouseOver="ShowTip(event, 'tt28', 'link1455')" onMouseOut="HideTip('tt28')">fireMouseEvent</a>.</p></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isSyntheticEventIgnored"></a>isSyntheticEventIgnored</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isSyntheticEventIgnored = function(</td><td class=PParameter nowrap>evtName,</td></tr><tr><td></td><td class=PParameter nowrap>me,</td></tr><tr><td></td><td class=PParameter nowrap>sender</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hook for ignoring synthetic mouse events after touchend in Firefox.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isEventSourceIgnored"></a>isEventSourceIgnored</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.isEventSourceIgnored = function(</td><td class=PParameter nowrap>evtName,</td></tr><tr><td></td><td class=PParameter nowrap>me</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the event should be ignored in <a href="#mxGraph.fireMouseEvent" class=LFunction id=link1456 onMouseOver="ShowTip(event, 'tt28', 'link1456')" onMouseOut="HideTip('tt28')">fireMouseEvent</a>.&nbsp; This implementation returns true for select, option and input (if not of type checkbox, radio, button, submit or file) event sources if the event is not a mouse event or a left mouse button press event.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>evtName</td><td class=CDLDescription>The name of the event.</td></tr><tr><td class=CDLEntry>me</td><td class=CDLDescription><a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link1457 onMouseOver="ShowTip(event, 'tt222', 'link1457')" onMouseOut="HideTip('tt222')">mxMouseEvent</a> that should be ignored.</td></tr></table></div></div></div>
2013-10-28 08:56:36 +00:00
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getEventState"></a>getEventState</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.getEventState = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the <a href="mxCellState-js.html#mxCellState" class=LClass id=link1458 onMouseOver="ShowTip(event, 'tt44', 'link1458')" onMouseOut="HideTip('tt44')">mxCellState</a> to be used when firing the mouse event for the given state.&nbsp; This implementation returns the given state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&lt;mxCellState&gt;</td><td class=CDLDescription>State whose event source should be returned.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.fireMouseEvent"></a>fireMouseEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.fireMouseEvent = function(</td><td class=PParameter nowrap>evtName,</td></tr><tr><td></td><td class=PParameter nowrap>me,</td></tr><tr><td></td><td class=PParameter nowrap>sender</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Dispatches the given event in the graph event dispatch loop.&nbsp; Possible event names are <a href="../util/mxEvent-js.html#mxEvent.MOUSE_DOWN" class=LVariable id=link1459 onMouseOver="ShowTip(event, 'tt575', 'link1459')" onMouseOut="HideTip('tt575')">mxEvent.MOUSE_DOWN</a>, <a href="../util/mxEvent-js.html#mxEvent.MOUSE_MOVE" class=LVariable id=link1460 onMouseOver="ShowTip(event, 'tt576', 'link1460')" onMouseOut="HideTip('tt576')">mxEvent.MOUSE_MOVE</a> and <a href="../util/mxEvent-js.html#mxEvent.MOUSE_UP" class=LVariable id=link1461 onMouseOver="ShowTip(event, 'tt577', 'link1461')" onMouseOut="HideTip('tt577')">mxEvent.MOUSE_UP</a>.&nbsp; All listeners are invoked for all events regardless of the consumed state of the event.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>evtName</td><td class=CDLDescription>String that specifies the type of event to be dispatched.</td></tr><tr><td class=CDLEntry>me</td><td class=CDLDescription><a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link1462 onMouseOver="ShowTip(event, 'tt222', 'link1462')" onMouseOut="HideTip('tt222')">mxMouseEvent</a> to be fired.</td></tr><tr><td class=CDLEntry>sender</td><td class=CDLDescription>Optional sender argument.&nbsp; Default is this.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2014-05-15 19:58:36 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.consumeMouseEvent"></a>consumeMouseEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.consumeMouseEvent = function(</td><td class=PParameter nowrap>evtName,</td></tr><tr><td></td><td class=PParameter nowrap>me,</td></tr><tr><td></td><td class=PParameter nowrap>sender</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Destroys the graph and all its resources.</p></div></div></div>
2015-04-23 20:18:31 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.fireGestureEvent"></a>fireGestureEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.fireGestureEvent = function(</td><td class=PParameter nowrap>evt,</td></tr><tr><td></td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Dispatches a <a href="#mxGraph.mxEvent.GESTURE" class=LEvent id=link1463 onMouseOver="ShowTip(event, 'tt503', 'link1463')" onMouseOut="HideTip('tt503')">mxEvent.GESTURE</a> event.&nbsp; The following example will resize the cell under the mouse based on the scale property of the native touch event.</p><blockquote><pre class="prettyprint">graph.addListener(mxEvent.GESTURE, function(sender, eo)
2013-06-28 19:07:06 +00:00
{
var evt = eo.getProperty('event');
var state = graph.view.getState(eo.getProperty('cell'));
if (graph.isEnabled() &amp;&amp; graph.isCellResizable(state.cell) &amp;&amp; Math.abs(1 - evt.scale) &gt; 0.2)
{
var scale = graph.view.scale;
var tr = graph.view.translate;
var w = state.width * evt.scale;
var h = state.height * evt.scale;
var x = state.x - (w - state.width) / 2;
var y = state.y - (h - state.height) / 2;
var bounds = new mxRectangle(graph.snap(x / scale) - tr.x,
graph.snap(y / scale) - tr.y, graph.snap(w / scale), graph.snap(h / scale));
graph.resizeCell(state.cell, bounds);
eo.consume();
}
2015-04-23 20:18:31 +00:00
});</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Gestureend event that represents the gesture.</td></tr><tr><td class=CDLEntry>cell</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link1464 onMouseOver="ShowTip(event, 'tt244', 'link1464')" onMouseOut="HideTip('tt244')">mxCell</a> associated with the gesture.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.destroy"></a>destroy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.destroy = function()</td></tr></table></blockquote><p>Destroys the graph and all its resources.</p></div></div></div>
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
2015-05-19 09:06:55 +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="../handler/mxCellHighlight-js.html">mxCellHighlight</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxCellMarker-js.html">mxCellMarker</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxCellTracker-js.html">mxCellTracker</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxConnectionHandler-js.html">mxConnectionHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxConstraintHandler-js.html">mxConstraintHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxEdgeHandler-js.html">mxEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxEdgeSegmentHandler-js.html">mxEdgeSegmentHandler.js</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxElbowEdgeHandler-js.html">mxElbowEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxGraphHandler-js.html">mxGraphHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxHandle-js.html">mxHandle</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxKeyHandler-js.html">mxKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxPanningHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxPopupMenuHandler-js.html">mxPopupMenuHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxRubberband-js.html">mxRubberband</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxSelectionCellsHandler-js.html">mxSelectionCellsHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxTooltipHandler-js.html">mxTooltipHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/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></di
2012-05-21 20:32:26 +00:00
var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Cookies">Cookies</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([11], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
2015-04-23 20:18:31 +00:00
<div class=CToolTip id="tt1"><div class=CClass>Base class for objects that dispatch named events. </div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.alignCells = function(</td><td class=PParameter nowrap>align,</td></tr><tr><td></td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>param</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Aligns the given cells vertically or horizontally according to the given alignment using the optional parameter as the coordinate.</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.flipEdge = function(</td><td class=PParameter nowrap>edge</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Toggles the style of the given edge between null (or empty) and alternateEdgeStyle. </div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.orderCells = function(</td><td class=PParameter nowrap>back,</td></tr><tr><td></td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Moves the given cells to the front or back. </div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.cellsOrdered = function(</td><td class=PParameter nowrap>cells,</td></tr><tr><td></td><td class=PParameter nowrap>back</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Moves the given cells to the front or back. </div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.groupCells = function(</td><td class=PParameter nowrap>group,</td></tr><tr><td></td><td class=PParameter nowrap>border,</td></tr><tr><td></td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Adds the cells into the given group. </div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.ungroupCells = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Ungroups the given cells by moving the children the children to their parents parent and removing the empty groups. </div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.removeCellsFromParent = function(</td><td class=PParameter nowrap>cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Removes the specified cells from their parents and adds them to the default parent. </div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.addCel
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>