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

42 lines
49 KiB
HTML
Raw Normal View History

2.0.0.1 release
2013-05-23 16:14:48 +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 -->
2.1.0.3 release
2013-07-19 09:51:30 +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="Functions2.html#B">B</a> &middot; <a href="Functions3.html#C">C</a> &middot; <a href="Functions4.html#D">D</a> &middot; <a href="Functions5.html#E">E</a> &middot; <a href="Functions6.html#F">F</a> &middot; <a href="Functions7.html#G">G</a> &middot; <a href="Functions8.html#H">H</a> &middot; <a href="Functions9.html#I">I</a> &middot; <a href="Functions10.html#J">J</a> &middot; <a href="Functions10.html#K">K</a> &middot; <a href="Functions10.html#L">L</a> &middot; <a href="Functions11.html#M">M</a> &middot; <a href="Functions12.html#N">N</a> &middot; <a href="Functions12.html#O">O</a> &middot; <a href="Functions13.html#P">P</a> &middot; <a href="Functions14.html#Q">Q</a> &middot; <a href="Functions15.html#R">R</a> &middot; <a href="Functions16.html#S">S</a> &middot; <a href="Functions17.html#T">T</a> &middot; <a href="Functions18.html#U">U</a> &middot; <a href="#V">V</a> &middot; <a href="#W">W</a> &middot; X &middot; Y &middot; <a href="#Z">Z</a></div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="V"></a>V</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraphView-js.html#mxGraphView.validate" id=link1961 onMouseOver="ShowTip(event, 'tt1956', 'link1961')" onMouseOut="HideTip('tt1956')" class=ISymbol>validate</a>, <span class=IParent>mxGraphView</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraphView-js.html#mxGraphView.validateBackground" id=link1962 onMouseOver="ShowTip(event, 'tt1957', 'link1962')" onMouseOut="HideTip('tt1957')" class=ISymbol>validateBackground</a>, <span class=IParent>mxGraphView</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraphView-js.html#mxGraphView.validateBounds" id=link1963 onMouseOver="ShowTip(event, 'tt1958', 'link1963')" onMouseOut="HideTip('tt1958')" class=ISymbol>validateBounds</a>, <span class=IParent>mxGraphView</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraph-js.html#mxGraph.validateCell" id=link1964 onMouseOver="ShowTip(event, 'tt1959', 'link1964')" onMouseOut="HideTip('tt1959')" class=ISymbol>validateCell</a>, <span class=IParent>mxGraph</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><span class=ISymbol>validateConnection</span><div class=ISubIndex><a href="../files/handler/mxConnectionHandler-js.html#mxConnectionHandler.validateConnection" id=link1965 onMouseOver="ShowTip(event, 'tt1960', 'link1965')" onMouseOut="HideTip('tt1960')" class=IParent>mxConnectionHandler</a><a href="../files/handler/mxEdgeHandler-js.html#mxEdgeHandler.validateConnection" id=link1966 onMouseOver="ShowTip(event, 'tt1961', 'link1966')" onMouseOut="HideTip('tt1961')" class=IParent>mxEdgeHandler</a></div></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraph-js.html#mxGraph.validateEdge" id=link1967 onMouseOver="ShowTip(event, 'tt1962', 'link1967')" onMouseOut="HideTip('tt1962')" class=ISymbol>validateEdge</a>, <span class=IParent>mxGraph</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraph-js.html#mxGraph.validateGraph" id=link1968 onMouseOver="ShowTip(event, 'tt1963', 'link1968')" onMouseOut="HideTip('tt1963')" class=ISymbol>validateGraph</a>, <span class=IParent>mxGraph</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraphView-js.html#mxGraphView.validatePoints" id=link1969 onMouseOver="ShowTip(event, 'tt1964', 'link1969')" onMouseOut="HideTip('tt1964')" class=ISymbol>validatePoints</a>, <span class=IParent>mxGraphView</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraph-js.html#mxGraph.validationAlert" id=link1970 onMouseOver="ShowTip(event, 'tt1965', 'link1970')" onMou
2.0.0.1 release
2013-05-23 16:14:48 +00:00
<!--START_ND_TOOLTIPS-->
2.1.0.3 release
2013-07-19 09:51:30 +00:00
<div class=CToolTip id="tt1956"><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>mxGraphView.prototype.validate = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>First validates all bounds and then validates all points recursively on all visible cells starting at the given cell. </div></div><div class=CToolTip id="tt1957"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraphView.prototype.validateBackground = function()</td></tr></table></blockquote>Validates the background image.</div></div><div class=CToolTip id="tt1958"><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>mxGraphView.prototype.validateBounds = function(</td><td class=PParameter nowrap>parentState,</td></tr><tr><td></td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Validates the bounds of the given parent&rsquo;s child using the given parent state as the origin for the child. </div></div><div class=CToolTip id="tt1959"><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>mxGraph.prototype.validateCell = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>context</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Hook method for subclassers to return an error message for the given cell and validation context. </div></div><div class=CToolTip id="tt1960"><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>mxConnectionHandler.prototype.validateConnection = function(</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>Returns the error message or an empty string if the connection for the given source target pair is not valid. </div></div><div class=CToolTip id="tt1961"><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>mxEdgeHandler.prototype.validateConnection = function(</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>Returns the error message or an empty string if the connection for the given source, target pair is not valid. </div></div><div class=CToolTip id="tt1962"><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>mxGraph.prototype.validateEdge = function(</td><td class=PParameter nowrap>edge,</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>Hook method for subclassers to return an error message for the given edge and terminals. </div></div><div class=CToolTip id="tt1963"><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>mxGraph.prototype.validateGraph = function(</td><td class=PParameter nowrap>cell,</td></tr><tr><td
2.0.0.1 release
2013-05-23 16:14:48 +00:00
<!--START_ND_TOOLTIPS-->
2.1.0.3 release
2013-07-19 09:51:30 +00:00
<div class=CToolTip id="tt1972"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>warn: function()</td></tr></table></blockquote>Adds all arguments to the console if WARN is enabled.</div></div><div class=CToolTip id="tt1973"><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 WeightedCellSorter(</td><td class=PParameter nowrap>cell,</td></tr><tr><td></td><td class=PParameter nowrap>weightedValue</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new weighted cell sorted for the given cell and weight.</div></div><div class=CToolTip id="tt1974"><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>mxMedianHybridCrossingReduction.prototype.weightedMedian = function(</td><td class=PParameter nowrap>iteration,</td></tr><tr><td></td><td class=PParameter nowrap>model</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Sweeps up or down the layout attempting to minimise the median placement of connected cells on adjacent ranks</div></div><div class=CToolTip id="tt1975"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>write: function()</td></tr></table></blockquote>Adds the specified strings to the console.</div></div><div class=CToolTip id="tt1976"><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>write: function(</td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>text</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Creates a text node for the given string and appends it to the given parent. </div></div><div class=CToolTip id="tt1977"><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>mxObjectCodec.prototype.writeAttribute = function(</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="tt1978"><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>mxObjectCodec.prototype.writeComplexAttribute = function(</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="tt1979"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxXmlCanvas2D.prototype.writeDefaults = function()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt1980"><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
2.0.0.1 release
2013-05-23 16:14:48 +00:00
<!--START_ND_TOOLTIPS-->
2.1.0.3 release
2013-07-19 09:51:30 +00:00
<div class=CToolTip id="tt1985"><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>mxGraph.prototype.zoom = function(</td><td class=PParameter nowrap>factor,</td></tr><tr><td></td><td class=PParameter nowrap>center</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Zooms the graph using the given factor. </div></div><div class=CToolTip id="tt1986"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.zoomActual = function()</td></tr></table></blockquote>Resets the zoom and panning in the view.</div></div><div class=CToolTip id="tt1987"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.zoomIn = function()</td></tr></table></blockquote>Zooms into the graph by zoomFactor.</div></div><div class=CToolTip id="tt1988"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxGraph.prototype.zoomOut = function()</td></tr></table></blockquote>Zooms out of the graph by zoomFactor.</div></div><div class=CToolTip id="tt1989"><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>mxGraph.prototype.zoomTo = function(</td><td class=PParameter nowrap>scale,</td></tr><tr><td></td><td class=PParameter nowrap>center</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Zooms the graph to the given scale with an optional boolean center argument, which is passd to zoom.</div></div><div class=CToolTip id="tt1990"><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>mxGraph.prototype.zoomToRect = function(</td><td class=PParameter nowrap>rect</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Zooms the graph to the specified rectangle. </div></div><!--END_ND_TOOLTIPS-->
2.0.0.1 release
2013-05-23 16:14:48 +00:00
</div><!--Index-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
2.1.0.0 release
2013-06-28 19:07:06 +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=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Editor</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../files/editor/mxDefaultKeyHandler-js.html">mxDefaultKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../files/editor/mxDefaultPopupMenu-js.html">mxDefaultPopupMenu</a></div></div><div class=MEntry><div class=MFile><a href="../files/editor/mxDefaultToolbar-js.html">mxDefaultToolbar</a></div></div><div class=MEntry><div class=MFile><a href="../files/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="../files/handler/mxCellHighlight-js.html">mxCellHighlight</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxCellMarker-js.html">mxCellMarker</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxCellTracker-js.html">mxCellTracker</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxConnectionHandler-js.html">mxConnectionHandler</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxConstraintHandler-js.html">mxConstraintHandler</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxEdgeHandler-js.html">mxEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxEdgeSegmentHandler-js.html">mxEdgeSegmentHandler.js</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxElbowEdgeHandler-js.html">mxElbowEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxGraphHandler-js.html">mxGraphHandler</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxKeyHandler-js.html">mxKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxPanningHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxPopupMenuHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxRubberband-js.html">mxRubberband</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxSelectionCellsHandler-js.html">mxSelectionCellsHandler</a></div></div><div class=MEntry><div class=MFile><a href="../files/handler/mxTooltipHandler-js.html">mxTooltipHandler</a></div></div><div class=MEntry><div class=MFile><a href="../files/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="../files/io/mxCellCodec-js.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxChildChangeCodec-js.html">mxChildChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxCodec-js.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxCodecRegistry-js.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxDefaultKeyHandlerCodec-js.html">mxDefaultKeyHandlerCodec</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxDefaultPopupMenuCodec-js.html">mxDefaultPopupMenuCodec</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxDefaultToolbarCodec-js.html">mxDefaultToolbarCodec</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxEditorCodec-js.html">mxEditorCodec</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxGenericChangeCodec-js.html">mxGenericChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../files/io/mxGraphCodec-js.html">mxGraphCodec</a></div></div><div class=ME
2.0.0.1 release
2013-05-23 16:14:48 +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="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([12], 13);// --></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>