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

46 lines
31 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 -->
2014-02-19 14:19:38 +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="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="#T">T</a> &middot; <a href="#U">U</a> &middot; <a href="#V">V</a> &middot; <a href="#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="T"></a>T</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/util/mxUtils-php.html#mxUtils.toRadians" id=link341 onMouseOver="ShowTip(event, 'tt341', 'link341')" onMouseOut="HideTip('tt341')" class=ISymbol>toRadians</a>, <span class=IParent>mxUtils</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraphView-php.html#mxGraphView.transformControlPoint" id=link342 onMouseOver="ShowTip(event, 'tt342', 'link342')" onMouseOut="HideTip('tt342')" class=ISymbol>transformControlPoint</a>, <span class=IParent>mxGraphView</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/model/mxGeometry-php.html#mxGeometry.translate" id=link343 onMouseOver="ShowTip(event, 'tt343', 'link343')" onMouseOut="HideTip('tt343')" class=ISymbol>translate</a>, <span class=IParent>mxGeometry</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/util/mxUtils-php.html#mxUtils.translatePoints" id=link344 onMouseOver="ShowTip(event, 'tt344', 'link344')" onMouseOut="HideTip('tt344')" class=ISymbol>translatePoints</a>, <span class=IParent>mxUtils</span></td></tr><tr><td class=IHeading><a name="U"></a>U</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraphView-php.html#mxGraphView.updateBoundingBox" id=link345 onMouseOver="ShowTip(event, 'tt345', 'link345')" onMouseOut="HideTip('tt345')" class=ISymbol>updateBoundingBox</a>, <span class=IParent>mxGraphView</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraphView-php.html#mxGraphView.updateCellState" id=link346 onMouseOver="ShowTip(event, 'tt346', 'link346')" onMouseOut="HideTip('tt346')" class=ISymbol>updateCellState</a>, <span class=IParent>mxGraphView</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraphView-php.html#mxGraphView.updateEdgeBounds" id=link347 onMouseOver="ShowTip(event, 'tt347', 'link347')" onMouseOut="HideTip('tt347')" class=ISymbol>updateEdgeBounds</a>, <span class=IParent>mxGraphView</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/model/mxGraphModel-php.html#mxGraphModel.updateEdgeParent" id=link348 onMouseOver="ShowTip(event, 'tt348', 'link348')" onMouseOut="HideTip('tt348')" class=ISymbol>updateEdgeParent</a>, <span class=IParent>mxGraphModel</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/model/mxGraphModel-php.html#mxGraphModel.updateEdgeParents" id=link349 onMouseOver="ShowTip(event, 'tt349', 'link349')" onMouseOut="HideTip('tt349')" class=ISymbol>updateEdgeParents</a>, <span class=IParent>mxGraphModel</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraphView-php.html#mxGraphView.updateEdgeState" id=link350 onMouseOver="ShowTip(event, 'tt350', 'link350')" onMouseOut="HideTip('tt350')" class=ISymbol>updateEdgeState
2012-05-21 20:32:26 +00:00
<!--START_ND_TOOLTIPS-->
2014-02-19 14:19:38 +00:00
<div class=CToolTip id="tt341"><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 toRadians(</td><td class=PParameter nowrap>$deg</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Converts the given degree to radians.</div></div><div class=CToolTip id="tt342"><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 transformControlPoint(</td><td class=PParameter nowrap>$state,</td></tr><tr><td></td><td class=PParameter nowrap>$pt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Transforms the given control point to an absolute point.</div></div><div class=CToolTip id="tt343"><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 translate(</td><td class=PParameter nowrap>$dx,</td></tr><tr><td></td><td class=PParameter nowrap>$dy</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Translates the geometry by the specified amount. </div></div><div class=CToolTip id="tt344"><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 translatePoints(</td><td class=PParameter nowrap>$pts,</td></tr><tr><td></td><td class=PParameter nowrap>$dx,</td></tr><tr><td></td><td class=PParameter nowrap>$dy</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Creates a new list of new points obtained by translating the points in the given list by the given vector. </div></div><!--END_ND_TOOLTIPS-->
2012-05-21 20:32:26 +00:00
<!--START_ND_TOOLTIPS-->
2014-02-19 14:19:38 +00:00
<div class=CToolTip id="tt345"><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 updateBoundingBox(</td><td class=PParameter nowrap>$state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Updates the bounding box in the given cell state.</div></div><div class=CToolTip id="tt346"><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 updateCellState(</td><td class=PParameter nowrap>$state,</td></tr><tr><td></td><td class=PParameter nowrap>$source,</td></tr><tr><td></td><td class=PParameter nowrap>$target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Updates the given mxCellState.</div></div><div class=CToolTip id="tt347"><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 updateEdgeBounds(</td><td class=PParameter nowrap>$state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Updates the bounds of the specified state based on the absolute points in the state.</div></div><div class=CToolTip id="tt348"><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 updateEdgeParent(</td><td class=PParameter nowrap>$edge,</td></tr><tr><td></td><td class=PParameter nowrap>$root</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Inner callback to update the parent of the specified mxCell to the nearest-common-ancestor of its two terminals.</div></div><div class=CToolTip id="tt349"><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 updateEdgeParents(</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>$root</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>Updates the parent for all edges that are connected to cell or one of its descendants using updateEdgeParent.</div></div><div class=CToolTip id="tt350"><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 updateEdgeState(</td><td class=PParameter nowrap>$state,</td></tr><tr><td></td><td class=PParameter nowrap>$geo,</td></tr><tr><td></td><td class=PParameter nowrap>$source,</td></tr><tr><td></td><td class=PParameter nowrap>$target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Validates the given cell state.</div></div><div class=CToolTip id="tt351"><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 updateFixedTerminalPoint(</td><td class=PParameter nowrap>$edge,</td></tr><tr><td></td><td class=PParameter nowrap>$terminal,</td></tr><tr><td></td><td class=PParameter nowrap>$source,</td></tr><tr><td></td><td class=PParameter nowrap>$constraint</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the fixed source or target terminal point on the given edge.</div></div><div class=CToolTip id="tt352"><div class=CFunction><blockquote><table borde
2012-05-21 20:32:26 +00:00
<!--START_ND_TOOLTIPS-->
2014-02-19 14:19:38 +00:00
<div class=CToolTip id="tt359"><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 validate(</td><td class=PParameter nowrap>$cell</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>Calls validateCell and validateCellState and updates the graphBounds using getBoundingBox. </div></div><div class=CToolTip id="tt360"><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 validateCell(</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>$visible</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>Recursively creates the cell state for the given cell if visible is true and the given cell is visible. </div></div><div class=CToolTip id="tt361"><div class=CFunction>Validates and repaints the mxCellState for the given mxCell.</div></div><!--END_ND_TOOLTIPS-->
2012-05-21 20:32:26 +00:00
<!--START_ND_TOOLTIPS-->
2014-02-19 14:19:38 +00:00
<div class=CToolTip id="tt362"><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 warn(</td><td class=PParameter nowrap>$text</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Logs a warn trace.</div></div><div class=CToolTip id="tt363"><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 write(</td><td class=PParameter nowrap>$text</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Writes a line to the log.</div></div><div class=CToolTip id="tt364"><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 writeAttribute(</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>$attr,</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>Writes the given value into node using writePrimitiveAttribute or writeComplexAttribute depending on the type of the value.</div></div><div class=CToolTip id="tt365"><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 writeComplexAttribute(</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>$attr,</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>Writes the given value as a child node of the given node.</div></div><div class=CToolTip id="tt366"><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 writeln(</td><td class=PParameter nowrap>$text</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Writes a line with a linefeed to the log.</div></div><div class=CToolTip id="tt367"><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 writePrimitiveAttribute(</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>$attr,</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>Writes the given value as an attribute of the given node.</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-->
<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>