zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/docs/php-api/index/Functions.html

42 lines
49 KiB
HTML
Raw Normal View History

Initial version, 1.10.0.5 release
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>Function Index</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="IndexPage" onLoad="NDOnLoad()"><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=Index><div class=IPageTitle>Function Index</div><div class=INavigationBar>$#! &middot; 0-9 &middot; <a href="#A">A</a> &middot; <a href="#B">B</a> &middot; <a href="#C">C</a> &middot; <a href="Functions2.html#D">D</a> &middot; <a href="Functions3.html#E">E</a> &middot; <a href="Functions3.html#F">F</a> &middot; <a href="Functions4.html#G">G</a> &middot; H &middot; <a href="Functions5.html#I">I</a> &middot; J &middot; K &middot; <a href="Functions5.html#L">L</a> &middot; <a href="Functions5.html#M">M</a> &middot; N &middot; <a href="Functions5.html#O">O</a> &middot; <a href="Functions6.html#P">P</a> &middot; Q &middot; <a href="Functions6.html#R">R</a> &middot; <a href="Functions6.html#S">S</a> &middot; <a href="Functions7.html#T">T</a> &middot; <a href="Functions7.html#U">U</a> &middot; <a href="Functions7.html#V">V</a> &middot; <a href="Functions7.html#W">W</a> &middot; X &middot; Y &middot; Z</div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="A"></a>A</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><span class=ISymbol>add</span><div class=ISubIndex><a href="../files/model/mxGraphModel-php.html#mxGraphModel.add" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')" class=IParent>mxGraphModel</a><a href="../files/util/mxRectangle-php.html#mxRectangle.add" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')" class=IParent>mxRectangle</a></div></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/io/mxCodecRegistry-php.html#mxCodecRegistry.addAlias" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')" class=ISymbol>addAlias</a>, <span class=IParent>mxCodecRegistry</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraph-php.html#mxGraph.addBundle" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')" class=ISymbol>addBundle</a>, <span class=IParent>mxGraph</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/util/mxEventSource-php.html#mxEventSource.addListener" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')" class=ISymbol>addListener</a>, <span class=IParent>mxEventSource</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/util/mxLog-php.html#mxLog.addLogfile" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')" class=ISymbol>addLogfile</a>, <span class=IParent>mxLog</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/io/mxObjectCodec-php.html#mxObjectCodec.addObjectValue" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')" class=ISymbol>addObjectValue</a>, <span class=IParent>mxObjectCodec</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/util/mxUtils-php.html#mxUtils.addStylename" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')" class=ISymbol>addStylename</a>, <span class=IParent>mxUtils</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/io/mxObjectCodec-php.html#mxObjectCodec.afterDecode" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')" class=ISymbol>afterDecode</a>, <span class=IParent>mxObjectCodec</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/io/mxObjectCodec-php.html#mxObjectCodec.afterEncode" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')" class=ISymbol>afterEncode</a>, <span class=IParent>mxObjectCodec</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><span class=ISymbol>apply</span><div class=ISubIndex><a href="../files/view/mxEdgeStyle-php.html#mxEdgeStyleFunction.apply" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')"
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><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>function add(</td><td class=PParameter nowrap>$parent,</td><td class=PDefaultValuePrefix>&nbsp;&nbsp;</td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$child,</td><td class=PDefaultValuePrefix>&nbsp;&nbsp;</td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$index</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%> null</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Adds the specified child to the parent at the given index using mxChildChange and adds the change to the current transaction. </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>function add(</td><td class=PParameter nowrap>$rect</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Adds the given rectangle to this rectangle.</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>static function addAlias(</td><td class=PParameter nowrap>$classname,</td></tr><tr><td></td><td class=PParameter nowrap>$codecname</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Adds an alias for mapping a classname to a codecname.</div></div><div class=CToolTip id="tt4"><div class=CFunction>Adds the specified mxImageBundle.</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>function addListener(</td><td class=PParameter nowrap>$name,</td></tr><tr><td></td><td class=PParameter nowrap>$listener</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Adds a listener for the given event name. </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>static function addLogfile(</td><td class=PParameter nowrap>$filename</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Adds a file for logging.</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>function addObjectValue(</td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$obj,</td></tr><tr><td></td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap>$fieldname,</td></tr><tr><td></td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap>$value,</td></tr><tr><td></td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap>$template</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the decoded child node as a value of the given object. </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>static function addStylename(</td><td class=PParameter nowrap>$style,</td></tr><tr><td></td><td class=PParameter nowrap>$stylename</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Adds the specified stylename
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt13"><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>function beforeDecode(</td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap>$dec,</td></tr><tr><td></td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap>$node,</td></tr><tr><td></td><td class=PParameterPrefix nowrap>&amp;</td><td class=PParameter nowrap>$obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Hook for subclassers to pre-process the node for the specified object and return the node to be used for further processing by decode. </div></div><div class=CToolTip id="tt14"><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>function beforeEncode(</td><td class=PParameter nowrap>$enc,</td></tr><tr><td></td><td class=PParameter nowrap>$obj,</td></tr><tr><td></td><td class=PParameter nowrap>$node</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Hook for subclassers to pre-process the object before encoding. </div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>function beginUpdate()</td></tr></table></blockquote>Increments the updateLevel by one. </div></div><!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt16"><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>function cellAdded(</td><td class=PParameter nowrap>$cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Inner callback to update cells when a cell has been added. </div></div><div class=CToolTip id="tt17"><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>function cellCloned(</td><td class=PParameter nowrap>$cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Hook for cloning the cell. </div></div><div class=CToolTip id="tt18"><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>function cellRemoved(</td><td class=PParameter nowrap>$cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Inner callback to update cells when a cell has been removed.</div></div><div class=CToolTip id="tt19"><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>function childMoved(</td><td class=PParameter nowrap>$parent,</td></tr><tr><td></td><td class=PParameter nowrap>$child</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Invoked when a child state was moved as a result of late evaluation of its position. </div></div><div class=CToolTip id="tt20"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>function clear()</td></tr></table></blockquote>Sets a new root using createRoot.</div></div><div class=CToolTip id="tt21"><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>function cloneCell(</td><td class=PParameter nowrap>$cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns a deep clone of the given mxCell (including the children) which is created using cloneCells.</div></div><div class=CToolTip id="tt22"><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>function cloneCellImpl(</td><td class=PParameter nowrap>$cell,</td></tr><tr><td></td><td class=PParameter nowrap>$mapping,</td></tr><tr><td></td><td class=PParameter nowrap>$includeChildren</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Inner helper method for cloning cells recursively.</div></div><div class=CToolTip id="tt23"><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>function cloneCells(</td><td class=PParameter nowrap>$cells,</td><td class=PDefaultValuePrefix>&nbsp;&nbsp;</td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$includeChildren</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%>true</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns an array of clones for the given array of mxCells. </div></div><div class=CToolTip id="tt24"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>function cloneTemplate()</td></tr></table></blockquote>Creates a new instance of the template for this codec.</div></div><div
</div><!--Index-->
<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="../files/index-txt.html">API Specification</a></div></div><div class=MEntry><div class=MFile><a href="../files/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="../files/io/mxCellCodec-php.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxCodec-php.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxCodecRegistry-php.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxModelCodec-php.html">mxModelCodec</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxObjectCodec-php.html">mxObjectCodec</a></div></div><div class=MEntry><div class=MFile><a href="../files/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="../files/model/mxCell-php.html">mxCell</a></div></div><div class=MEntry><div class=MFile><a href="../files/model/mxCellPath-php.html">mxCellPath</a></div></div><div class=MEntry><div class=MFile><a href="../files/model/mxGeometry-php.html">mxGeometry</a></div></div><div class=MEntry><div class=MFile><a href="../files/model/mxGraphModel-php.html">mxGraphModel</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../files/reader/mxGraphViewHtmlReader-php.html">mxGraphViewHtmlReader</a></div></div><div class=MEntry><div class=MFile><a href="../files/reader/mxGraphViewImageReader-php.html">mxGraphViewImageReader</a></div></div><div class=MEntry><div class=MFile><a href="../files/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="../files/util/mxConstants-php.html">mxConstants</a></div></div><div class=MEntry><div class=MFile><a href="../files/util/mxEvent-php.html">mxEvent</a></div></div><div class=MEntry><div class=MFile><a href="../files/util/mxEventObject-php.html">mxEventObject</a></div></div><div class=MEntry><div class=MFile><a href="../files/util/mxEventSource-php.html">mxEventSource</a></div></div><div class=MEntry><div class=MFile><a href="../files/util/mxImageBundle-php.html">mxImageBundle</a></div></div><div class=MEntry><div class=MFile><a href="../files/util/mxLog-php.html">mxLog</a></div></div><div class=MEntry><div class=MFile><a href="../files/util/mxPoint-php.html">mxPoint</a></div></div><div class=MEntry><div class=MFile><a href="../files/util/mxRectangle-php.html">mxRectangle</a></div></div><div class=MEntry><div class=MFile><a href="../files/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="../files/view/mxCellState-php.html">mxCellState</a></div></div><div class=MEntry><div class=MFile><a href="../files/view/mxConnectionConstraint-php.html">mxConnectionConstraint</a></div></div><div class=MEntry><div class=MFile><a href="../files/view/mxEdgeStyle-php.html">mxEdgeStyleFunction</a></div></div><div class=MEntry><div class=MFile><a href="../files/view/mxGraph-php.html">mxGraph</a></div></div><div class=MEntry><div class=MFile><a href="../files/view/mxGraphView-php.html">mxGraphView</a></div></div><div class=MEntry><div class=MFile><a href="../files/view/mxPerimeter-php.html">mxPerimeterFunction</a></div></div><div class=MEntry><div class=MFile><a href="../files/view/mxStyleRegistry-php.html">mxStyleRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../files/view/mxStylesheet-php.html">mxStyleshe
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([5, 4], 6);// --></script></div><!--Menu-->
<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>