maxGraph/docs/php-api/index/Functions3.html

38 lines
22 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>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 -->
2015-06-23 07:48:06 +00:00
<div id=Index><div class=IPageTitle>Function Index</div><div class=INavigationBar>$#! &middot; 0-9 &middot; <a href="Functions.html#A">A</a> &middot; <a href="Functions.html#B">B</a> &middot; <a href="Functions.html#C">C</a> &middot; <a href="Functions2.html#D">D</a> &middot; <a href="#E">E</a> &middot; <a href="#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="E"></a>E</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><span class=ISymbol>encode</span><div class=ISubIndex><a href="../files/io/mxCodec-php.html#mxCodec.encode" id=link94 onMouseOver="ShowTip(event, 'tt94', 'link94')" onMouseOut="HideTip('tt94')" class=IParent>mxCodec</a><a href="../files/io/mxObjectCodec-php.html#mxObjectCodec.encode" id=link95 onMouseOver="ShowTip(event, 'tt95', 'link95')" onMouseOut="HideTip('tt95')" class=IParent>mxObjectCodec</a></div></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/io/mxCodec-php.html#mxCodec.encodeCell" id=link96 onMouseOver="ShowTip(event, 'tt96', 'link96')" onMouseOut="HideTip('tt96')" class=ISymbol>encodeCell</a>, <span class=IParent>mxCodec</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/util/mxUtils-php.html#mxUtils.encodeImage" id=link97 onMouseOver="ShowTip(event, 'tt97', 'link97')" onMouseOut="HideTip('tt97')" class=ISymbol>encodeImage</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.encodeObject" id=link98 onMouseOver="ShowTip(event, 'tt98', 'link98')" onMouseOut="HideTip('tt98')" class=ISymbol>encodeObject</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.encodeValue" id=link99 onMouseOver="ShowTip(event, 'tt99', 'link99')" onMouseOut="HideTip('tt99')" class=ISymbol>encodeValue</a>, <span class=IParent>mxObjectCodec</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/reader/mxGraphViewImageReader-php.html#mxGraphViewImageReader.endElement" id=link100 onMouseOver="ShowTip(event, 'tt100', 'link100')" onMouseOut="HideTip('tt100')" class=ISymbol>endElement</a>, <span class=IParent>mxGraphViewImageReader</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/model/mxGraphModel-php.html#mxGraphModel.endUpdate" id=link101 onMouseOver="ShowTip(event, 'tt101', 'link101')" onMouseOut="HideTip('tt101')" class=ISymbol>endUpdate</a>, <span class=IParent>mxGraphModel</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/util/mxLog-php.html#mxLog.enter" id=link102 onMouseOver="ShowTip(event, 'tt102', 'link102')" onMouseOut="HideTip('tt102')" class=ISymbol>enter</a>, <span class=IParent>mxLog</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><span class=ISymbol>equals</span><div class=ISubIndex><a href="../files/util/mxPoint-php.html#mxPoint.equals" id=link103 onMouseOver="ShowTip(event, 'tt103', 'link103')" onMouseOut="HideTip('tt103')" class=IParent>mxPoint</a><a href="../files/util/mxRectangle-php.html#mxRectangle.equals" id=link104 onMouseOver="ShowTip(event, 'tt104', 'link104')" onMouseOut="HideTip('tt104')" class=IParent>mxRectangle</a></div></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td>
2012-05-21 20:32:26 +00:00
<!--START_ND_TOOLTIPS-->
2015-06-23 07:48:06 +00:00
<div class=CToolTip id="tt94"><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 encode(</td><td class=PParameter nowrap>$obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Encodes the specified object and returns the resulting XML node.</div></div><div class=CToolTip id="tt95"><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 encode(</td><td class=PParameter nowrap>$enc,</td></tr><tr><td></td><td class=PParameter nowrap>$obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Encodes the specified object and returns a node representing then given object. </div></div><div class=CToolTip id="tt96"><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 encodeCell(</td><td class=PParameter nowrap>$cell,</td><td class=PDefaultValuePrefix>&nbsp;&nbsp;</td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$node,</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>Encoding of cell hierarchies is built-into the core, but is a higher-level function that needs to be explicitely used by the respective object encoders (eg. </div></div><div class=CToolTip id="tt97"><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 encodeImage(</td><td class=PParameter nowrap>$image,</td><td class=PDefaultValuePrefix>&nbsp;&nbsp;</td><td class=PDefaultValue width=100%></td></tr><tr><td></td><td class=PParameter nowrap>$format</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>Encodes the given image using the GD image encoding routines. </div></div><div class=CToolTip id="tt98"><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 encodeObject(</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>Encodes the value of each member in then given obj into the given node using encodeValue.</div></div><div class=CToolTip id="tt99"><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 encodeValue(</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>$name,</td></tr><tr><td></td><td class=PParameter nowrap>$value,</td></tr><tr><td></td><td class=PParameter nowrap>$node</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Converts the given value according to the mappings and id-refs in this codec and uses writeAttribute to write the attribute into the given node.</div></div><div class=CToolTip id="tt100"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><tabl
2012-05-21 20:32:26 +00:00
<!--START_ND_TOOLTIPS-->
2015-06-23 07:48:06 +00:00
<div class=CToolTip id="tt107"><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 findNode(</td><td class=PParameter nowrap>$node,</td></tr><tr><td></td><td class=PParameter nowrap>$attr,</td></tr><tr><td></td><td class=PParameter nowrap>$value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the first node where attr equals value. </div></div><div class=CToolTip id="tt108"><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 findTreeRoots(</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>$isolate</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%> false,</td></tr><tr><td></td><td class=PParameter nowrap>$invert</td><td class=PDefaultValuePrefix>&nbsp;=&nbsp;</td><td class=PDefaultValue width=100%> false</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns all children in the given parent which do not have incoming edges. </div></div><div class=CToolTip id="tt109"><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 fine(</td><td class=PParameter nowrap>$text</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Logs a fine trace.</div></div><div class=CToolTip id="tt110"><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 fireEvent(</td><td class=PParameter nowrap>$event</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Fires the event for the specified name.</div></div><div class=CToolTip id="tt111"><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 flipImage(</td><td class=PParameter nowrap>$img,</td></tr><tr><td></td><td class=PParameter nowrap>$flipH,</td></tr><tr><td></td><td class=PParameter nowrap>$flipV</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Flips the given image horizontally and/or vertically and returns a new image instance.</div></div><!--END_ND_TOOLTIPS-->
2012-05-21 20:32:26 +00:00
</div><!--Index-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
2015-12-11 09:22:19 +00:00
<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
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="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>