maxGraph/docs/js-api/index/General21.html

46 lines
54 KiB
HTML
Raw Normal View History

2020-10-28 16:11:03 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><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.51 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<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="General2.html#B">B</a> &middot; <a href="General3.html#C">C</a> &middot; <a href="General4.html#D">D</a> &middot; <a href="General5.html#E">E</a> &middot; <a href="General6.html#F">F</a> &middot; <a href="General7.html#G">G</a> &middot; <a href="General8.html#H">H</a> &middot; <a href="General9.html#I">I</a> &middot; <a href="General10.html#J">J</a> &middot; <a href="General10.html#K">K</a> &middot; <a href="General11.html#L">L</a> &middot; <a href="General12.html#M">M</a> &middot; <a href="General13.html#N">N</a> &middot; <a href="General13.html#O">O</a> &middot; <a href="General14.html#P">P</a> &middot; <a href="General15.html#Q">Q</a> &middot; <a href="General16.html#R">R</a> &middot; <a href="General17.html#S">S</a> &middot; <a href="General18.html#T">T</a> &middot; <a href="General19.html#U">U</a> &middot; <a href="General20.html#V">V</a> &middot; <a href="#W">W</a> &middot; <a href="#X">X</a> &middot; <a href="#Y">Y</a> &middot; <a href="#Z">Z</a></div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="W"></a>W</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/shape/mxStencil-js.html#mxStencil.w0" id=link3881 onMouseOver="ShowTip(event, 'tt3881', 'link3881')" onMouseOut="HideTip('tt3881')" class=ISymbol>w0</a>, <span class=IParent>mxStencil</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/util/mxLog-js.html#mxLog.warn" id=link3882 onMouseOver="ShowTip(event, 'tt3882', 'link3882')" onMouseOut="HideTip('tt3882')" class=ISymbol>warn</a>, <span class=IParent>mxLog</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/util/mxLog-js.html#mxLog.WARN" id=link3883 onMouseOver="ShowTip(event, 'tt3883', 'link3883')" onMouseOut="HideTip('tt3883')" class=ISymbol>WARN</a>, <span class=IParent>mxLog</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/view/mxGraph-js.html#mxGraph.warningImage" id=link3884 onMouseOver="ShowTip(event, 'tt3884', 'link3884')" onMouseOut="HideTip('tt3884')" class=ISymbol>warningImage</a>, <span class=IParent>mxGraph</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/handler/mxConnectionHandler-js.html#mxConnectionHandler.waypointsEnabled" id=link3885 onMouseOver="ShowTip(event, 'tt3885', 'link3885')" onMouseOut="HideTip('tt3885')" class=ISymbol>waypointsEnabled</a>, <span class=IParent>mxConnectionHandler</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><span class=ISymbol>WeightedCellSorter</span><div class=ISubIndex><a href="../files/layout/mxGraphLayout-js.html#WeightedCellSorter" id=link3886 onMouseOver="ShowTip(event, 'tt3886', 'link3886')" onMouseOut="HideTip('tt3886')" class=IParent>Global</a><a href="../files/layout/mxGraphLayout-js.html#WeightedCellSorter.WeightedCellSorter" id=link3887 onMouseOver="ShowTip(event, 'tt3887', 'link3887')" onMouseOut="HideTip('tt3887')" class=IParent>WeightedCellSorter</a></div></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/layout/hierarchical/stage/mxMedianHybridCrossingReduction-js.html#mxMedianHybridCrossingReduction.weightedMedian" id=link3888 onMouseOver="ShowTip(event, 'tt3888', 'link3888')" onMouseOut="HideTip('tt3888')" class=ISymbol>weightedMedian</a>, <span class=IParent>mxMedianHybridCrossingReduction</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/layout/mxGraphLayout-js.html#WeightedCellSorter.weightedValue" id=link3889 onMouseOver="ShowTip(event, 'tt3889', 'link3889')" onMouseOut="HideTip('tt3889')" class=ISymbol>weightedValue</a>, <span class=IParent>WeightedCellSorter</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/layout/hierarchical/stage/mxCoordinateAssignment-js.html#mxCoordinateAssignment.widestRank"
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt3881"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxStencil.prototype.w0</td></tr></table></blockquote>Holds the width of the shape. </div></div><div class=CToolTip id="tt3882"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">warn: function()</td></tr></table></blockquote>Adds all arguments to the console if WARN is enabled.</div></div><div class=CToolTip id="tt3883"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">WARN: true</td></tr></table></blockquote>Specifies if the output for warn should be visible in the console. </div></div><div class=CToolTip id="tt3884"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraph.prototype.warningImage</td></tr></table></blockquote>Specifies the mxImage for the image to be used to display a warning overlay. </div></div><div class=CToolTip id="tt3885"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConnectionHandler.prototype.waypointsEnabled</td></tr></table></blockquote>Specifies if single clicks should add waypoints on the new edge. </div></div><div class=CToolTip id="tt3886"><div class=CClass>A utility class used to track cells whilst sorting occurs on the weighted sum of their connected edges. </div></div><div class=CToolTip id="tt3887"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function WeightedCellSorter(</td><td class="PParameter prettyprint " nowrap>cell,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>weightedValue</td><td class="PAfterParameters prettyprint "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="tt3888"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxMedianHybridCrossingReduction.prototype.weightedMedian = function(</td><td class="PParameter prettyprint " nowrap>iteration,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>model</td><td class="PAfterParameters prettyprint "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="tt3889"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">WeightedCellSorter.prototype.weightedValue</td></tr></table></blockquote>The weighted value of the cell stored.</div></div><div class=CToolTip id="tt3890"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCoordinateAssignment.prototype.widestRank</td></tr></table></blockquote>The rank that has the widest x position</div></div><div class=CToolTip id="tt3891"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCoordinateAssignment.prototype.widestRankValue</td></tr></table></blockquote>The X-coordinate of the edge of the widest rank</div></div><div class=CToolTip id="tt3892"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphAbstractHierarchyCell.prototype.width</td></tr></table></blockquote>The width of this cell. </div></div><div class=CToolTip id="tt3893"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxImage.prototy
2020-10-28 16:11:03 +00:00
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt3911"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphAbstractHierarchyCell.prototype.x</td></tr></table></blockquote>The x position of this cell for each layer it occupies</div></div><div class=CToolTip id="tt3912"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPoint.prototype.x</td></tr></table></blockquote>Holds the x-coordinate of the point. </div></div><div class=CToolTip id="tt3913"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCircleLayout.prototype.x0</td></tr></table></blockquote>Integer specifying the left coordinate of the circle. </div></div><div class=CToolTip id="tt3914"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPrintPreview.prototype.x0</td></tr></table></blockquote>Holds the horizontal offset of the output.</div></div><div class=CToolTip id="tt3915"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxStackLayout.prototype.x0</td></tr></table></blockquote>Specifies the horizontal origin of the layout. </div></div><!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt3916"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraphAbstractHierarchyCell.prototype.y</td></tr></table></blockquote>The y position of this cell for each layer it occupies</div></div><div class=CToolTip id="tt3917"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPoint.prototype.y</td></tr></table></blockquote>Holds the y-coordinate of the point. </div></div><div class=CToolTip id="tt3918"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCircleLayout.prototype.y0</td></tr></table></blockquote>Integer specifying the top coordinate of the circle. </div></div><div class=CToolTip id="tt3919"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPrintPreview.prototype.y0</td></tr></table></blockquote>Holds the vertical offset of the output.</div></div><div class=CToolTip id="tt3920"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxStackLayout.prototype.y0</td></tr></table></blockquote>Specifies the vertical origin of the layout. </div></div><!--END_ND_TOOLTIPS-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt3921"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellEditor.prototype.zIndex</td></tr></table></blockquote>Specifies the zIndex for the textarea. </div></div><div class=CToolTip id="tt3922"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxPopupMenu.prototype.zIndex</td></tr></table></blockquote>Specifies the zIndex for the popupmenu and its shadow. </div></div><div class=CToolTip id="tt3923"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxTooltipHandler.prototype.zIndex</td></tr></table></blockquote>Specifies the zIndex for the tooltip and its shadow. </div></div><div class=CToolTip id="tt3924"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxGraph.prototype.zoom = function(</td><td class="PParameter prettyprint " nowrap>factor,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>center</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Zooms the graph using the given factor. </div></div><div class=CToolTip id="tt3925"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraph.prototype.zoomActual = function()</td></tr></table></blockquote>Resets the zoom and panning in the view.</div></div><div class=CToolTip id="tt3926"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraph.prototype.zoomFactor</td></tr></table></blockquote>Specifies the factor used for zoomIn and zoomOut. </div></div><div class=CToolTip id="tt3927"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxPanningHandler.prototype.zoomGraph = function(</td><td class="PParameter prettyprint " nowrap>evt</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Zooms the graph to the given value and consumed the event if needed.</div></div><div class=CToolTip id="tt3928"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraph.prototype.zoomIn = function()</td></tr></table></blockquote>Zooms into the graph by zoomFactor.</div></div><div class=CToolTip id="tt3929"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxGraph.prototype.zoomOut = function()</td></tr></table></blockquote>Zooms out of the graph by zoomFactor.</div></div><div class=CToolTip id="tt3930"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxGraph.prototype.zoomTo = function(</td><td class="PParameter prettyprint " nowrap>scale,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>center</td><td class="PAfterParameters prettyprint "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="tt3931"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxGraph.prototype.zoomToRect = function(</td><td class="PParameter prettyprint " nowrap>rect</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Zooms the graph to the specified rectangle. </div></di
</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=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/mxHandle-js.html">mxHandle</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">mxPopupMenuHandler</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=MEn
2021-03-21 01:24:29 +00:00
let searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
2020-10-28 16:11:03 +00:00
--></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>