maxGraph/docs/js-api/files/layout/hierarchical/model/mxGraphHierarchyNode-js.html

71 lines
36 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>mxGraphHierarchyNode</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 -->
2012-06-14 12:43:20 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxGraphHierarchyNode"></a>mxGraphHierarchyNode</h1><div class=CBody><p>An abstraction of a hierarchical edge for the hierarchy layout</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="#mxGraphHierarchyNode" >mxGraphHierarchyNode</a></td><td class=SDescription>An abstraction of a hierarchical edge for the hierarchy layout</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraphHierarchyNode.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxGraphHierarchyNode.mxGraphHierarchyNode" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxGraphHierarchyNode</a></td><td class=SDescription>Constructs an internal node to represent the specified real graph cell</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraphHierarchyNode.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraphHierarchyNode.cell" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">cell</a></td><td class=SDescription>The graph cell this object represents.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxGraphHierarchyNode.connectsAsTarget" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">connectsAsTarget</a></td><td class=SDescription>Collection of hierarchy edges that have this node as a target</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxGraphHierarchyNode.connectsAsSource" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">connectsAsSource</a></td><td class=SDescription>Collection of hierarchy edges that have this node as a source</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxGraphHierarchyNode.hashCode" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">hashCode</a></td><td class=SDescription>Assigns a unique hashcode for each node. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxGraphHierarchyNode.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxGraphHierarchyNode.getRankValue" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">getRankValue</a></td><td class=SDescription>Returns the integer value of the layer that this node resides in</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxGraphHierarchyNode.getNextLayerConnectedCells" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">getNextLayerConnectedCells</a></td><td class=SDescription>Returns the cells this cell connects to on the next layer up</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxGraphHierarchyNode.getPreviousLayerConnectedCells" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">getPreviousLayerConnectedCells</a></td><td class=SDescription>Returns the cells this cell connects to on the next layer down</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxGraphHierarchyNode.isVertex" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">isVertex</a></td><td class=SDescription>Returns true.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxGraphHierarchyNode.getGeneralPurposeVariable" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">getGeneralPurposeVariable</a></td><td class=SDescription>Gets the value of temp for the specified layer</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxGraphHierarchyNode.setGeneralPurposeVariable" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.mxGraphHierarchyNode"></a>mxGraphHierarchyNode</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 mxGraphHierarchyNode(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs an internal node to represent the specified real graph cell</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cell</td><td class=CDLDescription>the real graph cell this node represents</td></tr></table></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.Variables"></a>Variables</h3></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.cell"></a>cell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphHierarchyNode.prototype.cell</td></tr></table></blockquote><p>The graph cell this object represents.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.connectsAsTarget"></a>connectsAsTarget</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphHierarchyNode.prototype.connectsAsTarget</td></tr></table></blockquote><p>Collection of hierarchy edges that have this node as a target</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.connectsAsSource"></a>connectsAsSource</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphHierarchyNode.prototype.connectsAsSource</td></tr></table></blockquote><p>Collection of hierarchy edges that have this node as a source</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.hashCode"></a>hashCode</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphHierarchyNode.prototype.hashCode</td></tr></table></blockquote><p>Assigns a unique hashcode for each node.&nbsp; Used by the model dfs instead of copying HashSets</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.getRankValue"></a>getRankValue</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>mxGraphHierarchyNode.prototype.getRankValue = function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the integer value of the layer that this node resides in</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.getNextLayerConnectedCells"></a>getNextLayerConnectedCells</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>mxGraphHierarchyNode.prototype.getNextLayerConnectedCells = function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cells this cell connects to on the next layer up</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.getPreviousLayerConnectedCells"></a>getPreviousLayerConnectedCells</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>mxGraphHierarchyNode.prototype.getPreviousLayerConnectedCells = function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cells this cell connects to on the next layer down</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.isVertex"></a>isVertex</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphHierarchyNode.prototype.isVertex = function()</td></tr></table></blockquote><p>Returns true.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.getGeneralPurposeVariable"></a>getGeneralPurposeVariable</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>mxGraphHierarchyNode.prototype.getGeneralPurposeVariable = function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Gets the value of temp for the specified layer</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.setGeneralPurposeVariable"></a>setGeneralPurposeVariable</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>mxGraphHierarchyNode.prototype.setGeneralPurposeVariable = function(</td><td class=PParameter nowrap>layer,</td></tr><tr><td></td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Set the value of temp for the specified layer</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.isAncestor"></a>isAncestor</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>mxGraphHierarchyNode.prototype.isAncestor = function(</td><td class=PParameter nowrap>otherNode</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div></div>
2012-06-14 12:43:20 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxGraphHierarchyNode.getCoreCell"></a>getCoreCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphHierarchyNode.prototype.getCoreCell = function()</td></tr></table></blockquote><p>Gets the core vertex associated with this wrapper</p></div></div></div>
2012-05-21 20:32:26 +00:00
</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=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Editor</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../../../editor/mxDefaultKeyHandler-js.html">mxDefaultKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../../editor/mxDefaultPopupMenu-js.html">mxDefaultPopupMenu</a></div></div><div class=MEntry><div class=MFile><a href="../../../editor/mxDefaultToolbar-js.html">mxDefaultToolbar</a></div></div><div class=MEntry><div class=MFile><a href="../../../editor/mxEditor-js.html">mxEditor</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Handler</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../../../handler/mxCellHighlight-js.html">mxCellHighlight</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxCellMarker-js.html">mxCellMarker</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxCellTracker-js.html">mxCellTracker</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxConnectionHandler-js.html">mxConnectionHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxConstraintHandler-js.html">mxConstraintHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxEdgeHandler-js.html">mxEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxEdgeSegmentHandler-js.html">mxEdgeSegmentHandler.js</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxElbowEdgeHandler-js.html">mxElbowEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxGraphHandler-js.html">mxGraphHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxKeyHandler-js.html">mxKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxPanningHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxRubberband-js.html">mxRubberband</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxSelectionCellsHandler-js.html">mxSelectionCellsHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxTooltipHandler-js.html">mxTooltipHandler</a></div></div><div class=MEntry><div class=MFile><a href="../../../handler/mxVertexHandler-js.html">mxVertexHandler</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Io</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../../../io/mxCellCodec-js.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../../io/mxChildChangeCodec-js.html">mxChildChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../../io/mxCodec-js.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../../io/mxCodecRegistry-js.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../../../io/mxDefaultKeyHandlerCodec-js.html">mxDefaultKeyHandlerCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../../io/mxDefaultPopupMenuCodec-js.html">mxDefaultPopupMenuCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../../io/mxDefaultToolbarCodec-js.html">mxDefaultToolbarCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../../io/mxEditorCodec-js.html">mxEditorCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../../io/mxGenericChangeCodec-js.html">mxGenericChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../../io/mxGraphCodec-js.html">mxGraphCodec</a></div></div><div class=MEntry><div class=MFile><a href="../../../io/mxGraphViewCodec-js.html">mxGraphViewCodec</a></div></div><div class=MEntry><d
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="Cookies">Cookies</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([4, 6, 7], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
2012-06-14 12:43:20 +00:00
<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 mxGraphHierarchyNode(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs an internal node to represent the specified real graph cell</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphHierarchyNode.prototype.cell</td></tr></table></blockquote>The graph cell this object represents.</div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphHierarchyNode.prototype.connectsAsTarget</td></tr></table></blockquote>Collection of hierarchy edges that have this node as a target</div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphHierarchyNode.prototype.connectsAsSource</td></tr></table></blockquote>Collection of hierarchy edges that have this node as a source</div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphHierarchyNode.prototype.hashCode</td></tr></table></blockquote>Assigns a unique hashcode for each node. </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>mxGraphHierarchyNode.prototype.getRankValue = function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the integer value of the layer that this node resides in</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>mxGraphHierarchyNode.prototype.getNextLayerConnectedCells = function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the cells this cell connects to on the next layer up</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>mxGraphHierarchyNode.prototype.getPreviousLayerConnectedCells = function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the cells this cell connects to on the next layer down</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphHierarchyNode.prototype.isVertex = function()</td></tr></table></blockquote>Returns true.</div></div><div class=CToolTip id="tt10"><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>mxGraphHierarchyNode.prototype.getGeneralPurposeVariable = function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Gets the value of temp for the specified layer</div></div><div class=CToolTip id="tt11"><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>mxGraphHierarchyNode.prototype.setGeneralPurposeVariable = function(</t
2012-05-21 20:32:26 +00:00
<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>