137 lines
87 KiB
HTML
137 lines
87 KiB
HTML
|
<!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 -->
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxGraph"></a>mxGraph</h1><div class=CBody><p>Implements a graph component.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#mxGraph" >mxGraph</a></td><td class=SDescription>Implements a graph component.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraph.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraph.model" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">model</a></td><td class=SDescription>Holds the <a href="#mxGraph.mxGraphModel" class=LFunction id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">mxGraphModel</a>.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxGraph.stylesheet" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">stylesheet</a></td><td class=SDescription>Holds the <a href="mxStylesheet-php.html#mxStylesheet" class=LClass id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">mxStylesheet</a>.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraph.view" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">view</a></td><td class=SDescription>Holds the <a href="mxGraphView-php.html#mxGraphView" class=LClass id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">mxGraphView</a>.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxGraph.gridSize" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">gridSize</a></td><td class=SDescription>Specifies the grid size. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraph.labelsVisible" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">labelsVisible</a></td><td class=SDescription>Specifies if labels should be visible. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxGraph.defaultLoopStyle" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">defaultLoopStyle</a></td><td class=SDescription><a href="mxEdgeStyle-php.html#mxEdgeStyle" class=LClass id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">mxEdgeStyle</a> to be used for loops. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraph.imageBundles" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">imageBundles</a></td><td class=SDescription>Holds the list of image bundles.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraph.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxGraph.mxGraphModel" >mxGraphModel</a></td><td class=SDescription>Constructs a new graph model using the specified root cell.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxGraph.createStylesheet" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">createStylesheet</a></td><td class=SDescription>Creates a new <a href="mxStylesheet-php.html#mxStylesheet" class=LClass id=link13 onMouseOver="ShowTip(event, 'tt4', 'link13')" onMouseOut="HideTip('tt4')">mxStylesheet</a> to be used in this graph.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxGraph.createGraphView" id=link14 onMouseOver="ShowTip(event, 'tt13', 'link14')" onMouseOut="HideTip('tt13')">createGraphView</a></td><td class=SDescription>Creates a new <a href="mxGraphView-php.html#mxGraphView" class=LClass id=link15 onMouseOver="ShowTip(event, 'tt6', 'link15')" onMouseOut="HideTip('tt6')">mxGraphView</a> to be used in this graph.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a hr
|
||
|
|
||
|
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraph.Variables"></a>Variables</h3></div></div>
|
||
|
|
||
|
<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>var $model</td></tr></table></blockquote><p>Holds the <a href="#mxGraph.mxGraphModel" class=LFunction id=link66 onMouseOver="ShowTip(event, 'tt2', 'link66')" onMouseOut="HideTip('tt2')">mxGraphModel</a>.</p></div></div></div>
|
||
|
|
||
|
<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>var $stylesheet</td></tr></table></blockquote><p>Holds the <a href="mxStylesheet-php.html#mxStylesheet" class=LClass id=link67 onMouseOver="ShowTip(event, 'tt4', 'link67')" onMouseOut="HideTip('tt4')">mxStylesheet</a>.</p></div></div></div>
|
||
|
|
||
|
<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>var $view</td></tr></table></blockquote><p>Holds the <a href="mxGraphView-php.html#mxGraphView" class=LClass id=link68 onMouseOver="ShowTip(event, 'tt6', 'link68')" onMouseOut="HideTip('tt6')">mxGraphView</a>.</p></div></div></div>
|
||
|
|
||
|
<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>var $gridSize</td></tr></table></blockquote><p>Specifies the grid size. Default is 10.</p></div></div></div>
|
||
|
|
||
|
<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>var $labelsVisible</td></tr></table></blockquote><p>Specifies if labels should be visible. This is used in <a href="#mxGraph.getLabel" class=LFunction id=link69 onMouseOver="ShowTip(event, 'tt21', 'link69')" onMouseOut="HideTip('tt21')">getLabel</a>. Default is true.</p></div></div></div>
|
||
|
|
||
|
<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>var $defaultLoopStyle</td></tr></table></blockquote><p><a href="mxEdgeStyle-php.html#mxEdgeStyle" class=LClass id=link70 onMouseOver="ShowTip(event, 'tt10', 'link70')" onMouseOut="HideTip('tt10')">mxEdgeStyle</a> to be used for loops. This is a fallback for loops if the <a href="../util/mxConstants-php.html#mxConstants.STYLE_LOOP" class=LVariable id=link71 onMouseOver="ShowTip(event, 'tt53', 'link71')" onMouseOut="HideTip('tt53')">mxConstants.STYLE_LOOP</a> is undefined. Default is <a href="mxEdgeStyle-php.html#mxEdgeStyle.Loop" class=LVariable id=link72 onMouseOver="ShowTip(event, 'tt54', 'link72')" onMouseOut="HideTip('tt54')">mxEdgeStyle.Loop</a>.</p></div></div></div>
|
||
|
|
||
|
<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>protected $imageBundles</td></tr></table></blockquote><p>Holds the list of image bundles.</p></div></div></div>
|
||
|
|
||
|
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraph.Functions"></a>Functions</h3></div></div>
|
||
|
|
||
|
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.mxGraphModel"></a>mxGraphModel</h3><div class=CBody><p>Constructs a new graph model using the specified root cell.</p></div></div></div>
|
||
|
|
||
|
<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>function createStylesheet()</td></tr></table></blockquote><p>Creates a new <a href="mxStylesheet-php.html#mxStylesheet" class=LClass id=link73 onMouseOver="ShowTip(event, 'tt4', 'link73')" onMouseOut="HideTip('tt4')">mxStylesheet</a> to be used in this graph.</p></div></div></div>
|
||
|
|
||
|
<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>function createGraphView()</td></tr></table></blockquote><p>Creates a new <a href="mxGraphView-php.html#mxGraphView" class=LClass id=link74 onMouseOver="ShowTip(event, 'tt6', 'link74')" onMouseOut="HideTip('tt6')">mxGraphView</a> to be used in this graph.</p></div></div></div>
|
||
|
|
||
|
<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>function getModel()</td></tr></table></blockquote><p>Returns the <a href="#mxGraph.mxGraphModel" class=LFunction id=link75 onMouseOver="ShowTip(event, 'tt2', 'link75')" onMouseOut="HideTip('tt2')">mxGraphModel</a> that contains the cells.</p></div></div></div>
|
||
|
|
||
|
<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>function getStylesheet()</td></tr></table></blockquote><p>Returns the <a href="mxStylesheet-php.html#mxStylesheet" class=LClass id=link76 onMouseOver="ShowTip(event, 'tt4', 'link76')" onMouseOut="HideTip('tt4')">mxStylesheet</a> that defines the style.</p></div></div></div>
|
||
|
|
||
|
<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>function getView()</td></tr></table></blockquote><p>Returns the <a href="mxGraphView-php.html#mxGraphView" class=LClass id=link77 onMouseOver="ShowTip(event, 'tt6', 'link77')" onMouseOut="HideTip('tt6')">mxGraphView</a> that contains the <a href="mxCellState-php.html#mxCellState" class=LClass id=link78 onMouseOver="ShowTip(event, 'tt17', 'link78')" onMouseOut="HideTip('tt17')">mxCellStates</a>.</p></div></div></div>
|
||
|
|
||
|
<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>function getDefaultParent()</td></tr></table></blockquote><p>Returns the first child child of <a href="../model/mxGraphModel-php.html#mxGraphModel.root" class=LVariable id=link79 onMouseOver="ShowTip(event, 'tt19', 'link79')" onMouseOut="HideTip('tt19')">mxGraphModel.root</a>. The value returned by this function should be used as the parent for new cells (aka default layer).</p></div></div></div>
|
||
|
|
||
|
<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>function convertValueToString(</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. This implementation returns the nodename or string-representation of the user object.</p></div></div></div>
|
||
|
|
||
|
<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>function getLabel(</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. This implementation uses <a href="#mxGraph.convertValueToString" class=LFunction id=link80 onMouseOver="ShowTip(event, 'tt20', 'link80')" onMouseOut="HideTip('tt20')">convertValueToString</a> if <a href="#mxGraph.labelsVisible" class=LVariable id=link81 onMouseOver="ShowTip(event, 'tt8', 'link81')" onMouseOut="HideTip('tt8')">labelsVisible</a> is true. Otherwise it returns an empty string.</p></div></div></div>
|
||
|
|
||
|
<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>function getChildOffsetForCell(</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. The root and layer cells may be identified using <mxGraphModel.isRoot> and <mxGraphModel.isLayer>. For all other current roots, the <mxGraphView.currentRoot> field points to the respective cell, so that the following holds: cell == this.view.currentRoot. 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-php.html#mxCell" class=LClass id=link82 onMouseOver="ShowTip(event, 'tt28', 'link82')" onMouseOut="HideTip('tt28')">mxCell</a> whose offset should be returned.</td></tr></table></div></div></div>
|
||
|
|
||
|
<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>function isOrthogonal(</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-php.html#mxCellState" class=LClass id=link83 onMouseOver="ShowTip(event, 'tt17', 'link83')" onMouseOut="HideTip('tt17')">mxCellState</a> that represents the edge.</td></tr></table></div></div></div>
|
||
|
|
||
|
<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>function isCellVisible(</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.</p></div></div></div>
|
||
|
|
||
|
<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>function isCellCollapsed(</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.</p></div></div></div>
|
||
|
|
||
|
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.isCellCollapsed"></a>isCellCollapsed</h3><div class=CBody><p>Returns true if the given cell is connectable.</p></div></div></div>
|
||
|
|
||
|
<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>function getCellGeometry(</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-php.html#mxGeometry" class=LClass id=link84 onMouseOver="ShowTip(event, 'tt27', 'link84')" onMouseOut="HideTip('tt27')">mxGeometry</a> for the given <a href="../model/mxCell-php.html#mxCell" class=LClass id=link85 onMouseOver="ShowTip(event, 'tt28', 'link85')" onMouseOut="HideTip('tt28')">mxCell</a>.</p></div></div></div>
|
||
|
|
||
|
<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>function getCellStyle(</td><td class=PParameter nowrap>$cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
|
||
|
|
||
|
<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>function postProcessCellStyle(</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>
|
||
|
|
||
|
<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>function setCellStyles(</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. This will modify the existing cell styles in-place and override any existing assignment for the given key. If no cells are specified, then the selection cells are changed. 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>Array of <a href="../model/mxCell-php.html#mxCell" class=LClass id=link86 onMouseOver="ShowTip(event, 'tt28', 'link86')" onMouseOut="HideTip('tt28')">mxCells</a> to change the style for.</td></tr></table></div></div></div>
|
||
|
|
||
|
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.addBundle"></a>addBundle</h3><div class=CBody><p>Adds the specified <a href="../util/mxImageBundle-php.html#mxImageBundle" class=LClass id=link87 onMouseOver="ShowTip(event, 'tt32', 'link87')" onMouseOut="HideTip('tt32')">mxImageBundle</a>.</p></div></div></div>
|
||
|
|
||
|
<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>function removeImageBundle(</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-php.html#mxImageBundle" class=LClass id=link88 onMouseOver="ShowTip(event, 'tt32', 'link88')" onMouseOut="HideTip('tt32')">mxImageBundle</a>.</p></div></div></div>
|
||
|
|
||
|
<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>function getImageFromBundles(</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=link89 onMouseOver="ShowTip(event, 'tt11', 'link89')" onMouseOut="HideTip('tt11')">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>
|
||
|
|
||
|
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getImageBundles"></a>getImageBundles</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>function getImageBundles()</td></tr></table></blockquote><p>Returns the <a href="#mxGraph.imageBundles" class=LVariable id=link90 onMouseOver="ShowTip(event, 'tt11', 'link90')" onMouseOut="HideTip('tt11')">imageBundles</a>.</p></div></div></div>
|
||
|
|
||
|
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.setImageBundles"></a>setImageBundles</h3><div class=CBody><blockquote><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 setImageBundles(</td><td class=PParameter nowrap>$value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the <a href="#mxGraph.imageBundles" class=LVariable id=link91 onMouseOver="ShowTip(event, 'tt11', 'link91')" onMouseOut="HideTip('tt11')">imageBundles</a>.</p></div></div></div>
|
||
|
|
||
|
<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>function insertVertex(</td><td class=PParameter nowrap>$parent,</td><td class=PDefaultValuePrefix> </td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$id</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$value</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$x</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> 0,</td></tr><tr><td></td><td class=PParameter nowrap>$y</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> 0,</td></tr><tr><td></td><td class=PParameter nowrap>$width</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> 1,</td></tr><tr><td></td><td class=PParameter nowrap>$height</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> 1,</td></tr><tr><td></td><td class=PParameter nowrap>$style</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$relative</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> false</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-php.html#mxCell" class=LClass id=link92 onMouseOver="ShowTip(event, 'tt28', 'link92')" onMouseOut="HideTip('tt28')">mxCell</a> using value as the user object and the given coordinates as the <a href="../model/mxGeometry-php.html#mxGeometry" class=LClass id=link93 onMouseOver="ShowTip(event, 'tt27', 'link93')" onMouseOut="HideTip('tt27')">mxGeometry</a> of the new vertex. The id and style are used for the respective properties of the new <a href="../model/mxCell-php.html#mxCell" class=LClass id=link94 onMouseOver="ShowTip(event, 'tt28', 'link94')" onMouseOut="HideTip('tt28')">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-php.html#mxCell" class=LClass id=link95 onMouseOver="ShowTip(event, 'tt28', 'link95')" onMouseOut="HideTip('tt28')">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. Default is false.</td></tr></table></div></div></div>
|
||
|
|
||
|
<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>function createVertex(</td><td class=PParameter nowrap>$parent,</td><td class=PDefaultValuePrefix> </td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$id</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$value</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$x</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> 0,</td></tr><tr><td></td><td class=PParameter nowrap>$y</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> 0,</td></tr><tr><td></td><td class=PParameter nowrap>$width</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> 1,</td></tr><tr><td></td><td class=PParameter nowrap>$height</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> 1,</td></tr><tr><td></td><td class=PParameter nowrap>$style</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$relative</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates the vertex to be used in insertVertex.</p></div></div></div>
|
||
|
|
||
|
<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>function insertEdge(</td><td class=PParameter nowrap>$parent,</td><td class=PDefaultValuePrefix> </td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$id</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$value</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$source</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$target</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$style</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null</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-php.html#mxCell" class=LClass id=link96 onMouseOver="ShowTip(event, 'tt28', 'link96')" onMouseOut="HideTip('tt28')">mxCell</a> using value as the user object and the given source and target as the terminals of the new edge. The id and style are used for the respective properties of the new <a href="../model/mxCell-php.html#mxCell" class=LClass id=link97 onMouseOver="ShowTip(event, 'tt28', 'link97')" onMouseOut="HideTip('tt28')">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-php.html#mxCell" class=LClass id=link98 onMouseOver="ShowTip(event, 'tt28', 'link98')" onMouseOut="HideTip('tt28')">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-php.html#mxCell" class=LClass id=link99 onMouseOver="ShowTip(event, 'tt28', 'link99')" onMouseOut="HideTip('tt28')">mxCell</a> that defines the source of the edge.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="../model/mxCell-php.html#mxCell" class=LClass id=link100 onMouseOver="ShowTip(event, 'tt28', 'link100')" onMouseOut="HideTip('tt28')">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>
|
||
|
|
||
|
<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>function createEdge(</td><td class=PParameter nowrap>$parent,</td><td class=PDefaultValuePrefix> </td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$id</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$value</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$source</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$target</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$style</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates the edge to be used in <a href="#mxGraph.insertEdge" class=LFunction id=link101 onMouseOver="ShowTip(event, 'tt39', 'link101')" onMouseOut="HideTip('tt39')">insertEdge</a>. 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>
|
||
|
|
||
|
<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>function getGraphBounds()</td></tr></table></blockquote><p>Returns the bounds of the visible graph. Shortcut to <a href="mxGraphView-php.html#mxGraphView.getGraphBounds" class=LFunction id=link102 onMouseOver="ShowTip(event, 'tt55', 'link102')" onMouseOut="HideTip('tt55')">mxGraphView.getGraphBounds</a>.</p></div></div></div>
|
||
|
|
||
|
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getBoundingBox"></a>getBoundingBox</h3><div class=CBody><blockquote><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 getBoundingBox(</td><td class=PParameter nowrap>$cell,</td><td class=PDefaultValuePrefix> </td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$includeEdges</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> false,</td></tr><tr><td></td><td class=PParameter nowrap>$includeDescendants</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bounding box of the given cell including all connected edges if includeEdge is true.</p></div></div></div>
|
||
|
|
||
|
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getPaintBounds"></a>getPaintBounds</h3><div class=CBody><blockquote><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 getPaintBounds(</td><td class=PParameter nowrap>$cells</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bounding box of the given cells and their descendants.</p></div></div></div>
|
||
|
|
||
|
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.getBoundsForCells"></a>getBoundsForCells</h3><div class=CBody><blockquote><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 getBoundsForCells(</td><td class=PParameter nowrap>$cells,</td><td class=PDefaultValuePrefix> </td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$includeEdges</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> false,</td></tr><tr><td></td><td class=PParameter nowrap>$includeDescendants</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> false,</td></tr><tr><td></td><td class=PParameter nowrap>$boundingBox</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bounds for the given cells.</p></div></div></div>
|
||
|
|
||
|
<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>function getCellBounds(</td><td class=PParameter nowrap>$cell,</td><td class=PDefaultValuePrefix> </td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$includeEdges</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> false,</td></tr><tr><td></td><td class=PParameter nowrap>$includeDescendants</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> false,</td></tr><tr><td></td><td class=PParameter nowrap>$boundingBox</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bounds of the given cell including all connected edges if includeEdge is true.</p></div></div></div>
|
||
|
|
||
|
<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>function getConnectionConstraint(</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-php.html#mxConnectionConstraint" class=LClass id=link103 onMouseOver="ShowTip(event, 'tt47', 'link103')" onMouseOut="HideTip('tt47')">mxConnectionConstraint</a> that describes the given connection point. This result can then be passed to <a href="#mxGraph.getConnectionPoint" class=LFunction id=link104 onMouseOver="ShowTip(event, 'tt48', 'link104')" onMouseOut="HideTip('tt48')">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-php.html#mxCellState" class=LClass id=link105 onMouseOver="ShowTip(event, 'tt17', 'link105')" onMouseOut="HideTip('tt17')">mxCellState</a> that represents the edge.</td></tr><tr><td class=CDLEntry>terminal</td><td class=CDLDescription><a href="mxCellState-php.html#mxCellState" class=LClass id=link106 onMouseOver="ShowTip(event, 'tt17', 'link106')" onMouseOut="HideTip('tt17')">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>
|
||
|
|
||
|
<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>function getConnectionPoint(</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-php.html#mxCellState" class=LClass id=link107 onMouseOver="ShowTip(event, 'tt17', 'link107')" onMouseOut="HideTip('tt17')">mxCellState</a> that represents the vertex.</td></tr><tr><td class=CDLEntry>constraint</td><td class=CDLDescription><a href="mxConnectionConstraint-php.html#mxConnectionConstraint" class=LClass id=link108 onMouseOver="ShowTip(event, 'tt47', 'link108')" onMouseOut="HideTip('tt47')">mxConnectionConstraint</a> that represents the connection point constraint as returned by <a href="#mxGraph.getConnectionConstraint" class=LFunction id=link109 onMouseOver="ShowTip(event, 'tt46', 'link109')" onMouseOut="HideTip('tt46')">getConnectionConstraint</a>.</td></tr></table></div></div></div>
|
||
|
|
||
|
<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>function findTreeRoots(</td><td class=PParameter nowrap>$parent,</td><td class=PDefaultValuePrefix> </td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$isolate</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> false,</td></tr><tr><td></td><td class=PParameter nowrap>$invert</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> false</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. 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-php.html#mxCell" class=LClass id=link110 onMouseOver="ShowTip(event, 'tt28', 'link110')" onMouseOut="HideTip('tt28')">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. 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. If false then outgoing edges will be counted. Default is false.</td></tr></table></div></div></div>
|
||
|
|
||
|
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.createImage"></a>createImage</h3><div class=CBody><blockquote><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 createImage(</td><td class=PParameter nowrap>$clip</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null,</td></tr><tr><td></td><td class=PParameter nowrap>$background</td><td class=PDefaultValuePrefix> = </td><td class=PDefaultValue width=100%> null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
|
||
|
|
||
|
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.drawGraph"></a>drawGraph</h3><div class=CBody><blockquote><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 drawGraph(</td><td class=PParameter nowrap>$canvas</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Draws the given cell onto the specified canvas.</p></div></div></div>
|
||
|
|
||
|
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.paintCell"></a>paintCell</h3><div class=CBody><p>Draws the given cell onto the specified canvas.</p></div></div></div>
|
||
|
|
||
|
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraph.paintState"></a>paintState</h3><div class=CBody><p>Draws the given cell and label onto the specified canvas. No children or descendants are painted.</p></div></div></div>
|
||
|
|
||
|
<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>function graphModelChanged(</td><td class=PParameter nowrap>$event</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Called when the graph model has changed.</p></div></div></div>
|
||
|
|
||
|
</div><!--Content-->
|
||
|
|
||
|
|
||
|
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
|
||
|
|
||
|
|
||
|
<div id=Menu><div class=MEntry><div class=MFile><a href="../index-txt.html">API Specification</a></div></div><div class=MEntry><div class=MFile><a href="../canvas/mxGdCanvas-php.html">canvas/<wbr>mxGdCanvas.php</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Io</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../io/mxCellCodec-php.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodec-php.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodecRegistry-php.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxModelCodec-php.html">mxModelCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxObjectCodec-php.html">mxObjectCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxStylesheetCodec-php.html">mxStylesheetCodec</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Model</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../model/mxCell-php.html">mxCell</a></div></div><div class=MEntry><div class=MFile><a href="../model/mxCellPath-php.html">mxCellPath</a></div></div><div class=MEntry><div class=MFile><a href="../model/mxGeometry-php.html">mxGeometry</a></div></div><div class=MEntry><div class=MFile><a href="../model/mxGraphModel-php.html">mxGraphModel</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../reader/mxGraphViewHtmlReader-php.html">mxGraphViewHtmlReader</a></div></div><div class=MEntry><div class=MFile><a href="../reader/mxGraphViewImageReader-php.html">mxGraphViewImageReader</a></div></div><div class=MEntry><div class=MFile><a href="../canvas/mxHtmlCanvas-php.html">mxHtmlCanvas</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Util</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../util/mxConstants-php.html">mxConstants</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxEvent-php.html">mxEvent</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxEventObject-php.html">mxEventObject</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxEventSource-php.html">mxEventSource</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxImageBundle-php.html">mxImageBundle</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxLog-php.html">mxLog</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxPoint-php.html">mxPoint</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxRectangle-php.html">mxRectangle</a></div></div><div class=MEntry><div class=MFile><a href="../util/mxUtils-php.html">mxUtils</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">View</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="mxCellState-php.html">mxCellState</a></div></div><div class=MEntry><div class=MFile><a href="mxConnectionConstraint-php.html">mxConnectionConstraint</a></div></div><div class=MEntry><div class=MFile><a href="mxEdgeStyle-php.html">mxEdgeStyleFunction</a></div></div><div class=MEntry><div class=MFile id=MSelected>mxGraph</div></div><div class=MEntry><div class=MFile><a href="mxGraphView-php.html">mxGraphView</a></div></div><div class=MEntry><div class=MFile><a href="mxPerimeter-php.html">mxPerimeterFunction</a></div></div><div class=MEntry><div class=MFile><a href="mxStyleRegistry-php.html">mxStyleRegistry</a></div></div><div class=MEntry><div class=MFile><a href="mxStylesheet-php.html">mxStylesheet</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Index</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MIndex><a href="../../index/General.html">Everything</a></div></div><di
|
||
|
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="Files">Files</option><option value="Functions">Functions</option><option value="Interfaces">Interfaces</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
|
||
|
HideAllBut([4, 5], 6);// --></script></div><!--Menu-->
|
||
|
|
||
|
|
||
|
|
||
|
<!--START_ND_TOOLTIPS-->
|
||
|
<div class=CToolTip id="tt1"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $model</td></tr></table></blockquote>Holds the mxGraphModel.</div></div><div class=CToolTip id="tt2"><div class=CFunction>Constructs a new graph model using the specified root cell.</div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $stylesheet</td></tr></table></blockquote>Holds the mxStylesheet.</div></div><div class=CToolTip id="tt4"><div class=CClass>Defines the appearance of the cells in a graph. </div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $view</td></tr></table></blockquote>Holds the mxGraphView.</div></div><div class=CToolTip id="tt6"><div class=CClass>Implements a view for the graph. </div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $gridSize</td></tr></table></blockquote>Specifies the grid size. </div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $labelsVisible</td></tr></table></blockquote>Specifies if labels should be visible. </div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $defaultLoopStyle</td></tr></table></blockquote>mxEdgeStyle to be used for loops. </div></div><div class=CToolTip id="tt10"><div class=CClass>Provides various edge styles to be used as the values for mxConstants.STYLE_EDGE in a cell style.</div></div><div class=CToolTip id="tt11"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>protected $imageBundles</td></tr></table></blockquote>Holds the list of image bundles.</div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>function createStylesheet()</td></tr></table></blockquote>Creates a new mxStylesheet to be used in this graph.</div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>function createGraphView()</td></tr></table></blockquote>Creates a new mxGraphView to be used in this graph.</div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>function getModel()</td></tr></table></blockquote>Returns the mxGraphModel that contains the cells.</div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>function getStylesheet()</td></tr></table></blockquote>Returns the mxStylesheet that defines the style.</div></div><div class=CToolTip id="tt16"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>function getView()</td></tr></table></blockquote>Returns the mxGraphView that contains the mxCellStates.</div></div><div class=CToolTip id="tt17"><div class=CClass>Represents the current state of a cell in a given mxGraphView.</div></div><div class=CToolTip id="tt18"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>function getDefaultParent()</td></tr></table></blockquote>Returns the first child child of mxGraphModel.root. </div></div><div class=CToolTip id="tt19"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $root</td></tr></table></blockquote>Holds the root cell, which in turn contains the cells that represent the layers of the diagram as child cells. </div><
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<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>
|