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

38 lines
39 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>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>Index</div><div class=INavigationBar>$#! &middot; 0-9 &middot; <a href="General.html#A">A</a> &middot; <a href="General.html#B">B</a> &middot; <a href="General2.html#C">C</a> &middot; <a href="General3.html#D">D</a> &middot; <a href="General4.html#E">E</a> &middot; <a href="General4.html#F">F</a> &middot; <a href="General5.html#G">G</a> &middot; <a href="General6.html#H">H</a> &middot; <a href="General6.html#I">I</a> &middot; J &middot; K &middot; <a href="General6.html#L">L</a> &middot; <a href="General7.html#M">M</a> &middot; <a href="General7.html#N">N</a> &middot; <a href="General7.html#O">O</a> &middot; <a href="#P">P</a> &middot; Q &middot; <a href="#R">R</a> &middot; <a href="General9.html#S">S</a> &middot; <a href="General10.html#T">T</a> &middot; <a href="General10.html#U">U</a> &middot; <a href="General10.html#V">V</a> &middot; <a href="General10.html#W">W</a> &middot; <a href="General10.html#X">X</a> &middot; <a href="General10.html#Y">Y</a> &middot; Z</div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="P"></a>P</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraph-php.html#mxGraph.paintCell" id=link427 onMouseOver="ShowTip(event, 'tt427', 'link427')" onMouseOut="HideTip('tt427')" class=ISymbol>paintCell</a>, <span class=IParent>mxGraph</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraph-php.html#mxGraph.paintState" id=link428 onMouseOver="ShowTip(event, 'tt428', 'link428')" onMouseOut="HideTip('tt428')" class=ISymbol>paintState</a>, <span class=IParent>mxGraph</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/model/mxCell-php.html#mxCell.parent" id=link429 onMouseOver="ShowTip(event, 'tt429', 'link429')" onMouseOut="HideTip('tt429')" class=ISymbol>parent</a>, <span class=IParent>mxCell</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/reader/mxGraphViewImageReader-php.html#mxGraphViewImageReader.parsePoints" id=link430 onMouseOver="ShowTip(event, 'tt430', 'link430')" onMouseOut="HideTip('tt430')" class=ISymbol>parsePoints</a>, <span class=IParent>mxGraphViewImageReader</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/reader/mxGraphViewImageReader-php.html#mxGraphViewImageReader.parser" id=link431 onMouseOver="ShowTip(event, 'tt431', 'link431')" onMouseOut="HideTip('tt431')" class=ISymbol>parser</a>, <span class=IParent>mxGraphViewImageReader</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/reader/mxGraphViewImageReader-php.html#mxGraphViewImageReader.parseState" id=link432 onMouseOver="ShowTip(event, 'tt432', 'link432')" onMouseOut="HideTip('tt432')" class=ISymbol>parseState</a>, <span class=IParent>mxGraphViewImageReader</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/util/mxUtils-php.html#mxUtils.parseXml" id=link433 onMouseOver="ShowTip(event, 'tt433', 'link433')" onMouseOut="HideTip('tt433')" class=ISymbol>parseXml</a>, <span class=IParent>mxUtils</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxConnectionConstraint-php.html#mxConnectionConstraint.perimeter" id=link434 onMouseOver="ShowTip(event, 'tt434', 'link434')" onMouseOut="HideTip('tt434')" class=ISymbol>perimeter</a>, <span class=IParent>mxConnectionConstraint</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/util/mxConstants-php.html#mxConstants.PERIMETER_ELLIPSE" id=link435 onMouseOver="ShowTip(event, 'tt435', 'link435')" onMouseOut="HideTip('tt435')" class=ISymbol>PERIMETER_ELLIPSE</a>, <span class=IParent>mxConstants</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/util/mxConstants-php.html#mxConstants.PERIMETER_RECTANGLE" id=link436 onMouseOver="ShowTip(event, 'tt436', 'link436')" onMouseOut="HideTip('tt436')" cla
2012-05-21 20:32:26 +00:00
<!--START_ND_TOOLTIPS-->
2014-02-19 14:19:38 +00:00
<div class=CToolTip id="tt427"><div class=CFunction>Draws the given cell onto the specified canvas.</div></div><div class=CToolTip id="tt428"><div class=CFunction>Draws the given cell and label onto the specified canvas. </div></div><div class=CToolTip id="tt429"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $parent</td></tr></table></blockquote>Reference to the parent cell.</div></div><div class=CToolTip id="tt430"><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 parsePoints(</td><td class=PParameter nowrap>$str</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Parses a string that represents a list of points into an array of mxPoints.</div></div><div class=CToolTip id="tt431"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $parser</td></tr></table></blockquote>Holds the SAX parser.</div></div><div class=CToolTip id="tt432"><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 parseState(</td><td class=PParameter nowrap>$state,</td></tr><tr><td></td><td class=PParameter nowrap>$edge</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Parses the bounds, absolute points and label information from the style of the state into its respective fields and returns the label of the cell.</div></div><div class=CToolTip id="tt433"><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 parseXml(</td><td class=PParameter nowrap>$xml</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns a new DOM document for the given XML string.</div></div><div class=CToolTip id="tt434"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $perimeter</td></tr></table></blockquote>Boolean that specifies if the point should be projected onto the perimeter of the terminal.</div></div><div class=CToolTip id="tt435"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public static $PERIMETER_ELLIPSE</td></tr></table></blockquote>Name of the ellipse perimeter. </div></div><div class=CToolTip id="tt436"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public static $PERIMETER_RECTANGLE</td></tr></table></blockquote>Name of the rectangle perimeter. </div></div><div class=CToolTip id="tt437"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public static $PERIMETER_RHOMBUS</td></tr></table></blockquote>Name of the rhombus perimeter. </div></div><div class=CToolTip id="tt438"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public static $PERIMETER_TRIANGLE</td></tr></table></blockquote>Name of the triangle perimeter. </div></div><div class=CToolTip id="tt439"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $point</td></tr></table></blockquote>mxPoint that specifies the fixed location of the connection point.</div></div><div class=CToolTip id="tt440"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $points</td></tr></table></blockquote>Array of mxPoints which specifies the control points along the edge. </div></div><div class=CToolTip id="tt441"><div class=CFunction><blockquote><table
2012-05-21 20:32:26 +00:00
<!--START_ND_TOOLTIPS-->
2014-02-19 14:19:38 +00:00
<div class=CToolTip id="tt451"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public static $RAD_PER_DEG</td></tr></table></blockquote>Defines the number of radiants per degree.</div></div><div class=CToolTip id="tt452"><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 read(</td><td class=PParameter nowrap>$string</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Reads the specified view XML string.</div></div><div class=CToolTip id="tt453"><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 readFile(</td><td class=PParameter nowrap>$filename</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Reads the specified view XML file in blocks of 4096 bytes.</div></div><div class=CToolTip id="tt454"><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 readFile(</td><td class=PParameter nowrap>$filename</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Reads the given filename into a string. </div></div><div class=CToolTip id="tt455"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>public static $RectanglePerimeter</td></tr></table></blockquote>Provides a rectangular perimeter.</div></div><div class=CToolTip id="tt456"><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 reference(</td><td class=PParameter nowrap>$obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Hook for subclassers to implement a custom method for retrieving IDs from objects. </div></div><div class=CToolTip id="tt457"><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 register(</td><td class=PParameter nowrap>$codec</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Registers a new codec and associates the name of the template constructor in the codec with the codec object. </div></div><div class=CToolTip id="tt458"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>var $relative</td></tr></table></blockquote>Specifies if the coordinates in the geometry are to be interpreted as relative coordinates. </div></div><div class=CToolTip id="tt459"><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 remove(</td><td class=PParameter nowrap>$index</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Removes the child at the specified index from the child array and returns the child that was removed. </div></div><div class=CToolTip id="tt460"><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 remove(</td><td class=PParameter nowrap>$cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Removes the specified cell from the model using mxChildChange and adds the change to the current transaction. </div></div><div class=CToolTip id="tt461"
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>